iParameterManager Struct Reference

This interface provides a generic functions for the evaluation of any type of parameter (constant, dynamic, or expression). More...

#include <tools/parameters.h>

Inheritance diagram for iParameterManager:

[legend]

List of all members.

Public Member Functions
virtual bool	FillParameterBlock (iCelParameterBlock *params, celVariableParameterBlock *act_params, const csArray< celParSpec > &parameters, const csRefArray< iParameter > &quest_parameters)=0
	Fill in the dynamic parameters in a parameter block.
virtual csPtr< iParameter >	GetParameter (const celParams &params, const char *param)=0
	Get a parameter that can be evalulated later on an as-needed basis.
virtual csPtr < celVariableParameterBlock >	GetParameterBlock (const celParams &params, const csArray< celParSpec > &parameters, csRefArray< iParameter > &quest_parameters)=0
	This is a convenience function to get a parameter block during creation of rewards, triggers, and sequence operations.
virtual const char *	ResolveParameter (const celParams &params, const char *param)=0
	This is a convenience function to resolve a quest parameter during creation of rewards, triggers, and sequence operations.

---

Detailed Description

This interface provides a generic functions for the evaluation of any type of parameter (constant, dynamic, or expression).

Definition at line 101 of file parameters.h.

---

Member Function Documentation

virtual bool iParameterManager::FillParameterBlock	(	iCelParameterBlock *	params,
		celVariableParameterBlock *	act_params,
		const csArray< celParSpec > &	parameters,
		const csRefArray< iParameter > &	quest_parameters
	)			[pure virtual]

Fill in the dynamic parameters in a parameter block.

Return whether or not the filling has been made.

Parameters:

	params	is the parameter block given to the reward.
	msg_params	is the resolved parameter block as returned by GetParameterBlock().
	parameters	is the parameter specifications and unparsed values.
	quest_parameters	is an array with quest parameters.

virtual csPtr<iParameter> iParameterManager::GetParameter	(	const celParams &	params,
		const char *	param
	)			[pure virtual]

Get a parameter that can be evalulated later on an as-needed basis.

Returns 0 for an illegal parameter (error reporting has been done).

virtual csPtr<celVariableParameterBlock> iParameterManager::GetParameterBlock	(	const celParams &	params,
		const csArray< celParSpec > &	parameters,
		csRefArray< iParameter > &	quest_parameters
	)			[pure virtual]

This is a convenience function to get a parameter block during creation of rewards, triggers, and sequence operations.

This routine knows how to recognize parameter usage (starting with '$' or '@') and will in that case try to resolve the parameter by finding it in 'params'.

Parameters:

	params	is the quest parameters.
	paramspec	is the parameter specifications and unparsed values.
	quest_parameters	is an array that should have the same length as the 'paramspec' array. It will be filled with the parameters.

virtual const char* iParameterManager::ResolveParameter	(	const celParams &	params,
		const char *	param
	)			[pure virtual]

This is a convenience function to resolve a quest parameter during creation of rewards, triggers, and sequence operations.

This routine knows how to recognize parameter usage (starting with '$') and will in that case try to resolve the parameter by finding it in 'params'. Otherwise it will just return the unmodified string. This version doesn't support dynamic parameters.

---

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

• tools/parameters.h