Difference between revisions of "HPL3/Scripting/Scripting Guide/Timers"

From Frictional Wiki
Jump to navigation Jump to search
(Created page with "{{wip}} {{Hpl3ScriptingGuideMenuBasic}} {{shortPageTitle}} Timers are set up to wait for a selected amount of time before executing code. It can be very useful if you want to...")
 
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{wip}}
 
 
{{Hpl3ScriptingGuideMenuBasic}}
 
{{Hpl3ScriptingGuideMenuBasic}}
 
{{shortPageTitle}}
 
{{shortPageTitle}}
 +
{| style="border:0px;" cellspacing="0"
 +
|- valign="top"
 +
| style="padding-right:0.2em" |
 +
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.
  
−
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==
 +
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++">
 +
////////////////////////////
 +
// Run first time starting map
 +
void OnStart()
 +
{
 +
Map_AddTimer("JumpVeryHigh", 5.0f, "Timer_JumpVeryHigh");
 +
}
 +
 
 +
//...somewhere else in the code
  
−
In order to add timer to a map, we need to use Map_AddTimer
+
void Timer_JumpVeryHigh(const tString&in asTimer)
 +
{
 +
MyHelper_MakeThePlayerJumpVeryHigh();
 +
}
 +
</syntaxhighlight>
 +
| style="width:0.1%" |
 +
|}
 +
===Breakdown===
  
−
*explains parameters*
+
*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>.
 +
*Inside the timer callback, we use our helper function which makes the player jump very high.
  
−
Let’s see an example
+
If you will execute this code, the player will jump very high after five seconds once the map has been loaded.
  
−
*shows an example*
+
{{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.}}
  
−
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.
+
Timers are very easy to use as you can see, and it will help us to understand the concept of Sequences in next chapter.
  
−
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/SOMA/Scripting/Map Helper|Map Helper]] - SOMA
−
* [[HPL3/Scripting/Map Helper|Map Helper]]
+
*[[HPL3/Amnesia: Rebirth/Scripting/Map Helper|Map Helper]] - Amnesia: Rebirth
  
−
{{NavBar|HPL3/Scripting/The Update method|The Update method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Timers|Timers}}
+
{{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:HPL3 Scripting]]
 
[[Category:English]]
 
[[Category:English]]

Latest revision as of 11:52, 14 August 2020

  1. The Basics - Introduction
  2. What is scripting in HPL3?
  3. Setting up CodeLite - Scripting Tool
  4. Scripting Workflow and Structure
  5. Hello World
  6. Calling Functions and Function Callbacks
  7. Helper Files
  8. The OnAction method
  9. The Update method
  10. Timers
  11. Sequences
  12. Local and Global Variables
  13. Enums
  14. Conclusion

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

In order to add timer to a map, we need to use the function Map_AddTimer. Let's see an example:
////////////////////////////
// Run first time starting map
void OnStart()
{
	Map_AddTimer("JumpVeryHigh", 5.0f, "Timer_JumpVeryHigh");
}

//...somewhere else in the code

void Timer_JumpVeryHigh(const tString&in asTimer)
{
	MyHelper_MakeThePlayerJumpVeryHigh();
}

Breakdown

  • We called the function and gave it three arguments: The internal name of the timer (JumpVeryHigh), the time in seconds (5) of the timer, and the function callback which will be called once the timer is done (Timer_JumpVeryHigh).
  • 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.
  • Inside the timer callback, we use our helper function which makes the player jump very high.

If you will execute this code, the player will jump very high after five seconds once the map has been loaded.

Note icon.png 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.

Timers are very easy to use as you can see, and it will help us to understand the concept of Sequences in next chapter.

See Also

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Scripting/Scripting_Guide/Timers&oldid=4320"