CEL

Public API Reference

iChangeClassRewardFactory Struct Reference

This interface is implemented by the changeclass reward, which can add or remove a class from an entity. More...

#include <tools/rewards.h>

Inheritance diagram for iChangeClassRewardFactory:

List of all members.

Public Member Functions

virtual void SetClassParameter (const char *ent_class)=0
 Set the name of the entity class on which this reward will work.
virtual void SetEntitiesParameter (const char *entities)=0
 Set the list of entities.
virtual void SetEntityParameter (const char *entity)=0
 Set the name of the entity.
virtual void SetRemove (bool r)=0
 Set the 'remove' flag.

Detailed Description

This interface is implemented by the changeclass reward, which can add or remove a class from an entity.

You can query this interface from the reward factory if you want to manually control this factory as opposed to loading its definition from an XML document.

The predefined name of this reward type is 'cel.rewards.changeclass'.

In XML, factories recognize the following attribute on the 'op' node:

Definition at line 321 of file rewards.h.


Member Function Documentation

virtual void iChangeClassRewardFactory::SetClassParameter ( const char *  ent_class  )  [pure virtual]

Set the name of the entity class on which this reward will work.

Parameters:
ent_class is the name of the class or a parameter (starts with '$').
virtual void iChangeClassRewardFactory::SetEntitiesParameter ( const char *  entities  )  [pure virtual]

Set the list of entities.

Parameters:
entities is the list of entities or a parameter (starts with '$').
virtual void iChangeClassRewardFactory::SetEntityParameter ( const char *  entity  )  [pure virtual]

Set the name of the entity.

Parameters:
entity is the name of the entity or a parameter (starts with '$').
virtual void iChangeClassRewardFactory::SetRemove ( bool  r  )  [pure virtual]

Set the 'remove' flag.


The documentation for this struct was generated from the following file:

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1