Maintenance script: Upload from wiki

2020-07-09T13:46:53Z

Upload from wiki

New page

= helper_sequences.hps =

Helper functions for creating sequences of events
----

===== Sequence_Begin =====
<syntaxhighlight lang="c++">
void Sequence_Begin(const tString &in asFunction,
cSequenceStatesData &aData)
</syntaxhighlight>
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 =====
<syntaxhighlight lang="c++">
void Sequence_End()
</syntaxhighlight>
Ends the definition of a sequence.

----

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

----

===== Sequence_DoStepAndWait =====
<syntaxhighlight lang="c++">
bool Sequence_DoStepAndWait(float afTime)
</syntaxhighlight>
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 =====
<syntaxhighlight lang="c++">
bool Sequence_DoStepWaitAndRepeat(int alNumOfRepetitions,
float afWaitTime)
</syntaxhighlight>

----

===== Sequence_DoStepAndContinue =====
<syntaxhighlight lang="c++">
bool Sequence_DoStepAndContinue()
</syntaxhighlight>
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 =====
<syntaxhighlight lang="c++">
bool Sequence_DoStepAndPause(float afTime=0)
</syntaxhighlight>
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 =====
<syntaxhighlight lang="c++">
void Sequence_Wait(float afTime)
</syntaxhighlight>
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 =====
<syntaxhighlight lang="c++">
void Sequence_Pause()
</syntaxhighlight>
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 =====
<syntaxhighlight lang="c++">
void Sequence_SkipNextSteps(int alStepsToSkip)
</syntaxhighlight>
Skips a number of steps of the sequence.
* '''alStepsToSkip''': the number of steps to skip.

----

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

----

===== SequenceStates_Pause =====
<syntaxhighlight lang="c++">
void SequenceStates_Pause(tString &in asName)
</syntaxhighlight>

----

===== SequenceStates_Resume =====
<syntaxhighlight lang="c++">
void SequenceStates_Resume(tString &in asName)
</syntaxhighlight>

----

===== SequenceStates_Stop =====
<syntaxhighlight lang="c++">
void SequenceStates_Stop(tString &in asName)
</syntaxhighlight>

----

===== SequenceStates_IsActive =====
<syntaxhighlight lang="c++">
bool SequenceStates_IsActive(tString &in asName)
</syntaxhighlight>

----

Hpl3:Game:scripting:function reference:helper sequences - Revision history

Maintenance script: Upload from wiki