iCelSequence Struct Reference
A sequence. More...
Public Member Functions
|virtual void||Abort ()=0|
|Abort this sequence. |
|virtual void||Activate ()=0|
|Activate this sequence. |
|virtual void||AddSequenceCallback (iCelSequenceCallback *cb)=0|
|Register a callback that is fired when this sequence finishes. |
|virtual void||Deactivate ()=0|
|Deactivate this sequence. |
|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 void||RemoveSequenceCallback (iCelSequenceCallback *cb)=0|
|Remove a callback. |
|virtual bool||Start (csTicks delay, iCelParameterBlock *params)=0|
|Fire this sequence. |
Member Function Documentation
|virtual void iCelSequence::Abort||(||)||
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::Activate||(||)||
Activate this sequence.
|virtual void iCelSequence::AddSequenceCallback||(||iCelSequenceCallback *||cb||)||
Register a callback that is fired when this sequence finishes.
|virtual void iCelSequence::Deactivate||(||)||
Deactivate this sequence.
|virtual void iCelSequence::Finish||(||)||
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
Get the name of this sequence.
|virtual bool iCelSequence::IsRunning||(||)||
Return true if this sequence is currently running.
|virtual void iCelSequence::RemoveSequenceCallback||(||iCelSequenceCallback *||cb||)||
Remove a callback.
Fire this sequence.
delay is a delay before the sequence will really start.
- 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.1 by doxygen 1.6.1