@kayelaa/canvas API - v0.2.15
    Preparing search index...

    Class RectLeaEntityAbstract

    Rectangular entity with centered position, width, height, and basic AABB collision.

    Automatically handles translation and rotation for drawing if needed.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • name: string
      • x: number = 0

        Center X

      • y: number = 0

        Center Y

      • width: number = 50
      • height: number = 50

      Returns RectLeaEntity

    Properties

    listenerMap: Map<"error" | "draw" | "update", Listener<any[]>[]> = ...
    name: string = ""

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

    scaleRotate: number = 0
    scale: number = 1
    arraySerializeMap?: LeaEntitySerializer<any>
    autoTranslate: boolean
    z: number

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

    nonSerializableProperties: (string | number | symbol)[]
    forceSerializableProperties: (string | number | symbol)[]
    width: number

    Width of the rectangle (centered on x).

    height: number

    Height of the rectangle (centered on y).

    color: string = "rgba(0, 0, 255, 0.3)"

    Default fill color for the rectangle (used in base draw implementation).

    Accessors

    • get left(): number

      Left edge of the bounding box.

      Returns number

    • set left(val: number): void

      Parameters

      • val: number

      Returns void

    • get right(): number

      Right edge of the bounding box.

      Returns number

    • set right(val: number): void

      Parameters

      • val: number

      Returns void

    • get top(): number

      Top edge of the bounding box.

      Returns number

    • set top(val: number): void

      Parameters

      • val: number

      Returns void

    • get bottom(): number

      Bottom edge of the bounding box.

      Returns number

    • set bottom(val: number): void

      Parameters

      • val: number

      Returns void

    Methods

    • Registers a listener for the specified event.

      Type Parameters

      • K extends "error" | "draw" | "update"

        Event name

      Parameters

      • event: K

        The name of the event

      • listener: (
            ...args: {
                update: [number];
                error: [unknown];
                draw: [CanvasRenderingContext2D];
            }[K],
        ) => void

        The callback to invoke when the event is emitted

      Returns this

      This emitter for chaining

    • Registers a one-time listener for the specified event.

      The listener is automatically removed after the first invocation.

      Type Parameters

      • K extends "error" | "draw" | "update"

        Event name

      Parameters

      • event: K

        The name of the event

      • listener: (
            ...args: {
                update: [number];
                error: [unknown];
                draw: [CanvasRenderingContext2D];
            }[K],
        ) => void

        The callback to invoke once

      Returns this

      This emitter for chaining

    • Removes a listener for the specified event.

      Type Parameters

      • K extends "error" | "draw" | "update"

        Event name

      Parameters

      • event: K

        The name of the event

      • listener: (
            ...args: {
                update: [number];
                error: [unknown];
                draw: [CanvasRenderingContext2D];
            }[K],
        ) => void

        The callback to remove

      Returns this

      This emitter for chaining

    • 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 "error" | "draw" | "update"

        Event name

      Parameters

      • event: K

        The name of the event to emit

      • ...args: { update: [number]; error: [unknown]; draw: [CanvasRenderingContext2D] }[K]

        Arguments to pass to listeners

      Returns boolean

      true if any listeners were invoked, false otherwise

    • Removes all listeners for the specified event, or all listeners if no event is provided.

      Type Parameters

      • K extends "error" | "draw" | "update"

        Event name

      Parameters

      • Optionalevent: K

        Optional event name to clear listeners for

      Returns RectLeaEntity

      This emitter for chaining

    • Returns the number of listeners registered for the specified event.

      Type Parameters

      • K extends "error" | "draw" | "update"

        Event name

      Parameters

      • event: K

        The event to count listeners for

      Returns number

      The number of registered listeners

    • Serializes the entity to a plain object (for save/load).

      Excludes internal properties and respects nonSerializableProperties.

      Returns any

      Serializable data

    • Converts a world position to local space relative to this entity.

      Parameters

      Returns Vector2

      Local position

    • Checks for axis-aligned bounding box collision with another rectangular entity.

      Parameters

      Returns boolean

      true if the bounding boxes overlap

    • Called once per tick with delta time (seconds).

      Parameters

      • _delta: number

      Returns void

    • Draws a filled rectangle centered on the entity's position.

      Subclasses should override or call super.draw(ctx) if extending.

      Parameters

      • ctx: CanvasRenderingContext2D

        The 2D rendering context

      Returns void