HPL3/Scripting/Scripting Guide/Timers - Revision history

TiMan at 10:52, 14 August 2020

2020-08-14T10:52:48Z

TiMan: /* See Also */

2020-08-13T21:35:29Z

TiMan: /* See Also */

2020-08-13T21:35:24Z

TiMan at 21:30, 13 August 2020

2020-08-13T21:30:11Z

TiMan: /* Creating Timers */

2020-08-13T21:20:32Z

Creating Timers

TiMan: /* Creating Timers */

2020-08-13T21:18:48Z

Creating Timers

TiMan at 21:13, 13 August 2020

2020-08-13T21:13:32Z

TiMan at 20:57, 13 August 2020

2020-08-13T20:57:35Z

TiMan at 12:13, 13 August 2020

2020-08-13T12:13:55Z

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

2020-08-13T11:56:46Z

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

@@ Line 1: / Line 1: @@
 {{Hpl3ScriptingGuideMenuBasic}}
 {{shortPageTitle}}
+{| style="border:0px;" cellspacing="0"
 Timers are set up to wait for a selected amount of time before executing code. It can be very useful if you want to wait a specified amount of time for something to happen in the level, such as intense countdown or to spawn / despawn particles in a dynamic way.
@@ Line 20: / Line 22: @@
+}
 </syntaxhighlight>
+| style="width:0.1%" |
 ===Breakdown===

@@ Line 37: / Line 37: @@
 *[[HPL3/SOMA/Scripting/Map Helper|Map Helper]] - SOMA
 *[[HPL3/Amnesia: Rebirth/Scripting/Map Helper|Map Helper]] - Amnesia: Rebirth
 {{NavBar|HPL3/Scripting/Scripting_Guide/The Update method|The Update method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Sequences|Sequences}}

@@ Line 35: / Line 35: @@
 ==See Also==
-*[[HPL3/Scripting/Map Helper|Map Helper]] - SOMA
+*[[HPL3/SOMA/Scripting/Map Helper|Map Helper]] - SOMA
 {{NavBar|HPL3/Scripting/Scripting_Guide/The Update method|The Update method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Sequences|Sequences}}

@@ Line 23: / Line 23: @@
 ===Breakdown===
-* We called the function and gave it three arguments: The internal name of the timer (<code>JumpVeryHigh</code>), the time in seconds (<code>5</code>) of the timer, and the function callback which will be called once the timer is done (<code>Timer_JumpVeryHigh</code>).
+*We called the function and gave it three arguments: The internal name of the timer (<code>JumpVeryHigh</code>), the time in seconds (<code>5</code>) of the timer, and the function callback which will be called once the timer is done (<code>Timer_JumpVeryHigh</code>).
-* Our timer callback is called <code>Timer_JumpVeryHigh</code> and has one parameter called <code>asTimer</code> - this is the internal name of the timer. In our case, the internal name will be <code>JumpVeryHigh</code>.
+*Our timer callback is called <code>Timer_JumpVeryHigh</code> and has one parameter called <code>asTimer</code> - this is the internal name of the timer. In our case, the internal name will be <code>JumpVeryHigh</code>.
-We can do more than just create a timer, we can remove timers as well, or check if a timer is already running. For example, if we enter this area, create a timer of 5 seconds. However, if a timer has already been created, we don’t need to create that timer again, right? So we can use Map_TimerExists for that.
+If you will execute this code, the player will jump very high after five seconds once the map has been loaded.
-Timers are very easy to use as you can see, and it will help us to understand the concept of Sequences in the next episode.
+{{Note|You can have much more controls on timers than what was explained here. For a list of the full functions, check the Map Helper page of SOMA or Amnesia: Rebirth.}}
 ==See Also==
-*[[HPL3/Scripting/Map Helper|Map Helper]]
+*[[HPL3/Scripting/Map Helper|Map Helper]] - SOMA
 {{NavBar|HPL3/Scripting/Scripting_Guide/The Update method|The Update method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Sequences|Sequences}}

@@ Line 23: / Line 23: @@
 ===Breakdown===
-* We called the function and gave it three arguments: The internal name of the timer, the time (in seconds) of the timer, and the function callback which will be called once the timer is done.
+* We called the function and gave it three arguments: The internal name of the timer (<code>JumpVeryHigh</code>), the time in seconds (<code>5</code>) of the timer, and the function callback which will be called once the timer is done (<code>Timer_JumpVeryHigh</code>).
-* Our timer callback is called "Timer_JumpVeryHigh" and has one parameter called asTimer - this is the internal name of the timer. In our case, the internal name will be "JumpVeryHigh".
+* Our timer callback is called <code>Timer_JumpVeryHigh</code> and has one parameter called <code>asTimer</code> - this is the internal name of the timer. In our case, the internal name will be <code>JumpVeryHigh</code>.
 We can do more than just create a timer, we can remove timers as well, or check if a timer is already running. For example, if we enter this area, create a timer of 5 seconds. However, if a timer has already been created, we don’t need to create that timer again, right? So we can use Map_TimerExists for that.

@@ Line 4: / Line 4: @@
 Timers are set up to wait for a selected amount of time before executing code. It can be very useful if you want to wait a specified amount of time for something to happen in the level, such as intense countdown or to spawn / despawn particles in a dynamic way.
-== Creating Timers ==
+==Creating Timers==
-In order to add timer to a map, we need to use <code>Map_AddTimer</code>. Let's see an example:
+In order to add timer to a map, we need to use the function <code>Map_AddTimer</code>. Let's see an example:<syntaxhighlight lang="c++">
+//...somewhere else in the code
 We can do more than just create a timer, we can remove timers as well, or check if a timer is already running. For example, if we enter this area, create a timer of 5 seconds. However, if a timer has already been created, we don’t need to create that timer again, right? So we can use Map_TimerExists for that.
@@ Line 13: / Line 30: @@
 Timers are very easy to use as you can see, and it will help us to understand the concept of Sequences in the next episode.
-== See Also ==
+==See Also==
 * [[HPL3/Scripting/Map Helper|Map Helper]]
 {{NavBar|HPL3/Scripting/Scripting_Guide/The Update method|The Update method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Sequences|Sequences}}

@@ Line 20: / Line 20: @@
 * [[HPL3/Scripting/Map Helper|Map Helper]]
-{{NavBar|HPL3/Scripting/Scripting_Guide/Trigger Areas|Trigger Areas|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Sequences|Sequences}}
+{{NavBar|HPL3/Scripting/Scripting_Guide/The Update method|The Update method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Sequences|Sequences}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

← Older revision	Revision as of 11:56, 13 August 2020
(No difference)