Sprocket::SetSprocketState

Defined in: C4Sprockets.h

Sets the sprocket state.

Prototype

void SetSprocketState(uint32 state);

Parameters

state The new sprocket state.

Description

The SetSprocketState function sets the sprocket state to the value specified by the state parameter, which can be a combination (through logical OR) of the following constants.

`kSprocketDisabled`	The sprocket is disabled and will not be updated.
`kSprocketReverse`	The sprocket should run in reverse (if supported).
`kSprocketTerminated`	The sprocket has finished running.