CollisionStartEvent <T>

Event thrown the first time an actor collides with another, after an actor is in contact normal collision events are fired.

Hierarchy

• GameEvent<T>
  • CollisionStartEvent

Index

Constructors

• constructor

Properties

• contact
• other
• self
• side
• target

Accessors

• bubbles

Methods

• stopPropagation

Constructors

constructor

• CollisionStartEvent<T>(self: T, other: T, side: Side, contact: CollisionContact): CollisionStartEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: Collider = Collider

  Parameters

  • self: T

  • other: T

  • side: Side

  • contact: CollisionContact

  Returns CollisionStartEvent<T>

Properties

publiccontact

contact: CollisionContact

publicinheritedother

other: T

Inherited from GameEvent.other

publicself

self: T

publicside

side: Side

publicinheritedtarget

target: T

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