Sprocket::GetSprocketState

Defined in: C4Sprockets.h

Returns the sprocket state.

Prototype

uint32 GetSprocketState(void) const;

Description

The GetSprocketState function returns the sprocket flags, 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.