C4 Engine
C4 Engine API Documentation

class SprocketRegistration

Defined in:  C4Sprockets.h
The SprocketRegistration class manages internal registration information for a custom sprocket type.
Definition

class SprocketRegistration : public Registration<Sprocket, SprocketRegistration>

Member Functions
SprocketRegistration::GetSprocketType Returns the registered sprocket type.
SprocketRegistration::GetSprocketName Returns the human-readable sprocket name.
Constructor

SprocketRegistration(SprocketType type, const char *name);

Parameters
type The sprocket type.
name The sprocket name.
Description
The SprocketRegistration class is abstract and serves as the common base class for the template class SprocketReg. A custom sprocket is registered with the engine by instantiating an object of type SprocketReg<classType>, where classType is the type of the sprocket subclass being registered.
Base Classes
Registration<Sprocket, SprocketRegistration> A sprocket registration is a specific type of registration object.
See Also

SprocketReg

Sprocket