CEL

Public API Reference

iCelParameterBlock Struct Reference

This interface is a parameter block that can be used to pass parameters through SendMessage() in a behaviour. More...

#include <behaviourlayer/behave.h>

Inheritance diagram for iCelParameterBlock:

List of all members.

Public Member Functions

virtual const celDataGetParameter (csStringID id) const =0
 Get parameter given an id.
virtual const celDataGetParameterByIndex (size_t idx) const =0
 Get parameter given an index.
virtual size_t GetParameterCount () const =0
 Get number of parameters.
virtual csStringID GetParameterDef (size_t idx, celDataType &t) const =0
 Get parameter with index.

Detailed Description

This interface is a parameter block that can be used to pass parameters through SendMessage() in a behaviour.

Parameter ids are constructed directly from the name with iCelPlLayer->FetchStringID().

Definition at line 38 of file behave.h.


Member Function Documentation

virtual const celData* iCelParameterBlock::GetParameter ( csStringID  id  )  const [pure virtual]

Get parameter given an id.

virtual const celData* iCelParameterBlock::GetParameterByIndex ( size_t  idx  )  const [pure virtual]

Get parameter given an index.

virtual size_t iCelParameterBlock::GetParameterCount (  )  const [pure virtual]

Get number of parameters.

virtual csStringID iCelParameterBlock::GetParameterDef ( size_t  idx,
celDataType &  t 
) const [pure virtual]

Get parameter with index.

Returns the id and sets 'type' to the appropriate value.


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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1