RigidBodyController::SetCollisionKind

Defined in: C4Physics.h

Sets the collision kind for a rigid body.

Prototype

void SetCollisionKind(uint32 kind);

Parameters

kind The new collision kind.

Description

The SetCollisionKind function sets the collision kind for a rigid body. The collision kind is a 32-bit value that typically has a single bit set to 1, and the rest set to 0. However, values with more than one bit set are allowed. The following collision kinds are defined by the engine.

`kCollisionRigidBody`	Any type of rigid body.
`kCollisionCharacter`	A rigid body that represents a character.
`kCollisionProjectile`	A rigid body that represents a projectile.
`kCollisionVehicle`	A rigid body that represents a vehicle.
`kCollisionCamera`	A type of camera.
`kCollisionSightPath`	When used in an exclusion mask, does not obstruct sight.
`kCollisionSoundPath`	When used in an exclusion mask, does not obstruct sound.
`kCollisionBaseKind`	First application-defined collision kind.
`kCollisionExcludeAll`	When used as a collision exclusion mask, this value prevents collisions with everything.

User-defined collision kinds should always be single bit values greater than or equal to kCollisionBaseKind. New collision kinds would typically be defined by setting the first one equal to kCollisionBaseKind, the second one equal to kCollisionBaseKind << 1, the third one equal to kCollisionBaseKind << 2, and so on.

The initial collision kind for a rigid body is kCollisionRigidBody.