HPL2/HPL2 Helper Scripts/GameVars - Revision history

Mrbehemo at 01:14, 11 February 2024

2024-02-11T01:14:01Z

Mrbehemo: Undo revision 6602 by Mrbehemo (talk)

2023-11-30T00:28:34Z

Undo revision 6602 by Mrbehemo (talk)

Mrbehemo: Added internal links

2023-11-30T00:08:34Z

Added internal links

Mrbehemo: Improved spacing.

2023-11-24T18:45:47Z

Improved spacing.

Mrbehemo: Expanded outline structure to better fit multiple classes on a page.

2023-11-24T17:34:23Z

Expanded outline structure to better fit multiple classes on a page.

Mrbehemo: Removed noindex

2023-11-23T19:10:27Z

Removed noindex

Mrbehemo: Update links to remove redirects following page move.

2023-11-23T19:08:56Z

Update links to remove redirects following page move.

Mrbehemo: Mrbehemo moved page HPL2 Helper Scripts - GameVars to HPL2/HPL2 Helper Scripts/GameVars: Using hierarchy structure in line with the rest of the wiki.

2023-11-23T19:03:17Z

Mrbehemo moved page HPL2 Helper Scripts - GameVars to HPL2/HPL2 Helper Scripts/GameVars: Using hierarchy structure in line with the rest of the wiki.

Mrbehemo at 11:22, 23 November 2023

2023-11-23T11:22:25Z

Mrbehemo at 11:20, 23 November 2023

2023-11-23T11:20:51Z

← Older revision		Revision as of 01:14, 11 February 2024
Line 247:		Line 247:
	#''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)		#''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
	#''string asName'' - The name of the int game variable to retrieve.		#''string asName'' - The name of the int game variable to retrieve.
		+
		+
		+	====SetIntAsUint()====
		+	<syntaxhighlight lang="cpp">
		+	void SetIntAsUint(enumVarScope aScopeOption, string asName, uint aulValue)
		+	</syntaxhighlight>
		+	Takes a uint argument and stores it as an int. This is the same as SetInt(), except that it explicitly casts the uint to int, which avoids type conversion warnings.
		+	<br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
		+	#''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
		+	#''string asName'' - The name of the int game variable to set.
		+	#''uint aulValue'' - The uint value to be stored as an int.

@@ Line 4: / Line 4: @@
 =Summary=
-The script file "HelperScripts_GameVars.hps" builds on top of the normal saved game global and local variable wrappers, adding the ability to save more variable types to the save game file, including [[HPL2/HPL2_Helper_Scripts/Vectors|vectors]] and [[HPL2/HPL2_Helper_Scripts/Lists|lists]]/arrays.
+The script file "HelperScripts_GameVars.hps" builds on top of the normal saved game global and local variable wrappers, adding the ability to save more variable types to the save game file, including vectors and lists/arrays.
 <syntaxhighlight lang="cpp">
 // The basic way:
@@ Line 16: / Line 16: @@
 ===Scope===
-Firstly, instead of separate functions for local and global variables, GameVars uses an optional argument to specify the scope. Each of the GameVars methods has an optional [[HPL2/HPL2_Helper_Scripts/Misc#Enums|enum]] enumVarScope, which can be either '''varLocal''' or '''varGlobal'''. If omitted, the '''default is scope is global'''. For example:
+Firstly, instead of separate functions for local and global variables, GameVars uses an optional argument to specify the scope. Each of the GameVars methods has an optional enumVarScope, which can be either '''varLocal''' or '''varGlobal'''. If omitted, the '''default is scope is global'''. For example:
 <syntaxhighlight lang="cpp">
 GameVars.SetInt(varLocal, "some_number", 99);		// Does the same thing as SetLocalVarInt("some_number", 99);
@@ Line 32: / Line 32: @@
 GameVars.SetString(scopeForRadioMessages, "radioMessage", "SendHelp");
-// This example imagines a scenario where the radioMessage state is only copied to other levels while the radio booster is active.
+// This example imagines a scenario where the radioMessage state copied to other levels only while the radio booster is active.
 </syntaxhighlight>
 ===New Types===
-Secondly, '''additional variable types''' are available. As well as the normal int, float and string game variables, GameVars has methods for storing and retrieving variables as bool, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]], [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] and [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]]. For example:
+Secondly, '''additional variable types''' are available. As well as the normal int, float and string game variables, GameVars has methods for storing and retrieving variables as bool, cVector, cPoint and cRotator. For example:
 <syntaxhighlight lang="cpp">
 		GameVars.SetBool("myBoolean", true);
@@ Line 48: / Line 48: @@
 ===Lists===
-And thirdly GameVars can store '''indexed lists''' of variables, in the style of an '''array or [[HPL2/HPL2_Helper_Scripts/Lists|list]]'''. For example, [[HPL2/HPL2_Helper_Scripts/GameVars#SetList....28.29|SetListInt()]] can be passed an array of ints or a [[HPL2/HPL2_Helper_Scripts/Lists#List_classes|cListInt]]. The return value of GetListInt is a cListInt list that can be assigned to a list variable, or used with the index operator directly. For example:
+And thirdly GameVars can store '''indexed lists''' of variables, in the style of an '''array or linked list'''. For example, SetListInt() can be passed an array of ints or a cListInt. The return value of GetListInt is a cListInt list that can be assigned to a list variable, or used with the index operator directly. For example:
 <syntaxhighlight lang="cpp">
 		bool[] myArrayOfBools = { true, true, false, false, false };
@@ Line 105: / Line 105: @@
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the game variable to set.
-#''int alValue, float afValue, string asValue, bool abValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be set as the named game variable.
+#''int alValue, float afValue, string asValue, bool abValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be set as the named game variable.
 <syntaxhighlight lang="cpp">
 // Example:
@@ Line 154: / Line 154: @@
 void AddPoint(enumVarScope aScopeOption, string asName, cPoint avhValue)
 </syntaxhighlight>
-Updates a stored numeric game variable with the given name by adding the given value arithmetically. To subtract, use a negative value. Not to be confused with [[HPL2/HPL2_Helper_Scripts/GameVars#AddString.28.29|AddString()]] (appends text) or [[HPL2/HPL2_Helper_Scripts/GameVars#AddListItem....28.29|AddListItem...()]] (appends an item to a list).
+Updates a stored numeric game variable with the given name by adding the given value arithmetically. To subtract, use a negative value. Not to be confused with AddString() (appends text) or AddListItem...() (appends an item to a list).
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the game variable to add to.
-#''int alValue, float afValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be add to the named game variable.
+#''int alValue, float afValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be add to the named game variable.
 <syntaxhighlight lang="cpp">
 // Example 1:
@@ Line 280: / Line 280: @@
 void SetListPoint(enumVarScope aScopeOption, string asName, cPoint[] avhValues)
 </syntaxhighlight>
-Stores a [[HPL2/HPL2_Helper_Scripts/Lists|list]] or array of game variables under a single name.
+Stores a list or array of game variables under a single name.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the game variable to store as a list.
-#''cListInt alValues, cListFloat afValues, cListString asValues, cListBool abValues, cListVector avhValues, cListRotator avhValues, cListPoint avhValues,
+#''cListInt alValues, cListFloat afValues, cListString asValues, cListBool abValues, cListVector avhValues, cListRotator avhValues, cListPoint avhValues
-int[] alValues, float[] afValues, string[] asValues, bool[] abValues, cVector[] avhValues, cRotator[] avhValues, or cPoint[] avhValues'' - An appropriate array or [[HPL2/HPL2_Helper_Scripts/Lists#List_classes|list type]] to be set as the named game variable.
+int[] alValues, float[] afValues, string[] asValues, bool[] abValues, cVector[] avhValues, cRotator[] avhValues, or cPoint[] avhValues'' - A value of the appropriate type to be set as the named game variable.
 <syntaxhighlight lang="cpp">
 // Example 1:
@@ Line 315: / Line 315: @@
 #''string asName'' - The name of the stored game variable list.
 #''uint aulIndex'' - The index in the stored list to set the value.
-#''int alValue, float afValue, string asValue, bool abValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be set as the item in the named game variable list.
+#''int alValue, float afValue, string asValue, bool abValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be set as the item in the named game variable list.
 <syntaxhighlight lang="cpp">
 // Example 1:
@@ Line 343: / Line 343: @@
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the stored game variable list.
-#''int alValue, float afValue, string asValue, bool abValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be appended to the named game variable list.
+#''int alValue, float afValue, string asValue, bool abValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be appended to the named game variable list.
 <syntaxhighlight lang="cpp">
 // Example:
@@ Line 363: / Line 363: @@
 cListPoint GetListPoint(enumVarScope aScopeOption, string asName)
 </syntaxhighlight>
-Retrieves an entire stored game variable list and returns it as a [[HPL2/HPL2_Helper_Scripts/Lists|list]] of the appropriate type.
+Retrieves an entire stored game variable list and returns it as a linked list of the appropriate type.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
@@ Line 410: / Line 410: @@
 uint GetListCount(enumVarScope aScopeOption, string asName)
 </syntaxhighlight>
-Returns the number of items stored in a game variable list.
+Returns the number of items stored in a list.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
@@ Line 426: / Line 426: @@
 </syntaxhighlight>
 Empties a stored list.
-<br>Note: This works by zeroing the count and does not remove or reset the items in the stored list. If [[HPL2/HPL2_Helper_Scripts/GameVars#GetList....28.29|GetList...()]] is used after ClearList() then it will return an empty list. But if [[HPL2/HPL2_Helper_Scripts/GameVars#GetListItem....28.29|GetListItem...()]] is used after ClearList(), it will still return the previously stored item.
+<br>Note: This works by zeroing the count and does not remove or reset the items in the stored list. If GetList...() is used after ClearList() then it will return an empty list. But if GetListItem...() is used after ClearList(), it will still return the previously stored item.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)

@@ Line 4: / Line 4: @@
 =Summary=
-The script file "HelperScripts_GameVars.hps" builds on top of the normal saved game global and local variable wrappers, adding the ability to save more variable types to the save game file, including vectors and lists/arrays.
+The script file "HelperScripts_GameVars.hps" builds on top of the normal saved game global and local variable wrappers, adding the ability to save more variable types to the save game file, including [[HPL2/HPL2_Helper_Scripts/Vectors|vectors]] and [[HPL2/HPL2_Helper_Scripts/Lists|lists]]/arrays.
 <syntaxhighlight lang="cpp">
 // The basic way:
@@ Line 16: / Line 16: @@
 ===Scope===
-Firstly, instead of separate functions for local and global variables, GameVars uses an optional argument to specify the scope. Each of the GameVars methods has an optional enumVarScope, which can be either '''varLocal''' or '''varGlobal'''. If omitted, the '''default is scope is global'''. For example:
+Firstly, instead of separate functions for local and global variables, GameVars uses an optional argument to specify the scope. Each of the GameVars methods has an optional [[HPL2/HPL2_Helper_Scripts/Misc#Enums|enum]] enumVarScope, which can be either '''varLocal''' or '''varGlobal'''. If omitted, the '''default is scope is global'''. For example:
 <syntaxhighlight lang="cpp">
 GameVars.SetInt(varLocal, "some_number", 99);		// Does the same thing as SetLocalVarInt("some_number", 99);
@@ Line 32: / Line 32: @@
 GameVars.SetString(scopeForRadioMessages, "radioMessage", "SendHelp");
-// This example imagines a scenario where the radioMessage state copied to other levels only while the radio booster is active.
+// This example imagines a scenario where the radioMessage state is only copied to other levels while the radio booster is active.
 </syntaxhighlight>
 ===New Types===
-Secondly, '''additional variable types''' are available. As well as the normal int, float and string game variables, GameVars has methods for storing and retrieving variables as bool, cVector, cPoint and cRotator. For example:
+Secondly, '''additional variable types''' are available. As well as the normal int, float and string game variables, GameVars has methods for storing and retrieving variables as bool, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]], [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] and [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]]. For example:
 <syntaxhighlight lang="cpp">
 		GameVars.SetBool("myBoolean", true);
@@ Line 48: / Line 48: @@
 ===Lists===
-And thirdly GameVars can store '''indexed lists''' of variables, in the style of an '''array or linked list'''. For example, SetListInt() can be passed an array of ints or a cListInt. The return value of GetListInt is a cListInt list that can be assigned to a list variable, or used with the index operator directly. For example:
+And thirdly GameVars can store '''indexed lists''' of variables, in the style of an '''array or [[HPL2/HPL2_Helper_Scripts/Lists|list]]'''. For example, [[HPL2/HPL2_Helper_Scripts/GameVars#SetList....28.29|SetListInt()]] can be passed an array of ints or a [[HPL2/HPL2_Helper_Scripts/Lists#List_classes|cListInt]]. The return value of GetListInt is a cListInt list that can be assigned to a list variable, or used with the index operator directly. For example:
 <syntaxhighlight lang="cpp">
 		bool[] myArrayOfBools = { true, true, false, false, false };
@@ Line 105: / Line 105: @@
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the game variable to set.
-#''int alValue, float afValue, string asValue, bool abValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be set as the named game variable.
+#''int alValue, float afValue, string asValue, bool abValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be set as the named game variable.
 <syntaxhighlight lang="cpp">
 // Example:
@@ Line 154: / Line 154: @@
 void AddPoint(enumVarScope aScopeOption, string asName, cPoint avhValue)
 </syntaxhighlight>
-Updates a stored numeric game variable with the given name by adding the given value arithmetically. To subtract, use a negative value. Not to be confused with AddString() (appends text) or AddListItem...() (appends an item to a list).
+Updates a stored numeric game variable with the given name by adding the given value arithmetically. To subtract, use a negative value. Not to be confused with [[HPL2/HPL2_Helper_Scripts/GameVars#AddString.28.29|AddString()]] (appends text) or [[HPL2/HPL2_Helper_Scripts/GameVars#AddListItem....28.29|AddListItem...()]] (appends an item to a list).
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the game variable to add to.
-#''int alValue, float afValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be add to the named game variable.
+#''int alValue, float afValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be add to the named game variable.
 <syntaxhighlight lang="cpp">
 // Example 1:
@@ Line 280: / Line 280: @@
 void SetListPoint(enumVarScope aScopeOption, string asName, cPoint[] avhValues)
 </syntaxhighlight>
-Stores a list or array of game variables under a single name.
+Stores a [[HPL2/HPL2_Helper_Scripts/Lists|list]] or array of game variables under a single name.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the game variable to store as a list.
-#''cListInt alValues, cListFloat afValues, cListString asValues, cListBool abValues, cListVector avhValues, cListRotator avhValues, cListPoint avhValues
+#''cListInt alValues, cListFloat afValues, cListString asValues, cListBool abValues, cListVector avhValues, cListRotator avhValues, cListPoint avhValues,
-int[] alValues, float[] afValues, string[] asValues, bool[] abValues, cVector[] avhValues, cRotator[] avhValues, or cPoint[] avhValues'' - A value of the appropriate type to be set as the named game variable.
+int[] alValues, float[] afValues, string[] asValues, bool[] abValues, cVector[] avhValues, cRotator[] avhValues, or cPoint[] avhValues'' - An appropriate array or [[HPL2/HPL2_Helper_Scripts/Lists#List_classes|list type]] to be set as the named game variable.
 <syntaxhighlight lang="cpp">
 // Example 1:
@@ Line 315: / Line 315: @@
 #''string asName'' - The name of the stored game variable list.
 #''uint aulIndex'' - The index in the stored list to set the value.
-#''int alValue, float afValue, string asValue, bool abValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be set as the item in the named game variable list.
+#''int alValue, float afValue, string asValue, bool abValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be set as the item in the named game variable list.
 <syntaxhighlight lang="cpp">
 // Example 1:
@@ Line 343: / Line 343: @@
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the stored game variable list.
-#''int alValue, float afValue, string asValue, bool abValue, cVector avhValue, cRotator avhValue, or cPoint avhValue'' - A value of the appropriate type to be appended to the named game variable list.
+#''int alValue, float afValue, string asValue, bool abValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cVector|cVector]] avhValue, [[HPL2/HPL2_Helper_Scripts/Vectors#cRotator|cRotator]] avhValue, or [[HPL2/HPL2_Helper_Scripts/Vectors#cPoint|cPoint]] avhValue'' - A value of the appropriate type to be appended to the named game variable list.
 <syntaxhighlight lang="cpp">
 // Example:
@@ Line 363: / Line 363: @@
 cListPoint GetListPoint(enumVarScope aScopeOption, string asName)
 </syntaxhighlight>
-Retrieves an entire stored game variable list and returns it as a linked list of the appropriate type.
+Retrieves an entire stored game variable list and returns it as a [[HPL2/HPL2_Helper_Scripts/Lists|list]] of the appropriate type.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
@@ Line 410: / Line 410: @@
 uint GetListCount(enumVarScope aScopeOption, string asName)
 </syntaxhighlight>
-Returns the number of items stored in a list.
+Returns the number of items stored in a game variable list.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
@@ Line 426: / Line 426: @@
 </syntaxhighlight>
 Empties a stored list.
-<br>Note: This works by zeroing the count and does not remove or reset the items in the stored list. If GetList...() is used after ClearList() then it will return an empty list. But if GetListItem...() is used after ClearList(), it will still return the previously stored item.
+<br>Note: This works by zeroing the count and does not remove or reset the items in the stored list. If [[HPL2/HPL2_Helper_Scripts/GameVars#GetList....28.29|GetList...()]] is used after ClearList() then it will return an empty list. But if [[HPL2/HPL2_Helper_Scripts/GameVars#GetListItem....28.29|GetListItem...()]] is used after ClearList(), it will still return the previously stored item.
 <br>aScopeOption is optional. If varLocal is used, the game variable is saved for the current level only. If varGlobal is used or if aScopeOption is omitted, the game variables will be saved for all levels.
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)

@@ Line 1: / Line 1: @@
 {{TocRight}}
 This page documents "HelperScripts_GameVars.hps" - part of ''[[HPL2/HPL2 Helper Scripts]]'', a modder-made package of .hps files by Aetheric Games, containing script classes and functions that may be useful to HPL2 modders and custom story creators. See the [[HPL2/HPL2 Helper Scripts|main page]] for more information, including [[HPL2/HPL2 Helper Scripts#Set-up|set-up instructions]].
 =Summary=
@@ Line 12: / Line 13: @@
 GameVars variables work in a similar way to the normal saved game global and local variable wrappers, with three differences:
 ===Scope===
@@ Line 32: / Line 34: @@
 // This example imagines a scenario where the radioMessage state copied to other levels only while the radio booster is active.
 </syntaxhighlight>
 ===New Types===
@@ Line 42: / Line 45: @@
+		}
 </syntaxhighlight>
 ===Lists===
@@ Line 64: / Line 68: @@
 Behind the scenes, GameVars uses one or more ints or floats to store the new types.
 The double and uint types are not provided for, as they could lose precision when stored as floats or int. Use the float and int methods explicitly instead.
 =GameVars=
 ==Behaviours==
@@ Line 72: / Line 78: @@
 GameVars.SetBool(varLocal, "someBoolean", false);
 </syntaxhighlight>
 ==Properties==
 GameVars has no public properties.
 ==Methods==
 GameVars provides the following methods:
 ===Single Variables===
 ====Set...()====
@@ Line 105: / Line 115: @@
 // The bool game var doorOpen is set to true in the global scope (for all levels).
 </syntaxhighlight>
 ====Get...()====
@@ Line 133: / Line 144: @@
 // The condition succeeds if the global game var doorOpen is retrieved as true.
 </syntaxhighlight>
 ====Add...()====
@@ Line 156: / Line 168: @@
 // The local point game var gridPos decreases by 1 in the y axis.
 </syntaxhighlight>
 ====AddString()====
@@ Line 171: / Line 184: @@
 // The global string game var message is appended with the second string.
 </syntaxhighlight>
 ====NotBool()====
@@ Line 187: / Line 201: @@
 // The local bool game var flipflop is first set to false but then becomes true.
 </syntaxhighlight>
 ====AndBool()====
@@ Line 204: / Line 219: @@
 // The global bool game var flipflop stays false.
 </syntaxhighlight>
 ====OrBool()====
@@ Line 221: / Line 237: @@
 // The global bool game var flipflop becomes true.
 </syntaxhighlight>
 ====GetIntAsUint()====
@@ Line 230: / Line 247: @@
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the int game variable to retrieve.
 ====GetFloatAsDouble()====
@@ Line 239: / Line 257: @@
 #''enumVarScope aScopeOption'' - Can be either varLocal or varGlobal. (Optional, default = varGlobal)
 #''string asName'' - The name of the int game variable to retrieve.
 ===Lists===
 ====SetList...()====
@@ Line 278: / Line 298: @@
 // Ten random integers will be saved to a global game var as mySavedInts.
 </syntaxhighlight>
 ====SetListItem...()====
@@ Line 306: / Line 327: @@
 // Assuming newListOfInts has not been created yet, a list of 9 default 0's is created, followed by 99.
 </syntaxhighlight>
 ====AddListItem...()====
@@ Line 329: / Line 351: @@
 // The saved list of four true bools in the local game var buttonPositions is now append with a false value.
 </syntaxhighlight>
 ====GetList...()====
@@ Line 357: / Line 380: @@
 // The script var float myFloat is assigned with the single value retrieved from index 3 of the game var list savedFloats.
 </syntaxhighlight>
 ====GetListItem...()====
@@ Line 380: / Line 404: @@
 // sRetirevedItem becomes "saw".
 </syntaxhighlight>
 ====GetListCount()====
@@ Line 394: / Line 419: @@
 // The number of items in the saved game var activeQuests is retrieved and passed to SetNumberOfQuestsInMap() as an arg.
 </syntaxhighlight>
 ====ClearList()====

@@ Line 65: / Line 65: @@
 The double and uint types are not provided for, as they could lose precision when stored as floats or int. Use the float and int methods explicitly instead.
-=Behaviours=
+=GameVars=
 "HelperScripts_GameVars.hps" declares an object called '''GameVars''', of the new script class cGameVars. To access its methods, just use "GameVars." followed by the function call. E.g.:
 <syntaxhighlight lang="cpp">
@@ Line 71: / Line 73: @@
 </syntaxhighlight>
-=Properties=
+==Properties==
 GameVars has no public properties.
-=Methods=
+==Methods==
 GameVars provides the following methods:
-==Single Variables==
+===Single Variables===
-===GameVars.Set...()===
+====Set...()====
 <syntaxhighlight lang="cpp">
 void SetInt(enumVarScope aScopeOption, string asName, int alValue)
@@ Line 104: / Line 106: @@
 </syntaxhighlight>
-===GameVars.Get...()===
+====Get...()====
 <syntaxhighlight lang="cpp">
 int GetInt(enumVarScope aScopeOption, string asName)
@@ Line 132: / Line 134: @@
 </syntaxhighlight>
-===GameVars.Add...()===
+====Add...()====
 <syntaxhighlight lang="cpp">
 void AddInt(enumVarScope aScopeOption, string asName, int alValue)
@@ Line 155: / Line 157: @@
 </syntaxhighlight>
-===GameVars.AddString()===
+====AddString()====
 <syntaxhighlight lang="cpp">
 void AddString(enumVarScope aScopeOption, string asName, string asName)
@@ Line 170: / Line 172: @@
 </syntaxhighlight>
-===GameVars.NotBool()===
+====NotBool()====
 <syntaxhighlight lang="cpp">
 void NotBool(enumVarScope aScopeOption, string asName)
@@ Line 186: / Line 188: @@
 </syntaxhighlight>
-===GameVars.AndBool()===
+====AndBool()====
 <syntaxhighlight lang="cpp">
 void AndBool(enumVarScope aScopeOption, string asName, bool abValue)
@@ Line 203: / Line 205: @@
 </syntaxhighlight>
-===GameVars.OrBool()===
+====OrBool()====
 <syntaxhighlight lang="cpp">
 void OrBool(enumVarScope aScopeOption, string asName, bool abValue)
@@ Line 220: / Line 222: @@
 </syntaxhighlight>
-===GameVars.GetIntAsUint()===
+====GetIntAsUint()====
 <syntaxhighlight lang="cpp">
 uint GetIntAsUint(enumVarScope aScopeOption, string asName)
@@ Line 229: / Line 231: @@
 #''string asName'' - The name of the int game variable to retrieve.
-===GameVars.GetFloatAsDouble()===
+====GetFloatAsDouble()====
 <syntaxhighlight lang="cpp">
 double GetFloatAsDouble(enumVarScope aScopeOption, string asName)
@@ Line 238: / Line 240: @@
 #''string asName'' - The name of the int game variable to retrieve.
-==Lists==
+===Lists===
-===GameVars.SetList...()===
+====SetList...()====
 <syntaxhighlight lang="cpp">
 void SetListInt(enumVarScope aScopeOption, string asName, cListInt alValues)
@@ Line 277: / Line 279: @@
 </syntaxhighlight>
-===GameVars.SetListItem...()===
+====SetListItem...()====
 <syntaxhighlight lang="cpp">
 void SetListItemInt(enumVarScope aScopeOption, string asName, uint aulIndex, int alValue)
@@ Line 305: / Line 307: @@
 </syntaxhighlight>
-===GameVars.AddListItem...()===
+====AddListItem...()====
 <syntaxhighlight lang="cpp">
 void AddListItemInt(enumVarScope aScopeOption, string asName, int alValue)
@@ Line 328: / Line 330: @@
 </syntaxhighlight>
-===GameVars.GetList...()===
+====GetList...()====
 <syntaxhighlight lang="cpp">
 cListInt GetListInt(enumVarScope aScopeOption, string asName)
@@ Line 356: / Line 358: @@
 </syntaxhighlight>
-===GameVars.GetListItem...()===
+====GetListItem...()====
 <syntaxhighlight lang="cpp">
 cListInt GetListItemInt(enumVarScope aScopeOption, string asName, uint aulIndex)
@@ Line 379: / Line 381: @@
 </syntaxhighlight>
-===GameVars.GetListCount()===
+====GetListCount()====
 <syntaxhighlight lang="cpp">
 uint GetListCount(enumVarScope aScopeOption, string asName)
@@ Line 393: / Line 395: @@
 </syntaxhighlight>
-===GameVars.ClearList()===
+====ClearList()====
 <syntaxhighlight lang="cpp">
 void ClearList(enumVarScope aScopeOption, string asName)

← Older revision		Revision as of 19:10, 23 November 2023
Line 416:		Line 416:

	__FORCETOC__		__FORCETOC__
−	~~__NOINDEX__~~