CEL

Public API Reference

iActionQuestRewardFactory Struct Reference

This interface is implemented by the reward that sends an action to some entity or entity class property class with an optional tag. More...

#include <tools/questmanager.h>

Inheritance diagram for iActionQuestRewardFactory:

List of all members.

Public Member Functions

virtual void AddParameter (celDataType type, csStringID id, const char *name, const char *value)=0
 Add a parameter to send with the action.
virtual void SetClassParameter (const char *ent_class)=0
 Set the name of the entity class on which this reward will work.
virtual void SetEntityParameter (const char *entity)=0
 Set the name of the entity.
virtual void SetIDParameter (const char *id)=0
 Set the action name (without the cel.action part).
virtual void SetPropertyClassParameter (const char *propertyclass)=0
 Set the name of the property class.
virtual void SetTagParameter (const char *tag)=0
 Set the tag for the propertyclass.


Detailed Description

This interface is implemented by the reward that sends an action to some entity or entity class property class with an optional tag.

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.action'.

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

Definition at line 1910 of file questmanager.h.


Member Function Documentation

virtual void iActionQuestRewardFactory::AddParameter ( celDataType  type,
csStringID  id,
const char *  name,
const char *  value 
) [pure virtual]

Add a parameter to send with the action.

Parameters:
type is one of CEL_DATA_STRING, CEL_DATA_FLOAT, CEL_DATA_LONG, CEL_DATA_BOOL, or CEL_DATA_VECTOR3.
id is the id of the parameter (calculated from the string "cel.parameter." appended with the name).
name is the name of the parameter.
value is the value string or a parameter for it (starts with '$').

virtual void iActionQuestRewardFactory::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 iActionQuestRewardFactory::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 iActionQuestRewardFactory::SetIDParameter ( const char *  id  )  [pure virtual]

Set the action name (without the cel.action part).

Parameters:
id is the action name or a parameter (starts with '$').

virtual void iActionQuestRewardFactory::SetPropertyClassParameter ( const char *  propertyclass  )  [pure virtual]

Set the name of the property class.

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

virtual void iActionQuestRewardFactory::SetTagParameter ( const char *  tag  )  [pure virtual]

Set the tag for the propertyclass.

Parameters:
tag is the tag for the propertyclass or a parameter (starts with '$').


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

Generated for CEL: Crystal Entity Layer 1.4.0 by doxygen 1.5.8