class MAGES::EffectImplementor¶

Overview¶

Base class for classes that implement effect data for a specifc action. More…

class EffectImplementor
{
public:
    // properties

    EffectData Data;

    // methods

    void CallInitialized(BaseActionData action);
    void CallPerformed(BaseActionData action, bool skipped);
    void CallUndone(BaseActionData action);
    virtual void Initialized(BaseActionData action);
    virtual void Performed(BaseActionData action, bool skipped);
    virtual void Undone(BaseActionData action);
    void DestroyOnPerform< T >(T target);
};

// direct descendants

class ActivateActionGhostEffectImplementor;
class ActivateActionLabelEffectImplementor;
class InsertActionArrowEffectImplementor;
class InsertActionGhostEffectImplementor;
class InsertActionLabelEffectImplementor;
class QuestionActionArrowEffectImplementor;
class RemoveActionArrowEffectImplementor;
class RemoveActionGhostEffectImplementor;
class RemoveActionLabelEffectImplementor;
class TrajectoryActionArrowEffectImplementor;
class TrajectoryActionGhostEffectImplementor;
class UseActionArrowEffectImplementor;
class UseActionGhostEffectImplementor;
class UseActionLabelEffectImplementor;

Detailed Documentation¶

Base class for classes that implement effect data for a specifc action.

Properties¶

EffectData Data

Gets or sets the effect data.

Methods¶

void CallInitialized(BaseActionData action)

Initializes the effect (Internal).

Parameters:

void CallPerformed(BaseActionData action, bool skipped)

Performs the effect (Internal).

Parameters:

void CallUndone(BaseActionData action)

Undoes the effect (Internal).

Parameters:

virtual void Initialized(BaseActionData action)

Initializes the effect.

Parameters:

virtual void Performed(BaseActionData action, bool skipped)

Performs the effect.

Parameters:

virtual void Undone(BaseActionData action)

Undoes the effect.

Parameters:

void DestroyOnPerform< T >(T target)

Destroy the following object when the action is performed.

Parameters: