Class Actor

constructor

• new Actor(options: ActorOptions): Actor

  Creates a new Actor instance.

  Parameters

  • options: ActorOptions

    Configuration options for the actor

  Returns Actor

Readonlychildren

parent

Optional ReadonlytemplateId

addEventListener

• addEventListener<T extends EventType>(
      type: T,
      callback: (
          event: T extends keyof ActorEventMap
              ? ActorEventMap[T]
              : Event<EventTarget>,
      ) => void,
  ): void

  Adds an event listener to the event target.

  Type Parameters

  • T extends EventType

  Parameters

  • type: T

    Type of event to listen for

  • callback: (
        event: T extends keyof ActorEventMap
            ? ActorEventMap[T]
            : Event<EventTarget>,
    ) => void

    Function to call when the event is triggered

  Returns void

appendChild

• appendChild(child: Actor): void

  Adds a child to the entity.

  Parameters

  • child: Actor

    Child to add

  Returns void

dispatchEvent

• dispatchEvent<T extends EventType>(
      type: T,
      ...payload: EventPayload<ActorEventMap, T>,
  ): void

  Dispatches an event to the event target.

  Events are processed in the engine event queue at the beginning of each frame in the order they were dispatched.

  Type Parameters

  • T extends EventType

  Parameters

  • type: T

    Type of event to dispatch

  • ...payload: EventPayload<ActorEventMap, T>

    Payload of the event

  Returns void

findChild

• findChild(
      predicate: (child: Actor) => boolean,
      recursive?: boolean,
  ): Actor | undefined

  Finds a child entity by a predicate function.

  Parameters

  • predicate: (child: Actor) => boolean

    A function that runs on each child entity and should return true if the child entity matches the predicate or false otherwise

  • recursive: boolean = true

    Whether to search recursively through the children

  Returns Actor | undefined

  Child entity or undefined

findChildById

• findChildById(id: string, recursive?: boolean): Actor | undefined

  Finds a child entity by its id.

  Parameters

  • id: string

    Id of the child entity

  • recursive: boolean = true

    Whether to search recursively through the children

  Returns Actor | undefined

  Child entity or undefined

findChildByName

• findChildByName(name: string, recursive?: boolean): Actor | undefined

  Finds a child entity by its name.

  Parameters

  • name: string

    Name of the child entity

  • recursive: boolean = true

    Whether to search recursively through the children

  Returns Actor | undefined

  Child entity or undefined

getComponent

• getComponent<T extends Component<object>>(
      classOrName: string | ComponentConstructor<T>,
  ): T

  Gets a specific component from this actor.

  Type Parameters

  • T extends Component<object>

  Parameters

  • classOrName: string | ComponentConstructor<T>

    The component class or component name string

  Returns T

  The component instance, or undefined if not found

  Example

  // Get by class
  const transform = actor.getComponent(Transform);
  
  // Get by name
  const sprite = actor.getComponent('Sprite');
  
  // Type-safe access
  if (transform) {
    transform.world.position.x = 100;
  }
  Copy

getComponents

• getComponents(): Component<object>[]

  Gets all components attached to this actor.

  Returns Component<object>[]

  An array of all components

removeChild

• removeChild(child: Actor): void

  Removes a child from the entity.

  Parameters

  • child: Actor

    Child to remove

  Returns void

removeComponent

• removeComponent(componentClass: ComponentConstructor): void

  Removes a component from this actor.

  Parameters

  • componentClass: ComponentConstructor

    The component class to remove

  Returns void

  Example

  actor.removeComponent(Transform);
  Copy

removeEventListener

• removeEventListener<T extends EventType>(
      type: T,
      callback: (
          event: T extends keyof ActorEventMap
              ? ActorEventMap[T]
              : Event<EventTarget>,
      ) => void,
  ): void

  Removes an event listener from the event target.

  Type Parameters

  • T extends EventType

  Parameters

  • type: T

    Type of event to remove the listener for

  • callback: (
        event: T extends keyof ActorEventMap
            ? ActorEventMap[T]
            : Event<EventTarget>,
    ) => void

    Function to remove the listener for

  Returns void

setComponent

• setComponent(component: Component): void

  Attaches a component to this actor.

  Parameters

  • component: Component

    The component to attach

  Returns void

  Example

  const transform = new Transform({
    offset: { x: 100, y: 200 },
    rotation: 0,
    scale: { x: 1, y: 1 }
  });
  actor.setComponent(transform);
  Copy