Interface World

Readonlychildren

data

parent

ReadonlysystemApi

addEventListener

• addEventListener<T extends EventType>(
      type: T,
      callback: (
          event: T extends keyof WorldEventMap
              ? WorldEventMap[T]
              : T extends keyof SceneEventMap
                  ? SceneEventMap[T]
                  : 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 WorldEventMap
            ? WorldEventMap[T]
            : T extends keyof SceneEventMap
                ? SceneEventMap[T]
                : T extends keyof ActorEventMap ? ActorEventMap[T] : Event<EventTarget>,
    ) => void

    Function to call when the event is triggered

  Returns void

appendChild

• appendChild(child: Scene): void

  Adds a child to the entity.

  Parameters

  • child: Scene

    Child to add

  Returns void

dispatchEvent

• dispatchEvent<T extends EventType>(
      type: T,
      ...payload: EventPayload<WorldEventMap, 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<WorldEventMap, T>

    Payload of the event

  Returns void

findChild

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

  Finds a child entity by a predicate function.

  Parameters

  • predicate: (child: Actor | Scene) => 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 | Scene | undefined

  Child entity or undefined

findChildById

• findChildById(id: string, recursive?: boolean): Actor | Scene | 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 | Scene | undefined

  Child entity or undefined

findChildByName

• findChildByName(name: string, recursive?: boolean): Actor | Scene | 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 | Scene | undefined

  Child entity or undefined

removeChild

• removeChild(child: Scene): void

  Removes a child from the entity.

  Parameters

  • child: Scene

    Child to remove

  Returns void

removeEventListener

• removeEventListener<T extends EventType>(
      type: T,
      callback: (
          event: T extends keyof WorldEventMap
              ? WorldEventMap[T]
              : T extends keyof SceneEventMap
                  ? SceneEventMap[T]
                  : 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 WorldEventMap
            ? WorldEventMap[T]
            : T extends keyof SceneEventMap
                ? SceneEventMap[T]
                : T extends keyof ActorEventMap ? ActorEventMap[T] : Event<EventTarget>,
    ) => void

    Function to remove the listener for

  Returns void