CEL

Public API Reference

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, bool &changed)=0
 Get the value of this expression as a string.
virtual const char * Get (iCelParameterBlock *params)=0
 Get the value of this expression as a string.
virtual bool GetBool (iCelParameterBlock *params)=0
 Get the value of this expression as a bool.
virtual const celDataGetData (iCelParameterBlock *params)=0
 Get this variable as its correct datatype.
virtual float GetFloat (iCelParameterBlock *params)=0
 Get the value of this expression as a float.
virtual int32 GetLong (iCelParameterBlock *params)=0
 Get the value of this expression as a long.
virtual const char * GetOriginalExpression ()=0
 Get the original expression used to generate this parameter.
virtual celDataType GetPossibleType () const =0
 Get the possible type of this parameter.

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 46 of file parameters.h.


Member Function Documentation

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 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 bool iParameter::GetBool ( iCelParameterBlock params  )  [pure virtual]

Get the value of this expression as a bool.

Parameters:
params is an optional parameter block given to the reward.
virtual const celData* iParameter::GetData ( iCelParameterBlock params  )  [pure virtual]

Get this variable as its correct datatype.

virtual float iParameter::GetFloat ( iCelParameterBlock params  )  [pure virtual]

Get the value of this expression as a float.

Parameters:
params is an optional parameter block given to the reward.
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.
virtual const char* iParameter::GetOriginalExpression (  )  [pure virtual]

Get the original expression used to generate this parameter.

This is only valid if the parameter manager has remembering of expressions enabled. Returns 0 otherwise.

virtual celDataType iParameter::GetPossibleType (  )  const [pure virtual]

Get the possible type of this parameter.

This is not always accurate since sometimes the type of this parameter cannot be known without more context (like the params blocks that is given to 'GetXxx()'). In the case that it is not known what type it will be, CEL_DATA_NONE is returned.


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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1