Class ControllerCollision

Contains data about a collision of a character controller and another object.

Index

Constructors

Properties

_motionAmount _motionDirection _normal _position

Accessors

motionAmount motionDirection normal position

Methods

assign clone isEqual isEqual

Constructors

constructor

new ControllerCollision(position?, normal?, motionDirection?, motionAmount?): ControllerCollision
Parameters
- Optionalposition: Immutable<Vector3>
- Optionalnormal: Immutable<Vector3>
- OptionalmotionDirection: Immutable<Vector3>
- OptionalmotionAmount: number
Returns ControllerCollision

Properties

`Protected`_motionAmount

_motionAmount: number

`Protected`_motionDirection

_motionDirection: Vector3

`Protected`_normal

_normal: Vector3

`Protected`_position

_position: Vector3

Accessors

motionAmount

get motionAmount(): number
Magnitude of motion after the hit.

Returns number
set motionAmount(value): void
Parameters
- value: number
Returns void

motionDirection

get motionDirection(): Vector3
Direction of motion after the hit.

Returns Vector3
set motionDirection(value): void
Parameters
- value: Immutable<Vector3>
Returns void

normal

get normal(): Vector3
Contact normal.

Returns Vector3
set normal(value): void
Parameters
- value: Immutable<Vector3>
Returns void

position

get position(): Vector3
Contact position.

Returns Vector3
set position(value): void
Parameters
- value: Immutable<Vector3>
Returns void

Methods

assign

assign(other): ControllerCollision
Copies all properties defined by the prototype of ControllerCollision from other to this instance.
Parameters
- other: Immutable<ControllerCollision>
Returns ControllerCollision

clone

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

Returns ControllerCollision

isEqual

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

`Static`isEqual

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