HPL2/HPL2 Helper Scripts/LoadWatcher - Revision history

Mrbehemo: /* Properties */

2023-11-25T13:48:34Z

Properties

Mrbehemo: /* Methods */

2023-11-25T13:46:55Z

Methods

Mrbehemo at 13:45, 25 November 2023

2023-11-25T13:45:31Z

Mrbehemo: Improved spacing.

2023-11-24T18:51:49Z

Improved spacing.

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

2023-11-24T17:41:12Z

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

Mrbehemo at 19:27, 23 November 2023

2023-11-23T19:27:00Z

Mrbehemo: Removed noindex

2023-11-23T19:10:14Z

Removed noindex

Mrbehemo: Update links to remove redirects following page move.

2023-11-23T19:09:16Z

Update links to remove redirects following page move.

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

2023-11-23T19:03:36Z

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

Mrbehemo at 11:25, 23 November 2023

2023-11-23T11:25:53Z

@@ Line 47: / Line 47: @@
 ==Properties==
-Math provides the following properties:
+LoadWatcher provides the following properties:
@@ Line 66: / Line 66: @@
+}
 </syntaxhighlight>
 ==Methods==

← Older revision		Revision as of 13:46, 25 November 2023
Line 70:		Line 70:

	==Methods==		==Methods==
−	~~GameVars~~ provides the following methods:	+	LoadWatcher provides the following methods:

@@ Line 39: / Line 39: @@
 ==Behaviours==
-This script defines an object called '''LoadWatcher''', of the new script class cLoadWatcher. To access its properties and methods, just use "LoadWatcher." followed by the function call or property. E.g.:
+"HelperScripts_LoadWatcher.hps" declares an object called '''LoadWatcher''', of the new script class cLoadWatcher. To access its properties and methods, just use "LoadWatcher." followed by the function call or property. E.g.:
 <syntaxhighlight lang="cpp">
 LoadWatcher.AddExtraCallback("OnLoad2");

@@ Line 1: / Line 1: @@
 {{TocRight}}
 This page documents "HelperScripts_LoadWatcher.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=
 The script file "HelperScripts_LoadWatcher.hps" provides a new "OnLoad()" global callback.
 ===OnLoad()===
@@ Line 14: / Line 16: @@
 void OnLoad(string &in asMessage)
 </syntaxhighlight>
 ===Messages===
@@ Line 24: / Line 27: @@
 '''Each level has its own message.''' Changing the message only affects reloading into the level that is current at the time of changing the message. If no message has been set, or if it is set as an empty string (""), then the default message "OnLoadCallback" is used.
 ===Extra Callbacks===
@@ Line 29: / Line 33: @@
 The methods AddExtraCallback(), RemoveExtraCallback(), ClearExtraCallbacks() and IsExtraCallbackRegistered() are provided for working with extra callbacks.
 =LoadWatcher=
 ==Behaviours==
@@ Line 38: / Line 44: @@
 LoadWatcher.Message = "just_loaded";
 </syntaxhighlight>
 ==Properties==
 Math provides the following properties:
 ====Message====
@@ Line 58: / Line 66: @@
+}
 </syntaxhighlight>
 ==Methods==
 GameVars provides the following methods:
 ===OnLoad() message===
 ====SetMessage()====
@@ Line 84: / Line 95: @@
+}
 </syntaxhighlight>
 ===Extra Callbacks===
 ====AddExtraCallback()====
@@ Line 109: / Line 122: @@
+}
 </syntaxhighlight>
 ====IsExtraCallbackRegistered()====
@@ Line 121: / Line 135: @@
 // The condition will succeed if the extra callback with that name has been registered.
 </syntaxhighlight>
 ====RemoveExtraCallback()====
@@ Line 145: / Line 160: @@
+}
 </syntaxhighlight>
 ====ClearExtraCallbacks()====

@@ Line 30: / Line 30: @@
 The methods AddExtraCallback(), RemoveExtraCallback(), ClearExtraCallbacks() and IsExtraCallbackRegistered() are provided for working with extra callbacks.
-=Behaviours=
+=LoadWatcher=
 This script defines an object called '''LoadWatcher''', of the new script class cLoadWatcher. To access its properties and methods, just use "LoadWatcher." followed by the function call or property. E.g.:
 <syntaxhighlight lang="cpp">
@@ Line 37: / Line 39: @@
 </syntaxhighlight>
-=Properties=
+==Properties==
-LoadWatcher provides the following properties:
+Math provides the following properties:
-===LoadWatcher.Message===
+====Message====
 <syntaxhighlight lang="cpp">
 string Message
@@ Line 58: / Line 60: @@
-=Methods=
+==Methods==
 GameVars provides the following methods:
-==OnLoad() message==
+===OnLoad() message===
-===LoadWatcher.SetMessage()===
+====SetMessage()====
 <syntaxhighlight lang="cpp">
 void SetMessage(string asMessage, bool abOnce = false)
@@ Line 83: / Line 85: @@
 </syntaxhighlight>
-==Extra Callbacks==
+===Extra Callbacks===
-===LoadWatcher.AddExtraCallback===
+====AddExtraCallback()====
 <syntaxhighlight lang="cpp">
 bool AddExtraCallback(string asCallback)
@@ Line 108: / Line 110: @@
 </syntaxhighlight>
-===LoadWatcher.IsExtraCallbackRegistered===
+====IsExtraCallbackRegistered()====
 <syntaxhighlight lang="cpp">
 bool IsExtraCallbackRegistered(string asCallback)
@@ Line 120: / Line 122: @@
 </syntaxhighlight>
-===LoadWatcher.RemoveExtraCallback===
+====RemoveExtraCallback()====
 <syntaxhighlight lang="cpp">
 bool RemoveExtraCallback(string asCallback)
@@ Line 144: / Line 146: @@
 </syntaxhighlight>
-===LoadWatcher.ClearExtraCallbacks===
+====ClearExtraCallbacks()====
 <syntaxhighlight lang="cpp">
 void ClearExtraCallbacks()

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

	__FORCETOC__		__FORCETOC__
−	~~__NOINDEX__~~

@@ Line 3: / Line 3: @@
 =Summary=
-The script file "HelperScripts_LoadWatcher.hps" provides a new "OnLoad()" global callback. OnLoad() is used in the same way as OnEnter(). It can be added to the level's .hps file and used to excecute script that should happen '''every time the level loads'''. It is managed by LoadWatcher.
+The script file "HelperScripts_LoadWatcher.hps" provides a new "OnLoad()" global callback.
 The difference between OnLoad() and OnEnter() is that OnEnter() is only called when the player enters the map. It is not called when the player reloads a game which was saved in the map. '''OnLoad() will be called last, one frame after the level has started.'''
@@ Line 12: / Line 15: @@
 </syntaxhighlight>
 The string argument asMessage can optionally be used to pass some information about the state of your world or story. The message can be set using the '''Message property or the SetMessage() function''' of LoadWatcher. An example use case might be to note some detail about the story progress, for example the Message property could be assigned when the player triggers a story event:
 <syntaxhighlight lang="cpp">
@@ Line 21: / Line 25: @@
 '''Each level has its own message.''' Changing the message only affects reloading into the level that is current at the time of changing the message. If no message has been set, or if it is set as an empty string (""), then the default message "OnLoadCallback" is used.
 Another feature of LoadWatcher is that you can register '''extra callbacks''' to use alongside OnLoad(). These have the same syntax and share the same message, but they can be added and removed at any time, so that they are ready to be called on the next reload. LoadWatcher handles storing the callback names in local variable wrappers, so they are also saved with the game, and also apply only to the current level.