Class ActorCollection

Deprecated

Use ActorQuery instead.

Hierarchy (View Summary)

EventTarget
- ActorCollection

Index

Constructors

Properties

Accessors

Methods

addEventListener dispatchEvent dispatchEventImmediately filter find forEach getById getEventListeners map reduce removeAllListeners removeEventListener sort

Constructors

constructor

new ActorCollection(
scene: Scene,
filter?: ActorCollectionFilter,
): ActorCollection
Parameters
- scene: Scene
- filter: ActorCollectionFilter = {}
Returns ActorCollection

Overrides EventTarget.constructor

Properties

parent

parent: EventTarget | null

Parent event target

Accessors

size

get size(): number

Returns number

Methods

addEventListener

addEventListener<T extends EventType>(
type: T,
callback: ActorCollectionListenerFn<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: ActorCollectionListenerFn<T>
  Function to call when the event is triggered
Returns void

Overrides EventTarget.addEventListener

dispatchEvent

dispatchEvent(type: EventType, payload?: Record<string, unknown>): 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.
Parameters
- type: EventType
  Type of event to dispatch
- Optionalpayload: Record<string, unknown>
  Payload of the event
Returns void

Inherited from EventTarget.dispatchEvent

dispatchEventImmediately

dispatchEventImmediately(
type: EventType,
payload?: Record<string, unknown>,
): void
Dispatches an event to the event target immediately.

Events are processed immediately and not added to the engine event queue.
Parameters
- type: EventType
  Type of event to dispatch
- Optionalpayload: Record<string, unknown>
  Payload of the event
Returns void

Inherited from EventTarget.dispatchEventImmediately

filter

filter(callback: (actor: Actor, index: number) => boolean): Actor[]
Parameters
- callback: (actor: Actor, index: number) => boolean
Returns Actor[]

find

find(callback: (actor: Actor, index: number) => boolean): Actor | undefined
Parameters
- callback: (actor: Actor, index: number) => boolean
Returns Actor | undefined

forEach

forEach(callback: (actor: Actor, index: number) => void): void
Parameters
- callback: (actor: Actor, index: number) => void
Returns void

getById

getById(id: string): Actor | undefined
Parameters
- id: string
Returns Actor | undefined

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 EventTarget.getEventListeners

map

map<T>(callback: (actor: Actor, index: number) => T): T[]
Type Parameters
- T
Parameters
- callback: (actor: Actor, index: number) => T
Returns T[]

reduce

reduce<T>(
callback: (previousValue: T, currentValue: Actor, index: number) => T,
initialValue: T,
): T
Type Parameters
- T
Parameters
- callback: (previousValue: T, currentValue: Actor, index: number) => T
- initialValue: T
Returns T

removeAllListeners

removeAllListeners(): void

Removes all event listeners from the event target.

Returns void

Inherited from EventTarget.removeAllListeners

removeEventListener

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

Overrides EventTarget.removeEventListener

sort

sort(compareFunction: (a: Actor, b: Actor) => number): void
Parameters
- compareFunction: (a: Actor, b: Actor) => number
Returns void