====== helper_sequences.hps ======

Helper functions for creating sequences of events
----

== Sequence_Begin ==
<code c++>
void Sequence_Begin(const tString &in asFunction,
                    cSequenceStatesData &aData)
</code>
Begins to define a sequence of events. Note that the entire specified function will be run once for every sequence step.
  * **asFunction**: the name of the function that Sequence_Begin is called from. Syntax: void Func(const tString &in asSequence)
  * **aData**: object containing the state of the sequence.

----


== Sequence_End ==
<code c++>
void Sequence_End()
</code>
Ends the definition of a sequence.

----


== Sequence_Stop ==
<code c++>
void Sequence_Stop()
</code>
Stops the current sequence immediately.

----


== Sequence_DoStepAndWait ==
<code c++>
bool Sequence_DoStepAndWait(float afTime)
</code>
Use as an if statement condition to define a single step in a sequence. A step will only be run once per sequence, and delays execution of the next step by a specified time.
  * **afTime**: the time before the next step is called.

----


== Sequence_DoStepWaitAndRepeat ==
<code c++>
bool Sequence_DoStepWaitAndRepeat(int alNumOfRepetitions,
                                  float afWaitTime)
</code>


----


== Sequence_DoStepAndContinue ==
<code c++>
bool Sequence_DoStepAndContinue()
</code>
Use as an if statement condition to define a single step in a sequence. A step will only be run once per sequence. This one does not wait and just jumps to the next step

----


== Sequence_DoStepAndPause ==
<code c++>
bool Sequence_DoStepAndPause(float afTime=0)
</code>
Use as an if statement condition to define a single step in a sequence. Works similar to Sequence_DoStepAndWait, but pauses the sequence when the step has been executed. To resume, use SequenceStates_Resume("FunctionName")
  * **afTime**: the time before the next step is called after the sequence has been resumed, 0 by default.

----


== Sequence_Wait ==
<code c++>
void Sequence_Wait(float afTime)
</code>
This is just like an if statement with DoStepAndWait only it does nothing, ie if(Sequence_DoStepAndWait(x)){} Add it to just get a wait before the next step is run
  * **afTime**: the time before the next step is called after the sequence has been resumed, 0 by default.

----


== Sequence_Pause ==
<code c++>
void Sequence_Pause()
</code>
This is just like an if statement with Sequence_DoStepAndPause only it does nothing, ie if(Sequence_DoStepAndPause(x)){} Add it to just get a pause

----


== Sequence_SkipNextSteps ==
<code c++>
void Sequence_SkipNextSteps(int alStepsToSkip)
</code>
Skips a number of steps of the sequence.
  * **alStepsToSkip**: the number of steps to skip.

----


== Sequence_SkipNextStep ==
<code c++>
void Sequence_SkipNextStep()
</code>
Skips the next step of the sequence.

----


== SequenceStates_Pause ==
<code c++>
void SequenceStates_Pause(tString &in asName)
</code>


----


== SequenceStates_Resume ==
<code c++>
void SequenceStates_Resume(tString &in asName)
</code>


----


== SequenceStates_Stop ==
<code c++>
void SequenceStates_Stop(tString &in asName)
</code>


----


== SequenceStates_IsActive ==
<code c++>
bool SequenceStates_IsActive(tString &in asName)
</code>


----