iParameter Struct Reference

This interface represents a parameter to a sequence, trigger, or reward. More...

#include <tools/parameters.h>

Inheritance diagram for iParameter:

List of all members.

Public Member Functions
virtual const char *	Get (iCelParameterBlock *params)=0
	Get the value of this expression as a string.
virtual const char *	Get (iCelParameterBlock *params, bool &changed)=0
	Get the value of this expression as a string.
virtual const celData *	GetData (iCelParameterBlock *params)=0
	Get this variable as its correct datatype.
virtual int32	GetLong (iCelParameterBlock *params)=0
	Get the value of this expression as a long.

---

Detailed Description

This interface represents a parameter to a sequence, trigger, or reward.

The paramater plugin provides different types of parameters (constant, static parameters ($notation), dynamic parameters (), or expressions (=notation). This interface makes abstraction of those.

Definition at line 60 of file parameters.h.

---

Member Function Documentation

virtual const char* iParameter::Get

(

iCelParameterBlock *

params

)

[pure virtual]

Get the value of this expression as a string.

Parameters:

params

is an optional parameter block given to the reward.

virtual const char* iParameter::Get	(	iCelParameterBlock *	params,
		bool &	changed
	)		[pure virtual]

Get the value of this expression as a string.

Parameters:

params	is an optional parameter block given to the reward.
changed	is set to true if the returned value is different from the last time Get() was called. Note! This doesn't work if you call the Get() with only one parameter above!

virtual const celData* iParameter::GetData

(

iCelParameterBlock *

params

)

[pure virtual]

Get this variable as its correct datatype.

virtual int32 iParameter::GetLong

(

iCelParameterBlock *

params

)

[pure virtual]

Get the value of this expression as a long.

Parameters:

params

is an optional parameter block given to the reward.

---

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

• tools/parameters.h