CEL

Public API Reference

iNewStateQuestRewardFactory Struct Reference

This interface is implemented by the reward that switches to another state. More...

#include <tools/questmanager.h>

Inheritance diagram for iNewStateQuestRewardFactory:

List of all members.

Public Member Functions

virtual void SetClassParameter (const char *ent_class)=0
 Set the name of the entity class containing the property class on which this reward will work.
virtual void SetEntityParameter (const char *entity, const char *tag=0)=0
 Set the name of the entity containing the pcquest property class on which this reward will work.
virtual void SetStateParameter (const char *state)=0
 Set the state to go to (either a state string or a parameter if it starts with '$').
virtual void SetTagParameter (const char *tag_par)=0
 Set the tag of the property class this reward will apply to.

Detailed Description

This interface is implemented by the reward that switches to another state.

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.questreward.newstate'.

In XML, factories recognize the following attributes on the 'reward' node:

Definition at line 737 of file questmanager.h.


Member Function Documentation

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

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

Parameters:
ent_class is the name of the class or a parameter (starts with '$').
virtual void iNewStateQuestRewardFactory::SetEntityParameter ( const char *  entity,
const char *  tag = 0 
) [pure virtual]

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

Parameters:
entity is the name of the entity or a parameter (starts with '$').
tag is the optional tag of the entity or a parameter (starts with '$').
virtual void iNewStateQuestRewardFactory::SetStateParameter ( const char *  state  )  [pure virtual]

Set the state to go to (either a state string or a parameter if it starts with '$').

Parameters:
state is the name of the state or a parameter (starts with '$').
virtual void iNewStateQuestRewardFactory::SetTagParameter ( const char *  tag_par  )  [pure virtual]

Set the tag of the property class this reward will apply to.

Parameters:
ent_class is the name of the class or a parameter (starts with '$').

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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1