Class ControllerControllerCollision

Contains data about a collision between two character controllers.

Index

Constructors

Properties

_controller _motionAmount _motionDirection _normal _position

Accessors

controller motionAmount motionDirection normal position

Methods

assign clone isEqual isEqual

Constructors

constructor

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

Properties

`Protected`_controller

_controller: CharacterController

`Protected`_motionAmount

_motionAmount: number

`Protected`_motionDirection

_motionDirection: Vector3

`Protected`_normal

_normal: Vector3

`Protected`_position

_position: Vector3

Accessors

controller

get controller(): CharacterController

Component of the controller that was touched. Can be null if the controller has no component parent, in which case check #controllerRaw.

Returns CharacterController
set controller(value: CharacterController): void
Parameters
- value: CharacterController
Returns void

motionAmount

get motionAmount(): number

Magnitude of motion after the hit.

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

motionDirection

get motionDirection(): Vector3

Direction of motion after the hit.

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

normal

get normal(): Vector3

Contact normal.

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

position

get position(): Vector3

Contact position.

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

Methods

assign

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

clone

clone(): ControllerControllerCollision

Clones this instance and returns a new ControllerControllerCollision with identical values.

Returns ControllerControllerCollision

isEqual

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

`Static`isEqual

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