iCreateEntityRewardFactory Struct Reference

This interface is implemented by the createentity reward, which can create entities from entity templates. More...

#include <tools/rewards.h>

Inheritance diagram for iCreateEntityRewardFactory:

List of all members.

Public Member Functions
virtual void	AddParameter (const char *name, const char *value)=0
	Add a parameter for the template.
virtual void	SetEntityTemplateParameter (const char *entity_tpl)=0
	Set the name of the template that will be used to create a new entity from.
virtual void	SetNameParameter (const char *name)=0
	Set the name of the entity that will be created.

---

Detailed Description

This interface is implemented by the createentity reward, which can create entities from entity templates.

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

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

• template: the name of the template that will be used to create the entity from. It can be a parameter if starting with '$'.
• name: optional name for the entity that will be created. It can be a parameter if starting with '$'. Also, the following subnodes are supported:
• par: a parameter for the template. It needs 'name' and 'value' attributes. The value can be a parameter if starting with '$'. As many par nodes as needed can be used.

Definition at line 286 of file rewards.h.

---

Member Function Documentation

virtual void iCreateEntityRewardFactory::AddParameter	(	const char *	name,
		const char *	value
	)		[pure virtual]

Add a parameter for the template.

Parameters:

name	is the name for the parameter.
value	is the value for the parameter or a quest manager parameter (starts with '$').

virtual void iCreateEntityRewardFactory::SetEntityTemplateParameter

(

const char *

entity_tpl

)

[pure virtual]

Set the name of the template that will be used to create a new entity from.

Parameters:

entity_tpl

is the name of the entity template or a parameter (starts with '$').

virtual void iCreateEntityRewardFactory::SetNameParameter

(

const char *

name

)

[pure virtual]

Set the name of the entity that will be created.

Parameters:

name	is the name of the entity or a parameter (starts with '$').

---

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

• tools/rewards.h