HPL3/Scripting/Scripting Guide/Sequences - Revision history

TiMan at 11:23, 14 August 2020

2020-08-14T11:23:41Z

TiMan at 21:36, 13 August 2020

2020-08-13T21:36:49Z

TiMan: /* See Also */

2020-08-13T21:34:11Z

TiMan at 12:13, 13 August 2020

2020-08-13T12:13:28Z

TiMan: TiMan moved page HPL3/Scripting/Sequences to HPL3/Scripting/Scripting Guide/Sequences

2020-08-13T11:56:56Z

TiMan moved page HPL3/Scripting/Sequences to HPL3/Scripting/Scripting Guide/Sequences

TiMan: /* Workflow */

2020-08-12T13:54:43Z

Workflow

TiMan at 13:54, 12 August 2020

2020-08-12T13:54:05Z

TiMan at 13:51, 12 August 2020

2020-08-12T13:51:49Z

TiMan at 13:51, 12 August 2020

2020-08-12T13:51:13Z

TiMan at 13:49, 12 August 2020

2020-08-12T13:49:47Z

@@ Line 1: / Line 1: @@
 {{Hpl3ScriptingGuideMenuBasic}}
 {{shortPageTitle}}
+{| style="border:0px;" cellspacing="0"
 Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.
@@ Line 48: / Line 50: @@
      SequenceStates_Resume("Sequence_Alert");
+}
-</syntaxhighlight>As you can see, <code>Sequence_DoStepAndPause()</code> in there actually pauses the whole sequence until some external event - in this case the callback from the voice playing code - calls <code>SequenceStates_Resume()</code> and asks it to continue.
+</syntaxhighlight>
 To start the sequence, you just call the sequence function once with an empty argument when you want it to trigger:<syntaxhighlight lang="c++">

← Older revision		Revision as of 21:36, 13 August 2020
Line 2:		Line 2:
	{{shortPageTitle}}		{{shortPageTitle}}

−	~~== Introduction ==~~
	Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.		Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.

@@ Line 59: / Line 59: @@
 ==See Also==
-*[[HPL3/Scripting/Sequences_Helper|Sequences Helper]]
+*[[HPL3/SOMA/Scripting/Sequences Helper|Sequences Helper]] - SOMA
+*[[HPL3/Amnesia: Rebirth/Scripting/Sequences Helper|Sequences Helper]] - Amnesia: Rebirth
 {{NavBar|HPL3/Scripting/Scripting_Guide/Timers|Timers|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Local and Global Variables|Local and Global Variables}}

@@ Line 62: / Line 62: @@
-{{NavBar|HPL3/Scripting/Timers|Timers|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Local and Global Variables|Local and Global Variables}}
+{{NavBar|HPL3/Scripting/Scripting_Guide/Timers|Timers|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Local and Global Variables|Local and Global Variables}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 15: / Line 15: @@
 Then you create a sequence function. This will be repeatedly called until the whole sequence is over. It looks something like this:<syntaxhighlight lang="c++">
 void Sequence_Alert(const tString& in asName)
+{

@@ Line 2: / Line 2: @@
 {{shortPageTitle}}
-== Workflow ==
+== Introduction ==
 Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.
@@ Line 9: / Line 9: @@
 They are very useful when we need to handle a big amount of timers that should occur one after another - or in other words - a sequence.
 For each sequence you need a map property to store the state - a cSequenceStatesData property:

← Older revision		Revision as of 13:51, 12 August 2020
Line 2:		Line 2:
	{{shortPageTitle}}		{{shortPageTitle}}

		+	== Workflow ==
	Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.		Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.

@@ Line 3: / Line 3: @@
 {{shortPageTitle}}
-Many of the events that happen throughout Rebirth are triggered sequences - a sound plays, then the player's FoV changes, then a light starts flashing etc. etc.
+Many of the events that happen inside map script files are triggered sequences. For example: A sound plays, then the player's FoV changes, then a light starts flashing, etc.
 We control all of those through a set of wrappers we call Sequences, which hide a bunch of timers away and make things easier to read.
@@ Line 11: / Line 11: @@
 For each sequence you need a map property to store the state - a cSequenceStatesData property e.g.
-*shows viewer*
+<pre>cSequenceStatesData mSequenceAlert;</pre>
 Then you create a sequence function. This will be repeatedly called until the whole sequence is over. It looks something like this:
@@ Line 17: / Line 17: @@
 *shows sequence example*
-As you can see, Sequence_DoStepAndPause() in there actually pauses the whole sequence until some external event - in this case the callback from the voice playing code - calls SequenceStates_Resume() and asks it to continue.
+As you can see, <code>Sequence_DoStepAndPause()</code> in there actually pauses the whole sequence until some external event - in this case the callback from the voice playing code - calls <code>SequenceStates_Resume()</code> and asks it to continue.
-To start the sequence, you just call the sequence function once with an empty argument when you want it to trigger e.g.
+To start the sequence, you just call the sequence function once with an empty argument when you want it to trigger:
 No need to call it every frame or anything! Once started, timers will automatically make sure that the sequence steps get followed when they need to be.
-Since sequences are totally independent of each other, you could run  multiple sequences in parallel, but it can get very confusing, so I wouldn’t recommend it.
+{{tip|Since sequences are totally independent of each other, you could run multiple sequences in parallel.}}