Class CollisionStartEvent<T>

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

Type Parameters

T extends BodyComponent | Collider | Entity = Actor

Hierarchy

Events.GameEvent<T>
- CollisionStartEvent

Index

Constructors

Properties

contact other target

Accessors

Methods

stopPropagation

Constructors

constructor

new CollisionStartEvent<T>(actor: T, other: T, contact: CollisionContact): Events.CollisionStartEvent<T>
Type Parameters
- T extends Entity | Collider | BodyComponent = Actor
Parameters
- actor: T
- other: T
- contact: CollisionContact
Returns Events.CollisionStartEvent<T>
Overrides GameEvent.constructor
- Defined in Events.ts:448

Properties

contact

contact: CollisionContact

other

other: T

target

target: T

Target object for this event.

Accessors

actor

get actor(): T
Returns T
- Defined in Events.ts:453
set actor(actor: T): void
Parameters
- actor: T
Returns void
- Defined in Events.ts:457

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