EnterTriggerEvent

Base event type in Excalibur that all other event types derive from. Not all event types are thrown on all Excalibur game objects, some events are unique to a type, others are not.

Hierarchy

• GameEvent<Trigger>
  • EnterTriggerEvent

Index

Constructors

• constructor

Properties

• entity
• other
• self
• target

Accessors

• bubbles

Methods

• stopPropagation

Constructors

constructor

• EnterTriggerEvent(self: Trigger, entity: Entity): EnterTriggerEvent

• Overrides GameEvent.constructor

  Parameters

  • self: Trigger

  • entity: Entity

  Returns EnterTriggerEvent

Properties

publicentity

entity: Entity

publicinheritedother

other: Trigger | null = null

Inherited from GameEvent.other

Other target object for this event

publicself

self: Trigger

publicinheritedtarget

target: Trigger

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