CEL

Public API Reference

iInventoryRewardFactory Struct Reference

This interface is implemented by the reward that manipulates the inventory. More...

#include <tools/rewards.h>

Inheritance diagram for iInventoryRewardFactory:

List of all members.

Public Member Functions

virtual void SetChildEntityParameter (const char *entity, const char *tag=0)=0
 Set the name of the entity that will be put in or out the inventory.
virtual void SetEntityParameter (const char *entity, const char *tag=0)=0
 Set the name of the entity containing the pcinventory property class on which this reward will work.

Detailed Description

This interface is implemented by the reward that manipulates the inventory.

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

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

Definition at line 391 of file rewards.h.


Member Function Documentation

virtual void iInventoryRewardFactory::SetChildEntityParameter ( const char *  entity,
const char *  tag = 0 
) [pure virtual]

Set the name of the entity that will be put in or out the inventory.

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

Set the name of the entity containing the pcinventory 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 '$').

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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1