Class ColliderShape

Represents a single Collider shape.

Constructors

constructor

new ColliderShape(
planeColliderShapeInformation: Immutable<PlaneColliderShapeInformation>,
isInternalConstructor?: boolean,
): ColliderShape
Creates a new plane collider shape.
Parameters
- planeColliderShapeInformation: Immutable<PlaneColliderShapeInformation>
  Information describing the shape.
- OptionalisInternalConstructor: boolean
Returns ColliderShape
New shape instance.

Overrides FrameworkObject.constructor
new ColliderShape(
boxColliderShapeInformation: Immutable<BoxColliderShapeInformation>,
): ColliderShape
Creates a new box collider shape.
Parameters
- boxColliderShapeInformation: Immutable<BoxColliderShapeInformation>
  Information describing the shape.
Returns ColliderShape
New shape instance.

Overrides FrameworkObject.constructor
new ColliderShape(
    sphereColliderShapeInformation: Immutable<
        SphereColliderShapeInformation,
    >,
): ColliderShape
Creates a new sphere collider shape.
Parameters
- sphereColliderShapeInformation: Immutable<SphereColliderShapeInformation>
  Information describing the shape.
Returns ColliderShape
New shape instance.

Overrides FrameworkObject.constructor
new ColliderShape(
    capsuleColliderShapeInformation: Immutable<
        CapsuleColliderShapeInformation,
    >,
): ColliderShape
Creates a new capsule collider shape.
Parameters
- capsuleColliderShapeInformation: Immutable<CapsuleColliderShapeInformation>
  Information describing the shape.
Returns ColliderShape
New shape instance.

Overrides FrameworkObject.constructor
new ColliderShape(
meshColliderShapeInformation: Immutable<MeshColliderShapeInformation>,
): ColliderShape
Creates a new mesh collider shape.
Parameters
- meshColliderShapeInformation: Immutable<MeshColliderShapeInformation>
  Information describing the shape.
Returns ColliderShape
New shape instance.

Overrides FrameworkObject.constructor
new ColliderShape(
    heightmapColliderShapeInformation: Immutable<
        HeightmapColliderShapeInformation,
    >,
): ColliderShape
Creates a new heightmap collider shape.
Parameters
- heightmapColliderShapeInformation: Immutable<HeightmapColliderShapeInformation>
  Information describing the shape.
Returns ColliderShape
New shape instance.

Overrides FrameworkObject.constructor

Accessors

boxShapeInformation

get boxShapeInformation(): Immutable<BoxColliderShapeInformation>

Returns the information describing a collider shape. If the current shape isn't of the provided type, default information is returned.

Returns Immutable<BoxColliderShapeInformation>

capsuleShapeInformation

get capsuleShapeInformation(): Immutable<CapsuleColliderShapeInformation>

Returns the information describing a collider shape. If the current shape isn't of the provided type, default information is returned.

Returns Immutable<CapsuleColliderShapeInformation>

generateHitEvents

get generateHitEvents(): EnumValue<GenerateHitEventMode>

Determines which (if any) collision events are reported.

Returns EnumValue<GenerateHitEventMode>
set generateHitEvents(value: EnumValue<GenerateHitEventMode>): void
Parameters
- value: EnumValue<GenerateHitEventMode>
Returns void

heightmapMesh

get heightmapMesh(): MeshData

Gets the gizmo mesh for the heightmap, if this is a heightmap shape. May return outdated data otherwise.

Returns MeshData

heightmapShapeInformation

get heightmapShapeInformation(): Immutable<HeightmapColliderShapeInformation>

Returns the information describing a collider shape. If the current shape isn't of the provided type, default information is returned.

Returns Immutable<HeightmapColliderShapeInformation>

layer

get layer(): rsx.LayerMask

Determines the layer of the collider. Layer controls with which objects will the collider collide.

Returns rsx.LayerMask
set layer(value: rsx.LayerMask): void
Parameters
- value: rsx.LayerMask
Returns void

mass

get mass(): number

Determines the mass of the collider. Only relevant if the collider is part of a rigidbody. Ultimately this will determine the total mass, center of mass and inertia tensors of the parent rigidbody (if they're being calculated automatically).

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

material

get material(): PhysicsMaterial

Determines the physical material of the collider. The material determines how objects hitting the collider behave.

Returns PhysicsMaterial
set material(value: PhysicsMaterial): void
Determines the physical material of the collider. The material determines how objects hitting the collider behave.
Parameters
- value: PhysicsMaterial
Returns void

materialHandle

get materialHandle(): ResourceHandle<PhysicsMaterial>

Determines the physical material of the collider. The material determines how objects hitting the collider behave.

Returns ResourceHandle<PhysicsMaterial>
set materialHandle(
value: PhysicsMaterial | ResourceHandle<PhysicsMaterial>,
): void
Parameters
- value: PhysicsMaterial | ResourceHandle<PhysicsMaterial>
Returns void

meshShapeInformation

get meshShapeInformation(): Immutable<MeshColliderShapeInformation>

Returns the information describing a collider shape. If the current shape isn't of the provided type, default information is returned.

Returns Immutable<MeshColliderShapeInformation>

owningComponent

get owningComponent(): Component

Returns the owning component.

Returns Component

planeShapeInformation

get planeShapeInformation(): Immutable<PlaneColliderShapeInformation>

Returns the information describing a collider shape. If the current shape isn't of the provided type, default information is returned.

Returns Immutable<PlaneColliderShapeInformation>

position

get position(): Immutable<Vector3>

Determines the position of the collider shape relative to the owning collider.

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

rotation

get rotation(): Immutable<Quaternion>

Determines the rotation of the collider shape relative to the owning collider.

Returns Immutable<Quaternion>
set rotation(value: Immutable<Quaternion>): void
Parameters
- value: Immutable<Quaternion>
Returns void

scale

get scale(): Immutable<Vector3>

Determines the scale of the collider shape.

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

sphereShapeInformation

get sphereShapeInformation(): Immutable<SphereColliderShapeInformation>

Returns the information describing a collider shape. If the current shape isn't of the provided type, default information is returned.

Returns Immutable<SphereColliderShapeInformation>

type

get type(): EnumValue<ColliderShapeType>

Returns the type of the collider shape.

Returns EnumValue<ColliderShapeType>

Methods

inferExtentsFromMesh

inferExtentsFromMesh(): void

Infers the collider shape extents from the mesh that is on the same scene object of the parent collider.

Returns void

updateShape

updateShape(
planeColliderShapeInformation: Immutable<PlaneColliderShapeInformation>,
): any
Updates the internal shape to match the provided shape information.
Parameters
- planeColliderShapeInformation: Immutable<PlaneColliderShapeInformation>
  Information describing the shape.
Returns any
updateShape(
boxColliderShapeInformation: Immutable<BoxColliderShapeInformation>,
): any
Updates the internal shape to match the provided shape information.
Parameters
- boxColliderShapeInformation: Immutable<BoxColliderShapeInformation>
  Information describing the shape.
Returns any
updateShape(
    sphereColliderShapeInformation: Immutable<
        SphereColliderShapeInformation,
    >,
): any
Updates the internal shape to match the provided shape information.
Parameters
- sphereColliderShapeInformation: Immutable<SphereColliderShapeInformation>
  Information describing the shape.
Returns any
updateShape(
    capsuleColliderShapeInformation: Immutable<
        CapsuleColliderShapeInformation,
    >,
): any
Updates the internal shape to match the provided shape information.
Parameters
- capsuleColliderShapeInformation: Immutable<CapsuleColliderShapeInformation>
  Information describing the shape.
Returns any
updateShape(
meshColliderShapeInformation: Immutable<MeshColliderShapeInformation>,
): any
Updates the internal shape to match the provided shape information.
Parameters
- meshColliderShapeInformation: Immutable<MeshColliderShapeInformation>
  Information describing the shape.
Returns any
updateShape(
    heightmapColliderShapeInformation: Immutable<
        HeightmapColliderShapeInformation,
    >,
): any
Updates the internal shape to match the provided shape information.
Parameters
- heightmapColliderShapeInformation: Immutable<HeightmapColliderShapeInformation>
  Information describing the shape.
Returns any

Class ColliderShape

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ColliderShape

Parameters

Returns ColliderShape

Parameters

Returns ColliderShape

Parameters

Returns ColliderShape

Parameters

Returns ColliderShape

Parameters

Returns ColliderShape

Accessors

boxShapeInformation

Returns Immutable<BoxColliderShapeInformation>

capsuleShapeInformation

Returns Immutable<CapsuleColliderShapeInformation>

generateHitEvents

Returns EnumValue<GenerateHitEventMode>

Parameters

Returns void

heightmapMesh

Returns MeshData

heightmapShapeInformation

Returns Immutable<HeightmapColliderShapeInformation>

layer

Returns rsx.LayerMask

Parameters

Returns void

mass

Returns number

Parameters

Returns void

material

Returns PhysicsMaterial

Parameters

Returns void

materialHandle

Returns ResourceHandle<PhysicsMaterial>

Parameters

Returns void

meshShapeInformation

Returns Immutable<MeshColliderShapeInformation>

owningComponent

Returns Component

planeShapeInformation

Returns Immutable<PlaneColliderShapeInformation>

position

Returns Immutable<Vector3>

Parameters

Returns void

rotation

Returns Immutable<Quaternion>

Parameters

Returns void

scale

Returns Immutable<Vector3>

Parameters

Returns void

sphereShapeInformation

Returns Immutable<SphereColliderShapeInformation>

type

Returns EnumValue<ColliderShapeType>

Methods

inferExtentsFromMesh

Returns void

updateShape

Parameters

Returns any

Parameters

Returns any

Parameters

Returns any