PreDrawEvent

The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics transform so that all drawing takes place with the actor as the origin.

Hierarchy

• GameEvent<Entity | Scene | Engine | TileMap>
  • PreDrawEvent

Index

Constructors

• constructor

Properties

• ctx
• elapsed
• other
• self
• target

Accessors

• bubbles

Methods

• stopPropagation

Constructors

constructor

• PreDrawEvent(ctx: ExcaliburGraphicsContext, elapsed: number, self: Engine<any> | Entity<any> | Scene<unknown> | TileMap): PreDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • elapsed: number

  • self: Engine<any> | Entity<any> | Scene<unknown> | TileMap

  Returns PreDrawEvent

Properties

publicctx

ctx: ExcaliburGraphicsContext

publicelapsed

elapsed: number

publicinheritedother

other: Engine<any> | Entity<any> | Scene<unknown> | TileMap | null = null

Inherited from GameEvent.other

Other target object for this event

publicself

self: Engine<any> | Entity<any> | Scene<unknown> | TileMap

publicinheritedtarget

target: Engine<any> | Entity<any> | Scene<unknown> | TileMap

Inherited from GameEvent.target

Target object for this event.

Accessors

publicinheritedbubbles

• get bubbles(): boolean
• set bubbles(value: boolean): void

• Inherited from GameEvent.bubbles

  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

  Parameters

  • value: boolean

  Returns void

Methods

publicinheritedstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void