Class LeaEntityII<ExtraEventMap>`Abstract`

Abstract base class for all entities in a LEA scene.

Provides event emission (update, draw, error), position, name, and z-order.

Type Parameters

ExtraEventMap extends EventMap = {}

Hierarchy (View Summary)

LeaEventEmitter<
    MergeObject<
        ExtraEventMap,
        { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
    >,
>
- LeaEntityII
  - RectLeaEntity

Implements

Updatable

Constructors

constructor

new LeaEntityII<ExtraEventMap extends EventMap = {}>(
    name: string,
    x?: number,
    y?: number,
): LeaEntityII<ExtraEventMap>
Type Parameters
- ExtraEventMap extends EventMap = {}
Parameters
- name: string
- Optionalx: number = 0
- Optionaly: number = 0
Returns LeaEntityII<ExtraEventMap>
Overrides LeaEventEmitter.constructor
- Defined in src/lea.ts:973

Properties

listenerMap

name

name: string = ""

Unique name of the entity (used for lookup and serialization).

scaleRotate

scaleRotate: number = 0

scale

scale: number = 1

hookMap

hookMap: Map

totalDeltas

totalDeltas: number = 0

`Private`___hookProxy

___hookProxy: HookProxy = null

`Optional`arraySerializeMap

arraySerializeMap?: LeaEntitySerializer<any>

autoTranslate

autoTranslate: boolean

z

z: number

Z-order for draw sorting (higher = drawn later / on top).

`Private`___pos

___pos: Vector2

nonSerializableProperties

nonSerializableProperties: (string | number | symbol)[]

forceSerializableProperties

forceSerializableProperties: (string | number | symbol)[]

`Optional`customUpdateOwner

customUpdateOwner?: LeaEntityII<any>

Accessors

hooks

get hooks(): HookProxy
Returns HookProxy
- Defined in src/lea.ts:995

pos

get pos(): Vector2
Current position (center point).

Returns Vector2
- Defined in src/lea.ts:1024

x

get x(): number
X coordinate (center).

Returns number
- Defined in src/lea.ts:1031
set x(s: number): void
Parameters
- s: number
Returns void
- Defined in src/lea.ts:1040

y

get y(): number
Y coordinate (center).

Returns number
- Defined in src/lea.ts:1037
set y(s: number): void
Parameters
- s: number
Returns void
- Defined in src/lea.ts:1043

updateOwner

get updateOwner(): LeaEntityII<any>
Returns LeaEntityII<any>
- Defined in src/lea.ts:1132

Methods

wait

wait<K extends string | number | symbol>(
    event: K,
    timeout?: number,
): Promise<
    MergeObject<
        ExtraEventMap,
        { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
    >[K],
>
Await the next emission of a specific event. Resolves with the arguments passed to that event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- timeout: number = ...
Returns Promise<
    MergeObject<
        ExtraEventMap,
        { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
    >[K],
>
Inherited from LeaEventEmitter.wait
- Defined in src/lea.ts:38

waitAny

waitAny<K extends string | number | symbol>(
    events: K[],
): Promise<
    {
        event: K;
        args: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K];
    },
>
Await the next emission of any one of the listed events. Resolves with { event: name, args: the arguments it received }
Type Parameters
- K extends string | number | symbol
Parameters
- events: K[]
Returns Promise<
    {
        event: K;
        args: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K];
    },
>
Inherited from LeaEventEmitter.waitAny
- Defined in src/lea.ts:58

waitAll

waitAll<
    const K extends
        readonly (
            | "error"
            | "draw"
            | "update"
            | Exclude<keyof ExtraEventMap, "error" | "draw" | "update">
        )[],
>(
    ...events: K,
): Promise<
    {
        [I in string
        | number
        | symbol]: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K[I<I>]]
    },
>
Type Parameters
- const K extends readonly (
      | "error"
      | "draw"
      | "update"
      | Exclude<keyof ExtraEventMap, "error" | "draw" | "update">
  )[]
Parameters
- ...events: K
Returns Promise<
    {
        [I in string
        | number
        | symbol]: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K[I<I>]]
    },
>
Inherited from LeaEventEmitter.waitAll
- Defined in src/lea.ts:74

on

on<K extends string | number | symbol>(
    event: K,
    listener: (
        ...args: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K],
    ) => void,
): this
Registers a listener for the specified event.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The name of the event
- listener: (
      ...args: MergeObject<
          ExtraEventMap,
          { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
      >[K],
  ) => void
  The callback to invoke when the event is emitted
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.on
- Defined in src/lea.ts:103

onWithCleanup

onWithCleanup<K extends string | number | symbol>(
    event: K,
    listener: (
        off: () => void,
        ...args: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K],
    ) => void,
): () => void
Registers a listener for the specified event but returns a cleanup func.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The name of the event
- listener: (
      off: () => void,
      ...args: MergeObject<
          ExtraEventMap,
          { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
      >[K],
  ) => void
  The callback to invoke when the event is emitted
Returns () => void
Inherited from LeaEventEmitter.onWithCleanup
- Defined in src/lea.ts:119

once

once<K extends string | number | symbol>(
    event: K,
    listener: (
        ...args: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K],
    ) => void,
): this
Registers a one-time listener for the specified event.

The listener is automatically removed after the first invocation.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The name of the event
- listener: (
      ...args: MergeObject<
          ExtraEventMap,
          { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
      >[K],
  ) => void
  The callback to invoke once
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.once
- Defined in src/lea.ts:142

off

off<K extends string | number | symbol>(
    event: K,
    listener: (
        ...args: MergeObject<
            ExtraEventMap,
            { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
        >[K],
    ) => void,
): this
Removes a listener for the specified event.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The name of the event
- listener: (
      ...args: MergeObject<
          ExtraEventMap,
          { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
      >[K],
  ) => void
  The callback to remove
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.off
- Defined in src/lea.ts:162

emit

emit<K extends string | number | symbol>(
    event: K,
    ...args: MergeObject<
        ExtraEventMap,
        { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
    >[K],
): boolean
Emits an event, invoking all registered listeners with the provided arguments.

If the event is "error" and no listeners are registered, the first argument (the error) will be thrown.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The name of the event to emit
- ...args: MergeObject<
  ExtraEventMap,
  { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
  >[K]
  Arguments to pass to listeners
Returns boolean
true if any listeners were invoked, false otherwise
Inherited from LeaEventEmitter.emit
- Defined in src/lea.ts:184

`Protected`emitIgnored

emitIgnored<K extends string | number | symbol>(event: K, ...args: any): boolean
Emits an event, invoking all registered listeners with the provided arguments.

If the event is "error" and no listeners are registered, the first argument (the error) will be thrown.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The name of the event to emit
- ...args: any
  Arguments to pass to listeners
Returns boolean
true if any listeners were invoked, false otherwise
Inherited from LeaEventEmitter.emitIgnored
- Defined in src/lea.ts:209

removeAllListeners

removeAllListeners<K extends string | number | symbol>(
event?: K,
): LeaEntityII<ExtraEventMap>
Removes all listeners for the specified event, or all listeners if no event is provided.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- Optionalevent: K
  Optional event name to clear listeners for
Returns LeaEntityII<ExtraEventMap>
This emitter for chaining
Inherited from LeaEventEmitter.removeAllListeners
- Defined in src/lea.ts:234

listenerCount

listenerCount<K extends string | number | symbol>(event: K): number
Returns the number of listeners registered for the specified event.
Type Parameters
- K extends string | number | symbol
  Event name
Parameters
- event: K
  The event to count listeners for
Returns number
The number of registered listeners
Inherited from LeaEventEmitter.listenerCount
- Defined in src/lea.ts:250

now

now(): number
Returns number
- Defined in src/lea.ts:989

handleUpdate

handleUpdate(delta: number): void
Update entity.
Parameters
- delta: number
Returns void
- Defined in src/lea.ts:1050

`Abstract`update

update(_delta: number): void
Called once per tick with delta time (seconds).
Parameters
- _delta: number
Returns void
Implementation of Updatable.update
- Defined in src/lea.ts:1070

handleDraw

handleDraw(ctx: CanvasRenderingContext2D): void
Draw entity.
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- Defined in src/lea.ts:1075

localMove

localMove(v: XY, config: LocalTweenOperationConfigNoDelta): LocalTweenHandle
Parameters
- v: XY
- config: LocalTweenOperationConfigNoDelta
Returns LocalTweenHandle
- Defined in src/lea.ts:1090

localHotMove

localHotMove(
liveRef: XY | (() => XY),
config: LocalTweenOperationConfigNoDelta,
): LocalTweenHandle
Parameters
- liveRef: XY | (() => XY)
- config: LocalTweenOperationConfigNoDelta
Returns LocalTweenHandle
- Defined in src/lea.ts:1105

onRemoveFromScene

onRemoveFromScene(_scene: LeaSceneII): void
Parameters
- _scene: LeaSceneII
Returns void
- Defined in src/lea.ts:1129

onAddToScene

onAddToScene(_scene: LeaSceneII): void
Parameters
- _scene: LeaSceneII
Returns void
- Defined in src/lea.ts:1130

createLocalTween

createLocalTween(
config: LocalTweenOperationConfig,
callback?: (...changes: number[]) => void,
): LocalTweenHandle
Parameters
- config: LocalTweenOperationConfig
- callback: (...changes: number[]) => void = ...
Returns LocalTweenHandle
- Defined in src/lea.ts:1138

createLocalUpdatable

createLocalUpdatable<T extends Updatable>(
updatable: ((delta: number) => void) | T,
config?: LocalUpdatableOperationConfig<T>,
): LocalUpdatableHandle<T>
Type Parameters
- T extends Updatable
Parameters
- updatable: ((delta: number) => void) | T
- Optionalconfig: LocalUpdatableOperationConfig<T>
Returns LocalUpdatableHandle<T>
- Defined in src/lea.ts:1169

createLocalTimeout

createLocalTimeout(config: TimeoutConfig): DeltaTimeout
Parameters
- config: TimeoutConfig
Returns DeltaTimeout
- Defined in src/lea.ts:1195

createManualTween

createManualTween(config: TweenConfig): DeltaTweenII
Parameters
- config: TweenConfig
Returns DeltaTweenII
- Defined in src/lea.ts:1212

`Optional` `Abstract`draw

draw?(ctx: CanvasRenderingContext2D): void
Called once per frame to draw the entity.

The context is already translated to the entity's position if autoTranslate is true.
Parameters
- ctx: CanvasRenderingContext2D
  The 2D rendering context
Returns void
- Defined in src/lea.ts:1224

serialize

serialize(): any
Serializes the entity to a plain object (for save/load).

Excludes internal properties and respects nonSerializableProperties.

Returns any
Serializable data
- Defined in src/lea.ts:1233

toLocal

toLocal(worldVec: Vector2): Vector2
Converts a world position to local space relative to this entity.
Parameters
- worldVec: Vector2
  World position
Returns Vector2
Local position
- Defined in src/lea.ts:1292

toWorld

toWorld(localVec: Vector2): Vector2
Converts a local position to world space.
Parameters
- localVec: Vector2
  Local position
Returns Vector2
World position
- Defined in src/lea.ts:1302

deserializeArray

deserializeArray(snapshot: any[]): any
Parameters
- snapshot: any[]
Returns any
- Defined in src/lea.ts:1306

`Static`deserializeArray

deserializeArray(map: LeaEntitySerializer<any>, snapshot: any[]): any
Parameters
- map: LeaEntitySerializer<any>
- snapshot: any[]
Returns any
- Defined in src/lea.ts:1310

Class LeaEntityII<ExtraEventMap>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LeaEntityII<ExtraEventMap>

Properties

listenerMap

name

scaleRotate

scale

hookMap

totalDeltas

Private___hookProxy

OptionalarraySerializeMap

autoTranslate

z

Private___pos

nonSerializableProperties

forceSerializableProperties

OptionalcustomUpdateOwner

Accessors

hooks

Returns HookProxy

pos

Returns Vector2

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

updateOwner

Returns LeaEntityII<any>

Methods

wait

Type Parameters

Parameters

Returns Promise< MergeObject< ExtraEventMap, { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] }, >[K],>

waitAny

Type Parameters

Parameters

Returns Promise< { event: K; args: MergeObject< ExtraEventMap, { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] }, >[K]; },>

waitAll

Type Parameters

Parameters

Returns Promise< { [I in string | number | symbol]: MergeObject< ExtraEventMap, { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] }, >[K[I<I>]] },>

on

Type Parameters

Parameters

Returns this

onWithCleanup

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

ProtectedemitIgnored

Type Parameters

Parameters

Class LeaEntityII<ExtraEventMap>`Abstract`

`Private`___hookProxy

`Optional`arraySerializeMap

`Private`___pos

`Optional`customUpdateOwner

Returns Promise<
MergeObject<
ExtraEventMap,
{ update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
>[K],
>

Returns Promise<
{
event: K;
args: MergeObject<
ExtraEventMap,
{ update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
>[K];
},
>

Returns Promise<
{
[I in string
| number
| symbol]: MergeObject<
ExtraEventMap,
{ update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] },
>[K[I<I>]]
},
>

`Protected`emitIgnored

`Abstract`update

`Optional` `Abstract`draw

`Static`deserializeArray