class ModifierReg

Defined in: C4Modifiers.h

The ModifierReg class represents a custom modifier type.

Definition

template <class classType> class ModifierReg : public ModifierRegistration

Template Parameters

classType The custom modifier class.

Constructor

ModifierReg(ModifierType type, const char *name);

Parameters

`type`	The modifier type.
`name`	The modifier name.

Description

The ModifierReg template class is used to advertise the existence of a custom modifier type. The World Manager uses a modifier registration to construct a custom modifier, and the World Editor examines a modifier registration to determine what type of instance a custom modifier can be assigned to. The act of instantiating a ModifierReg object automatically registers the corresponding modifier type. The modifier type is unregistered when the ModifierReg object is destroyed.

No more than one modifier registration should be created for each distinct modifier type.

Base Classes

ModifierRegistration All specific modifier registration classes share the common base class ModifierRegistration.