This is not directly related to the real current time. Suspending the sequence manager will also freeze this time. Note that the sequence manager updates the main time AFTER rendering frames. So if you want to get the real main time you should add the delta returned by GetDeltaTime() too. However from within operation callbacks you should just use GetMainTime() in combination with the supplied delta.

This will effectively put the sequence on the queue to be executed when the time has elapsed. Modifications on a sequence after it has been added have no effect. You can also remove the sequence (with DecRef()) immediatelly after running it.

The optional params instance will be given to all operations that are added on the main sequence. Ref counting is used to keep track of this object. So you can safely DecRef() your own reference after calling RunSequence.

Parameters:

time

Time at which the sequence should be executed.

sequence

Sequence to execute.

params

Optional instance given to all operations added to the main sequence.

sequence_id

This identifier can be used to get track of a given sequence. You can use this id to remove all operations that have this id.

virtual void iSequenceManager::Suspend

(

)

[pure virtual]

Suspend the sequence manager.

This will totally stop all actions that the sequence manager was doing. Use Resume() to resume. Calling Suspend() on an already suspended sequence manager has no effect. Note that a sequence manager is suspended by default. This is so you can set it up and add the needed operations and then call resume to start it all.

This will effectively let the sequence manager think that the given time has passed. If the 'skip' flag is set then all sequence parts that would have been executed in the skipped time are not executed. Otherwise they will all be executed at the same time (but the delta time parameter to 'Do' and 'Condition' will contain the correct difference). 'time' is usually positive. When 'time' is negative this will have the effect of adding extra time before the first operation in the queue will be executed. i.e. we jump in the past but operations that used to be there before are already deleted and will not be executed again.

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