GeometryObject::GetCollisionExclusionMask

Defined in: C4GeometryObjects.h

Returns the collision exclusion mask.

Prototype

unsigned_int32 GetCollisionExclusionMask(void) const;

Description

The GetCollisionExclusionMask function returns the collision exclusion mask, which may be a combination (through logical OR) of the following bit flags.

`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.

The collision exclusion mask is used to invalidate collisions with rigid bodies having specific collision kinds. The mask is also used to invalidate collisions that are detected by the World::DetectCollision and World::QueryCollision functions.