Class World

A world is the root container for all scenes and actors. It is also provide an access to system APIs.

Hierarchy (View Summary)

Entity
- World

Index

Constructors

Properties

children data id name parent systemApi

Methods

addEventListener appendChild dispatchEvent dispatchEventImmediately findChild findChildById findChildByName getEventListeners remove removeAllListeners removeChild removeEventListener

Constructors

constructor

new World(options: EntityOptions): World
Parameters
- options: EntityOptions
Returns World

Overrides Entity.constructor

Properties

`Readonly`children

children: Scene[]

Children of the entity

data

data: Record<string, unknown>

Custom data storage for world-related information

`Readonly`id

id: string

Id of the entity

`Readonly`name

name: string

Name of the entity

parent

parent: null

Parent of the entity

`Readonly`systemApi

systemApi: SystemAPIRegistry

Registry of system APIs

Methods

addEventListener

addEventListener<T extends EventType>(
type: T,
callback: WorldListenerFn<T>,
): void
Adds an event listener to the event target.
Type Parameters
- T extends EventType
Parameters
- type: T
  Type of event to listen for
- callback: WorldListenerFn<T>
  Function to call when the event is triggered
Returns void

Overrides Entity.addEventListener

appendChild

appendChild(child: Scene): void
Adds a child to the entity.
Parameters
- child: Scene
  Child to add
Returns void

Overrides Entity.appendChild

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 order that 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

Overrides Entity.dispatchEvent

dispatchEventImmediately

dispatchEventImmediately<T extends EventType>(
type: T,
...payload: EventPayload<WorldEventMap, T>,
): void
Dispatches an event to the event target immediately.

Events are processed immediately and not added to the engine event queue.
Type Parameters
- T extends EventType
Parameters
- type: T
  Type of event to dispatch
- ...payload: EventPayload<WorldEventMap, T>
  Payload of the event
Returns void

Overrides Entity.dispatchEventImmediately

findChild

findChild(
predicate: (child: Scene | Actor) => boolean,
recursive?: boolean,
): Scene | Actor | undefined
Finds a child entity by a predicate function.
Parameters
- predicate: (child: Scene | 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 Scene | Actor | undefined
Child entity or undefined

Overrides Entity.findChild

findChildById

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

Overrides Entity.findChildById

findChildByName

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

Overrides Entity.findChildByName

getEventListeners

getEventListeners(type: EventType): ListenerFn[] | undefined
Gets the event listeners for the event target.
Parameters
- type: EventType
  Type of event to get the listeners for
Returns ListenerFn[] | undefined
Event listeners for the event target

Inherited from Entity.getEventListeners

remove

remove(): void

Removes the entity from its parent.

Returns void

Inherited from Entity.remove

removeAllListeners

removeAllListeners(): void

Removes all event listeners from the event target.

Returns void

Inherited from Entity.removeAllListeners

removeChild

removeChild(child: Scene): void
Removes a child from the entity.
Parameters
- child: Scene
  Child to remove
Returns void

Overrides Entity.removeChild

removeEventListener

removeEventListener<T extends EventType>(
type: T,
callback: WorldListenerFn<T>,
): 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: WorldListenerFn<T>
  Function to remove the listener for
Returns void

Overrides Entity.removeEventListener