HPL3/Scripting/Scripting Guide/Calling Functions and Function Callbacks - Revision history

TiMan: /* Functions */

2020-08-16T08:52:03Z

Functions

TiMan at 12:16, 13 August 2020

2020-08-13T12:16:28Z

TiMan: TiMan moved page HPL3/Scripting/Calling Functions and Function Callbacks to HPL3/Scripting/Scripting Guide/Calling Functions and Function Callbacks

2020-08-13T11:49:35Z

TiMan moved page HPL3/Scripting/Calling Functions and Function Callbacks to HPL3/Scripting/Scripting Guide/Calling Functions and Function Callbacks

TiMan at 20:50, 10 August 2020

2020-08-10T20:50:12Z

TiMan at 20:34, 10 August 2020

2020-08-10T20:34:25Z

TiMan at 20:33, 10 August 2020

2020-08-10T20:33:20Z

TiMan: /* Function Callbacks */

2020-08-10T19:40:24Z

Function Callbacks

TiMan at 19:38, 10 August 2020

2020-08-10T19:38:58Z

TiMan at 19:36, 10 August 2020

2020-08-10T19:36:07Z

TiMan at 13:57, 10 August 2020

2020-08-10T13:57:27Z

@@ Line 9: / Line 9: @@
 If we want to make the game do something in our script, we need to call a specific function that does what we want.
-{{todo|main article -> angelscript tutorial}}
+''Main article: [[HPL3/Scripting/AngelScript Fundamentals/Chapter 6 - Functions|AngelScript - Functions]]''
 For example, if we want to make the game do something related to the player, we will type <code>Player_</code>, and then all of the relevant functions for the player can be displayed, with an explanation of what each function does.

@@ Line 40: / Line 40: @@
 | style="width:0.1%" |
 |}
-{{NavBar|HPL3/Scripting/Hello World|Hello World|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Helper Files|Helper Files}}
+{{NavBar|HPL3/Scripting/Scripting_Guide/Hello World|Hello World|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Helper Files|Helper Files}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 4: / Line 4: @@
 |- valign="top"
 | style="padding-right:0.2em" |
-Now that we learned how to write our very first piece of code, we can look into calling functions and function callbacks.<br>If we want to make the game do something in our script, we need to call a specific function that does what we want.
+Now that we learned how to write our very first piece of code, we can look into calling functions and function callbacks.
-For example, if we want to make the game do something related to the player, we will type <code>Player_</code> , and then all of the relevant functions for the player can be displayed, with an explanation of what each function does.
+==Functions==
 ==Function Callbacks==
@@ Line 12: / Line 18: @@
 Function callbacks are used a lot in scripting and they take a big part of our map script file.
-Simply put, '''a callback function is just a function which is supposed to be, at some later point, called by some other piece of code, when some event of interest happens.''' It is used a lot when calling game script functions.
+Simply put, '''a callback function is just an existing function which is supposed to be, at some later point, called by some other piece of code, when some event of interest happens.''' It is used a lot when calling game script functions.
 For example, the function <code>Player_SetFlashlightOnOffCallback</code>, is a function which requires to give a name for a callback function, which will be called when the flashlight is turned on or off.In other words, when the player turns the flashlight or on off, a callback function will be called and perform the code inside it.

@@ Line 1: / Line 1: @@
 {{Hpl3ScriptingGuideMenuBasic}}
 {{shortPageTitle}}
 Now that we learned how to write our very first piece of code, we can look into calling functions and function callbacks.<br>If we want to make the game do something in our script, we need to call a specific function that does what we want.
@@ Line 29: / Line 32: @@
 </syntaxhighlight>
 [[File:Callback-test-hpl3-soma.gif|left|thumb|The above code in action. The flashlight turns the light on / off via callback.]]
 {{NavBar|HPL3/Scripting/Hello World|Hello World|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Helper Files|Helper Files}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 27: / Line 27: @@
+}
-</syntaxhighlight>{{NavBar|HPL3/Scripting/Hello World|Hello World|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Helper Files|Helper Files}}
+</syntaxhighlight>
 [[Category:HPL3 Scripting]]
 [[Category:English]]

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

@@ Line 11: / Line 11: @@
 Simply put, '''a callback function is just a function which is supposed to be, at some later point, called by some other piece of code, when some event of interest happens.''' It is used a lot when calling game script functions.
-For example, the function <code>Player_SetFlashlightOnOffCallback</code>, is a function which requires to give a name for a callback function, which will be called when the flashlight is turned on or off.
+For example, the function <code>Player_SetFlashlightOnOffCallback</code>, is a function which requires to give a name for a callback function, which will be called when the flashlight is turned on or off.In other words, when the player turns the flashlight or on off, a callback function will be called and perform the code inside it.
-In other words, when the player turns the flashlight or on off, a callback function will be called and perform the code inside it.In the following example, the point light "PointLight_4" will be visibile or not, depending if the player's flashlight is lit or not. The function OnFlashlightOnOff is called whenever we turn the flashlight on or off. This is OnFlashlightOnOff  is our '''callback''' '''function''', which is defined in '''OnStart'''.<syntaxhighlight lang="c++">
+In the following example, the point light <code>PointLight_4</code> will be visibile or not, depending if the player's flashlight is lit or not. The function <code>OnFlashlightOnOff</code> is called whenever we turn the flashlight on or off. <code>OnFlashlightOnOff</code>  is our '''callback''' '''function''', which is defined in <code>OnStart</code>.<syntaxhighlight lang="c++">
 ////////////////////////////
 // Run first time starting map

← Older revision		Revision as of 13:57, 10 August 2020
Line 1:		Line 1:
		+	{{wip}}
		+
	{{Hpl3ScriptingGuideMenuBasic}}		{{Hpl3ScriptingGuideMenuBasic}}
	{{shortPageTitle}}		{{shortPageTitle}}