Class PreCollisionEvent<T>

Event thrown on an actor when a collision will occur this frame if it resolves

Type Parameters

T extends BodyComponent | Collider | Entity = Actor

Hierarchy

Events.GameEvent<T>
- PreCollisionEvent

Index

Constructors

Properties

intersection other side target

Accessors

Methods

stopPropagation

Constructors

constructor

new PreCollisionEvent<T>(actor: T, other: T, side: Side, intersection: Vector): Events.PreCollisionEvent<T>
Type Parameters
- T extends Entity | Collider | BodyComponent = Actor
Parameters
- actor: T
  
  The actor the event was thrown on
- other: T
  
  The actor that will collided with the current actor
- side: Side
  
  The side that will be collided with the current actor
- intersection: Vector
  
  Intersection vector
Returns Events.PreCollisionEvent<T>
Overrides GameEvent.constructor
- Defined in Events.ts:392

Properties

intersection

intersection: Vector

Intersection vector

other

other: T

The actor that will collided with the current actor

side

side: Side

The side that will be collided with the current actor

target

target: T

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