CEL

Public API Reference

iSeqOp Struct Reference

This is a sequence operation. More...

#include <tools/sequences.h>

Inheritance diagram for iSeqOp:

List of all members.

Public Member Functions

virtual void Do (float time, iCelParameterBlock *params)=0
 Do the operation.
virtual void Init (iCelParameterBlock *params)=0
 Init the operation.
virtual bool Load (iCelDataBuffer *databuf)=0
 Load the sequence operation from persisted data.
virtual void Save (iCelDataBuffer *databuf)=0
 Save the sequence operation to persisted data.

Detailed Description

This is a sequence operation.

A sequence operation represents an operation that has a duration or an operation that is a single-shot. You can combine different sequence operations in a sequence and then use a reward to fire of the sequence as result of a trigger.

Definition at line 37 of file sequences.h.


Member Function Documentation

virtual void iSeqOp::Do ( float  time,
iCelParameterBlock params 
) [pure virtual]

Do the operation.

The parameter is a value between 0 and 1 which will be interpolated over a specified time (specified in the sequence). In case this is a single-shot operation the value will always be 1.

virtual void iSeqOp::Init ( iCelParameterBlock params  )  [pure virtual]

Init the operation.

This is called before the operation is actually performed the first time. This function is not called in case the operation is loaded from persisted data. In that case Load() is called instead.

virtual bool iSeqOp::Load ( iCelDataBuffer databuf  )  [pure virtual]

Load the sequence operation from persisted data.

virtual void iSeqOp::Save ( iCelDataBuffer databuf  )  [pure virtual]

Save the sequence operation to persisted data.


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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1