CEL

Public API Reference

iCelSequence Struct Reference

A sequence. More...

#include <tools/sequences.h>

Inheritance diagram for iCelSequence:

List of all members.

Public Member Functions

virtual void Abort ()=0
 Abort this sequence.
virtual void AddSequenceCallback (iCelSequenceCallback *cb)=0
 Register a callback that is fired when this sequence finishes.
virtual void Finish ()=0
 Finish this sequence.
virtual const char * GetName () const =0
 Get the name of this sequence.
virtual bool IsRunning ()=0
 Return true if this sequence is currently running.
virtual bool LoadState (iCelDataBuffer *databuf)=0
 Load state of this sequence.
virtual void RemoveSequenceCallback (iCelSequenceCallback *cb)=0
 Remove a callback.
virtual void SaveState (iCelDataBuffer *databuf)=0
 Save state of this sequence.
virtual bool Start (csTicks delay, iCelParameterBlock *params)=0
 Fire this sequence.

Detailed Description

A sequence.

Definition at line 127 of file sequences.h.


Member Function Documentation

virtual void iCelSequence::Abort (  )  [pure virtual]

Abort this sequence.

This will simply abort the sequence without doing any further operation. This can leave the objects on which this sequence operates in undefined states.

virtual void iCelSequence::AddSequenceCallback ( iCelSequenceCallback cb  )  [pure virtual]

Register a callback that is fired when this sequence finishes.

virtual void iCelSequence::Finish (  )  [pure virtual]

Finish this sequence.

The sequence will be executed at end condition which means that all operations that have not yet fully executed will be executed at relative time index '1'. So the end result will be as if the sequence completed normally.

virtual const char* iCelSequence::GetName (  )  const [pure virtual]

Get the name of this sequence.

virtual bool iCelSequence::IsRunning (  )  [pure virtual]

Return true if this sequence is currently running.

virtual bool iCelSequence::LoadState ( iCelDataBuffer databuf  )  [pure virtual]

Load state of this sequence.

virtual void iCelSequence::RemoveSequenceCallback ( iCelSequenceCallback cb  )  [pure virtual]

Remove a callback.

virtual void iCelSequence::SaveState ( iCelDataBuffer databuf  )  [pure virtual]

Save state of this sequence.

virtual bool iCelSequence::Start ( csTicks  delay,
iCelParameterBlock params 
) [pure virtual]

Fire this sequence.

Parameters:
delay is a delay before the sequence will really start.
Returns:
false if the sequence is already running.

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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1