Class ActivateEvent<TData>

Event thrown on a Scene on activation

Type Parameters

TData = undefined

Hierarchy

Events.GameEvent<Scene>
- ActivateEvent

Index

Constructors

Properties

context other target

Accessors

Methods

stopPropagation

Constructors

constructor

new ActivateEvent<TData>(context: SceneActivationContext<TData>, target: Scene<unknown>): Events.ActivateEvent<TData>
Type Parameters
- TData = undefined
Parameters
- context: SceneActivationContext<TData>
  
  The context for the scene activation
- target: Scene<unknown>
Returns Events.ActivateEvent<TData>
Overrides GameEvent.constructor
- Defined in Events.ts:502

Properties

context

context: SceneActivationContext<TData>

The context for the scene activation

other

other: Scene<unknown>

Other target object for this event

target

target: Scene<unknown>

Target object for this event.

Accessors

bubbles

get bubbles(): boolean
If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

Returns boolean
Inherited from GameEvent.bubbles
- Defined in Events.ts:178
set bubbles(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from GameEvent.bubbles
- Defined in Events.ts:182

Methods

stopPropagation

stopPropagation(): void
Prevents event from bubbling

Returns void
Inherited from GameEvent.stopPropagation
- Defined in Events.ts:190