RigidBodyController::SetGravityMultiplier

Defined in: C4Physics.h

Sets the gravity multiplier for a rigid body.

Prototype

void SetGravityMultiplier(float multiplier);

Parameters

multiplier The new gravity multiplier.

Description

The SetGravityMultiplier function sets the gravity multiplier for a rigid body to the value specified by the multiplier parameter. The gravity multiplier scales the force exerted on a rigid body by the global gravity set in the PhysicsController object. A multiplier of 1.0 means that the ordinary gravity force is applied, while values higher or lower than 1.0 mean that proportionately more or less gravity is applied. If the gravity multiplier is 0.0, then no gravity is applied to the rigid body at all.

The initial value of the gravity multiplier is 1.0.