Some label fixes

This commit is contained in:
2026-06-25 19:56:14 -05:00
parent d85737cc08
commit 722fe2ccfb
30 changed files with 290 additions and 105 deletions
+4 -4
View File
@@ -8,11 +8,11 @@
/**
* Descriptor for one entry in an `AssetBatch`.
*
* `format` texture format constant (`Texture.FORMAT_*`). Alias for `input`
* `format` - texture format constant (`Texture.FORMAT_*`). Alias for `input`
* when the type is `Asset.TYPE_TEXTURE`.
* `axis` mesh axis constant (`Asset.MESH_AXIS_*`). Alias for `input`
* `axis` - mesh axis constant (`Asset.MESH_AXIS_*`). Alias for `input`
* when the type is `Asset.TYPE_MESH`.
* `input` generic numeric input for all other loader types.
* `input` - generic numeric input for all other loader types.
*/
interface AssetBatchDescriptor {
path: string;
@@ -48,7 +48,7 @@ interface AssetBatch {
lock(): this;
/**
* Releases all locks and clears the batch.
* After this call the object is invalid do not use it again.
* After this call the object is invalid - do not use it again.
*/
unlock(): void;
/**
+7 -7
View File
@@ -13,24 +13,24 @@
interface AssetEntry {
/** Archive-relative path used as the cache key. */
readonly name: string;
/** Current loading state compare against `AssetEntry.*` state constants. */
/** Current loading state - compare against `AssetEntry.*` state constants. */
readonly state: number;
/** Loader type one of the `AssetEntry.TYPE_*` constants. */
/** Loader type - one of the `AssetEntry.TYPE_*` constants. */
readonly type: number;
/** `true` when the entry has fully loaded (`state === AssetEntry.LOADED`). */
readonly isLoaded: boolean;
/**
* Returns a `Texture` for this entry when it is a loaded texture asset.
* The `Texture` holds its own asset lock independent of this `AssetEntry`.
* The `Texture` holds its own asset lock - independent of this `AssetEntry`.
* Returns `undefined` if the entry is not of type `Asset.TYPE_TEXTURE` or
* is not yet loaded.
*/
readonly texture: Texture | undefined;
/** Event proxy subscribe up to 4 callbacks for when loading completes. */
/** Event proxy - subscribe up to 4 callbacks for when loading completes. */
readonly onLoaded: AssetEventProxy;
/** Event proxy subscribe up to 4 callbacks for when the entry is disposed. */
/** Event proxy - subscribe up to 4 callbacks for when the entry is disposed. */
readonly onUnloaded: AssetEventProxy;
/** Event proxy subscribe up to 4 callbacks for when loading fails. */
/** Event proxy - subscribe up to 4 callbacks for when loading fails. */
readonly onError: AssetEventProxy;
/**
* Returns a Promise that resolves when the entry is loaded, or rejects on
@@ -45,7 +45,7 @@ interface AssetEntry {
requireLoaded(): this;
/**
* Releases the lock immediately.
* After this call the object is invalid do not use it again.
* After this call the object is invalid - do not use it again.
*/
unlock(): void;
toString(): string;
+1 -1
View File
@@ -6,7 +6,7 @@
*/
/**
* A loaded texture asset. Holds a lock on the underlying asset entry
* A loaded texture asset. Holds a lock on the underlying asset entry -
* the lock is released automatically when the object is garbage collected.
*/
interface Texture {
+2 -2
View File
@@ -8,11 +8,11 @@
/** Overworld character component (player or NPC). */
interface Overworld extends Component {
/**
* Entity type `Overworld.PLAYER` or `Overworld.NPC`.
* Entity type - `Overworld.PLAYER` or `Overworld.NPC`.
*/
type: number;
/**
* Facing direction one of the `Overworld.FACING_*` constants.
* Facing direction - one of the `Overworld.FACING_*` constants.
*/
facing: number;
/** Component ID of the linked Renderable, or INVALID if none. */
+1 -1
View File
@@ -21,7 +21,7 @@ interface OverworldCamera extends Component {
/** Orthographic scale factor (larger = wider view). */
scale: number;
/**
* Convenience setter equivalent to assigning `targetEntity` and
* Convenience setter - equivalent to assigning `targetEntity` and
* `targetPositionComponent` individually.
*/
setTarget(targetEntityId: number, targetPositionComponentId: number): void;
+2 -2
View File
@@ -7,10 +7,10 @@
/** Physics body component. */
interface Physics extends Component {
/** Body simulation type `Physics.STATIC`, `DYNAMIC`, or `KINEMATIC`. */
/** Body simulation type - `Physics.STATIC`, `DYNAMIC`, or `KINEMATIC`. */
bodyType: number;
/**
* Collision shape type one of the `Physics.SHAPE_*` constants.
* Collision shape type - one of the `Physics.SHAPE_*` constants.
* Changing the type preserves existing velocity and ground state.
*/
shape: number;
+1 -1
View File
@@ -5,7 +5,7 @@
* https://opensource.org/licenses/MIT
*/
/** Transform component local/world PRS with an optional parent hierarchy. */
/** Transform component - local/world PRS with an optional parent hierarchy. */
interface Position extends Component {
/**
* Local-space position. Reading returns a Vec3 copy; assigning a Vec3
+2 -2
View File
@@ -7,7 +7,7 @@
/** A Renderable component. Returned by `entity.add(Component.RENDERABLE)`. */
interface Renderable extends Component {
/** Current render type one of the `Renderable.*` type constants. */
/** Current render type - one of the `Renderable.*` type constants. */
type: number;
/** Render priority. 0 = auto. Higher = drawn later. */
priority: number;
@@ -28,7 +28,7 @@ interface Renderable extends Component {
texture: Texture | undefined;
/**
* Sprite list. Reading returns a JS array of 10-element sub-arrays
* `[x1,y1,z1, x2,y2,z2, u1,v1, u2,v2]` one per sprite.
* `[x1,y1,z1, x2,y2,z2, u1,v1, u2,v2]` - one per sprite.
*
* Assigning an array replaces all sprites. Each element may be:
* - 10 numbers (3D): `[x1,y1,z1, x2,y2,z2, u1,v1, u2,v2]`
+1 -1
View File
@@ -5,7 +5,7 @@
* https://opensource.org/licenses/MIT
*
* Root type declarations for the Dusk engine built-in JavaScript modules.
* These globals are injected by the native JerryScript runtime they are not
* These globals are injected by the native JerryScript runtime - they are not
* ES modules and cannot be imported.
*
* Reference this file from a jsconfig.json or tsconfig.json to get
+1 -1
View File
@@ -37,7 +37,7 @@ interface InputNamespace {
/** Polling-based input system. */
declare var Input: InputNamespace;
// Input action constants injected as globals by the engine at startup.
// Input action constants - injected as globals by the engine at startup.
declare var INPUT_ACTION_UP: InputAction;
declare var INPUT_ACTION_DOWN: InputAction;
declare var INPUT_ACTION_LEFT: InputAction;
+1 -1
View File
@@ -58,6 +58,6 @@ interface BackpackNamespace {
declare var Backpack: BackpackNamespace;
// Inventory sort constants injected as globals by the engine at startup.
// Inventory sort constants - injected as globals by the engine at startup.
declare var INVENTORY_SORT_BY_ID: number;
declare var INVENTORY_SORT_BY_TYPE: number;
+2 -2
View File
@@ -29,11 +29,11 @@ interface ItemNamespace {
declare var Item: ItemNamespace;
// Item ID constants injected as globals by the engine at startup.
// Item ID constants - injected as globals by the engine at startup.
declare var ITEM_ID_POTION: ItemId;
declare var ITEM_ID_POTATO: ItemId;
declare var ITEM_ID_APPLE: ItemId;
// Item type constants injected as globals by the engine at startup.
// Item type constants - injected as globals by the engine at startup.
declare var ITEM_TYPE_MEDICINE: ItemType;
declare var ITEM_TYPE_FOOD: ItemType;
+1 -1
View File
@@ -43,7 +43,7 @@ interface SceneNamespace {
*/
set(newScene: SceneObject | null): void;
/** Called each frame by the engine drives `current.update()`. */
/** Called each frame by the engine - drives `current.update()`. */
update(): void;
/** Called each frame by the engine for dynamic/physics updates. */
+1 -1
View File
@@ -26,5 +26,5 @@ interface StoryNamespace {
declare var Story: StoryNamespace;
// Story flag constants injected as globals by the engine at startup.
// Story flag constants - injected as globals by the engine at startup.
declare var STORY_FLAG_TEST: StoryFlag;