C4 Engine
C4 Engine API Documentation

class SprocketReg

Defined in:  C4Sprockets.h
The SprocketReg class represents a custom sprocket type.
Definition

template <class classType> class SprocketReg : public SprocketRegistration

Template Parameters
classType The custom sprocket class.
Constructor

SprocketReg(SprocketType type, const char *name);

Parameters
type The sprocket type.
name The sprocket name.
Description
The SprocketReg template class is used to advertise the existence of a custom sprocket type. The Interface Manager uses a sprocket registration to construct a custom sprocket. The act of instantiating a SprocketReg object automatically registers the corresponding sprocket type. The sprocket type is unregistered when the SprocketReg object is destroyed.

No more than one sprocket registration should be created for each distinct sprocket type.
Base Classes
SprocketRegistration All specific sprocket registration classes share the common base class SprocketRegistration.
See Also

Sprocket