Class CollisionData

Information about a collision between two physics objects.

Index

Constructors

Properties

_contactPoints _otherCollider _otherColliderShape _otherController _thisCollider _thisColliderShape

Accessors

contactPoints otherCollider otherColliderShape otherController thisCollider thisColliderShape

Methods

clone isEqual isEqual

Constructors

constructor

new CollisionData(thisCollider?, otherCollider?, thisColliderShape?, otherColliderShape?, otherController?, contactPoints?): CollisionData
Parameters
- OptionalthisCollider: Collider
- OptionalotherCollider: Collider
- OptionalthisColliderShape: ColliderShape
- OptionalotherColliderShape: ColliderShape
- OptionalotherController: CharacterController
- OptionalcontactPoints: Iterable<ContactPoint>
Returns CollisionData

Properties

`Protected`_contactPoints

_contactPoints: ContactPoint[]

`Protected`_otherCollider

_otherCollider: Collider

`Protected`_otherColliderShape

_otherColliderShape: ColliderShape

`Protected`_otherController

_otherController: CharacterController

`Protected`_thisCollider

_thisCollider: Collider

`Protected`_thisColliderShape

_thisColliderShape: ColliderShape

Accessors

contactPoints

get contactPoints(): ContactPoint[]
Returns ContactPoint[]

otherCollider

get otherCollider(): Collider
The collider component that collides with ThisCollider.

Returns Collider

otherColliderShape

get otherColliderShape(): ColliderShape
The other ColliderShape that collides with ThisCollider.

Returns ColliderShape
Note
This field may be null if the collision is with

otherController

get otherController(): CharacterController
The CharacterController that collides with ThisCollider.

Returns CharacterController

thisCollider

get thisCollider(): Collider
The collider component that owns the event.

Returns Collider

thisColliderShape

get thisColliderShape(): ColliderShape
The ColliderShape that belongs to the component that owns the event.

Returns ColliderShape

Methods

clone

clone(): CollisionData
Clones this instance and returns a new CollisionData with identical values.

Returns CollisionData

isEqual

isEqual(this, other): boolean
Determines if this CollisionData instance is equal to the other instance.
Parameters
- this: Immutable<CollisionData>
- other: Immutable<CollisionData>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both CollisionData instances are equal.
Parameters
- lhs: Immutable<CollisionData>
- rhs: Immutable<CollisionData>
Returns boolean