Class ControllerColliderCollision

Contains data about a collision of a character controller and a collider.

Index

Constructors

Properties

_colliderHandle _motionAmount _motionDirection _normal _position _triangleIndex

Accessors

colliderHandle motionAmount motionDirection normal position triangleIndex

Methods

assign clone isEqual isEqual

Constructors

constructor

new ControllerColliderCollision(
    colliderHandle?: Collider,
    triangleIndex?: number,
    position?: Immutable<Vector3>,
    normal?: Immutable<Vector3>,
    motionDirection?: Immutable<Vector3>,
    motionAmount?: number,
): ControllerColliderCollision
Parameters
- OptionalcolliderHandle: Collider
- OptionaltriangleIndex: number
- Optionalposition: Immutable<Vector3>
- Optionalnormal: Immutable<Vector3>
- OptionalmotionDirection: Immutable<Vector3>
- OptionalmotionAmount: number
Returns ControllerColliderCollision

Properties

`Protected`_colliderHandle

_colliderHandle: Collider

`Protected`_motionAmount

_motionAmount: number

`Protected`_motionDirection

_motionDirection: Vector3

`Protected`_normal

_normal: Vector3

`Protected`_position

_position: Vector3

`Protected`_triangleIndex

_triangleIndex: number

Accessors

colliderHandle

get colliderHandle(): Collider

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

Returns Collider
set colliderHandle(value: Collider): void
Parameters
- value: Collider
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

triangleIndex

get triangleIndex(): number

Touched triangle index for mesh colliders.

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

Methods

assign

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

clone

clone(): ControllerColliderCollision

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

Returns ControllerColliderCollision

isEqual

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

`Static`isEqual

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