HPL3/Scripting/Scripting Guide/Local and Global Variables - Revision history

TiMan: /* Global Variables */

2020-08-16T10:55:32Z

Global Variables

TiMan: /* Global Variables */

2020-08-14T21:02:28Z

Global Variables

TiMan: /* Global Variables */

2020-08-14T20:50:35Z

Global Variables

TiMan: /* Global Variables */

2020-08-14T20:45:17Z

Global Variables

TiMan: /* Global Variables */

2020-08-14T20:43:53Z

Global Variables

TiMan: /* Local Variables */

2020-08-14T16:48:26Z

Local Variables

TiMan: /* Local Variables */

2020-08-14T16:44:58Z

Local Variables

TiMan at 16:44, 14 August 2020

2020-08-14T16:44:34Z

TiMan at 12:12, 13 August 2020

2020-08-13T12:12:56Z

TiMan at 12:09, 13 August 2020

2020-08-13T12:09:30Z

@@ Line 54: / Line 54: @@
 </syntaxhighlight>
-{{note|A variable which is declared outside a class scope must be a <code>const</code> variable!}}
+{{note|A variable which is declared outside a class scope must be a <code>[[HPL3/Scripting/AngelScript_Fundamentals/Chapter_9_-_Miscellaneous_AngelScript_Features#Constants|const]]</code> variable!}}
 ===Cross-Script Global Variables===

@@ Line 53: / Line 53: @@
    // The rest of the script file...
 </syntaxhighlight>
 ===Cross-Script Global Variables===

@@ Line 65: / Line 65: @@
+}
 </syntaxhighlight>
 '''''SecondMap.hps'''''<syntaxhighlight lang="c++">

@@ Line 57: / Line 57: @@
 Cross-Script global variables are variables which can be used across multiple script files. They are usually used to check if the player has done specific things within the map to make something happen in another map.
-This is achieved using the two different functions: cScript_SetGlobalVar and cScript_GetGlobalVar. For example:
+This is achieved using the two different functions: <code>cScript_SetGlobalVar</code> and <code>cScript_GetGlobalVar</code>. For example:
 '''''FirstMap.hps'''''<syntaxhighlight lang="c++">
@@ Line 75: / Line 75: @@
+	}
+}
-</syntaxhighlight>In the first map script file, we create a global bool variable and set the value to true. In the second map script file, we check if the value of that global variable is true and execute the code inside.{{NavBar|HPL3/Scripting/Scripting_Guide/Sequences|Sequences|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Enums|Enums}}
+</syntaxhighlight>In the first map script file, we create a global <code>bool</code> variable and set the value to <code>true</code>. In the second map script file, we check if the value of that global variable is true and execute the code inside.{{NavBar|HPL3/Scripting/Scripting_Guide/Sequences|Sequences|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Enums|Enums}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 17: / Line 17: @@
 void foo()
+{
-	tString msLocalVariable = "Value";
+	tString msLocalVariable = "Value"; // Declaring and Initializing a variable inside this function
-	cLux_AddDebugMessage(msLocalVariable);
+	cLux_AddDebugMessage(msLocalVariable); // This will work
+}
 </syntaxhighlight>
-Local variables can be on the class-scope as well, for example:<syntaxhighlight lang="c++">
+Local variables can be on the class-scope as well, and so they could be used in multiple functions, for example:<syntaxhighlight lang="c++">
 class cScrMap : iScrMap
+{
@@ Line 29: / Line 34: @@
 	void foo()
+	{
-		int lFunctionVariable = 5;
+		cLux_AddDebugMessage(msLocalVariable); // This will work
-		cLux_AddDebugMessage(msLocalVariable + lFunctionVariable);
+	}
 </syntaxhighlight>
@@ Line 37: / Line 46: @@
 Global variables are defined outside of all the functions, usually on top of the script file. The global variables will hold their value throughout the life-time of your script.
-A global variable can be accessed by any function. That is, a global variable is available for use throughout your entire program after its declaration. Following is the example using global and local variables −<syntaxhighlight lang="c++">
+A global variable can be accessed by any function. That is, a global variable is available for use throughout your entire script after its declaration. The following is the example using global variable:<syntaxhighlight lang="c++">
 const tString mlMyGlobalStringVariable = "Value";
@@ Line 48: / Line 57: @@
 Cross-Script global variables are variables which can be used across multiple script files. They are usually used to check if the player has done specific things within the map to make something happen in another map.
-{{NavBar|HPL3/Scripting/Scripting_Guide/Sequences|Sequences|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Enums|Enums}}
+This is achieved using the two different functions: cScript_SetGlobalVar and cScript_GetGlobalVar. For example:
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 4: / Line 4: @@
 Local and global variables are variables that have a certain scope compared to the script in which it is located in.
-== Variables Scopes ==
+==Variables Scopes==
 A scope is a region of the program and broadly speaking there are three places, where variables can be declared:
 * Inside a function or a block which is called local variables.
-* In the definition of function parameters which is called formal parameters.
+*Inside a function or a block which is called local variables.
-* Outside of all functions which is called global variables.
+*In the definition of function parameters which is called formal parameters.
 In HPL3, there are two main variable scopes: Local Variables and Global Variables.
-== Local Variables ==
+==Local Variables==
-Variables that are declared inside a function or block are local variables. They can be used only by statements that are inside that function or block of code. Local variables that are declared inside functions are not known to functions outside their own. The following is the example using local variables:
+Variables that are declared inside a function or block are local variables. They can be used only by statements that are inside that function or block of code. Local variables that are declared inside functions are not known to functions outside their own. The following is the example using local variables:<syntaxhighlight lang="c++">
-== Global Variables ==
+==Global Variables==
 There are certain levels of scope to a script, there is the function's scope, then there is the local scope, then there is the global scope.

@@ Line 3: / Line 3: @@
 Local and global variables are variables that have a certain scope compared to the script in which it is located in.
 There are certain levels of scope to a script, there is the function's scope, then there is the local scope, then there is the global scope.
-A function's scope consists of everything within its braces ({ }).
+A function's scope consists of everything within its braces <code>{ }</code>.
 Normal variables as shown above will only work in a function unless carried over to another function.
 A local variable's scope is the whole entire script, so if you made a local variable, then you wouldn't have to worry about having to carry it over from function to function. The downside to it is that you can't use the value of the local variable in commands.
-{{todo|Add code example more explanation about scopes}}
+===Cross-Script Global Variables===
 {{NavBar|HPL3/Scripting/Scripting_Guide/Sequences|Sequences|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Enums|Enums}}