CEL

Public API Reference

iRewardFactory Struct Reference

A factory to create rewards. More...

#include <tools/rewards.h>

Inheritance diagram for iRewardFactory:

List of all members.

Public Member Functions

virtual csPtr< iRewardCreateReward (iQuest *q, iCelParameterBlock *params)=0
 Create a reward.
virtual iRewardTypeGetRewardType () const =0
 Get the reward type for this factory.
virtual bool Load (iDocumentNode *node)=0
 Load this factory from a document node.
virtual bool Save (iDocumentNode *node)=0
 Save this factory to a document node.

Detailed Description

A factory to create rewards.

Reward factories are created by an iRewardType instance.

Definition at line 54 of file rewards.h.


Member Function Documentation

virtual csPtr<iReward> iRewardFactory::CreateReward ( iQuest q,
iCelParameterBlock params 
) [pure virtual]

Create a reward.

Parameters:
quest is the quest for which we are creating this reward.
params are the parameters with which this reward is instantiated.
virtual iRewardType* iRewardFactory::GetRewardType (  )  const [pure virtual]

Get the reward type for this factory.

virtual bool iRewardFactory::Load ( iDocumentNode node  )  [pure virtual]

Load this factory from a document node.

Parameters:
node is the <reward> node in a reward description.
Returns:
false on error (reporter is used to report).
virtual bool iRewardFactory::Save ( iDocumentNode node  )  [pure virtual]

Save this factory to a document node.

Parameters:
node is the <reward> node in a reward description.
Returns:
false on error (reporter is used to report).

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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1