Changes between Version 9 and Version 10 of Triggers

Timestamp:

Jun 23, 2014, 6:06:41 PM (10 years ago)

Author:

sanderd17

Comment:

re-document the initialisation

Triggers

@@ -77 +77 @@
 ==== Data initialisation ==== 
 
-There's a special method (`InitGame`), that gets called when loading a new game, so it can be used for data initialisation. You can initialise any counters or other data there.
-
-{{{
-#!js
-Trigger.prototype.InitGame = function(data)
-{
-    this.executedTriggers = 0;
-    this.killedUnits = 0;
-    this.state = "initialising";
-}
+Storing data you want to keep track of should happen at the end of you script, and be done in the `Trigger` component. By doing so, you can use the data later on (in the `Trigger` prototype functions) with the `this` keyword.
+
+{{{
+#!js
+// get the cmpTrigger object
+var cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+
+// Add data to it
+cmpTrigger.executedTriggers = 0;
+cmpTrigger.killedUnits = 0;
+cmpTrigger.state = "initialising";
 }}}
 
@@ -104 +105 @@
 '''Note:''' both the `Trigger` prototype and the data you add directly to `this` can be accessed via `this`. But only the data added directly to `this` will be saved in a saved game. So although it's possible to add other stuff to the prototype than just functions, it shouldn't change throughout the game. Also note that functions can't be saved in saved games. So in short, functions should always be defined under the prototype, and never change.
 
-== Registering functions ==
+== Registering triggers ==
 
 When you have your actions made, you need to bind them to a certain event. This is done via the predefined RegisterTrigger function. Triggers can be enabled in any method, but you usually need to enable some at the start of the game. You can use the following schema:
@@ -110 +111 @@
 {{{
 #!js
-Trigger.prototype.InitGame = function(data)
+// get the cmpTrigger object
+var cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+
+// register the trigger directly
+var myData = {"enabled": true};
+cmpTrigger.RegisterTrigger("OnPlayerCommand", "MyAction", myData);
+}}}
+
+The first parameter of the trigger is the event on which it will be executed. In the example, the trigger will be executed for every player command. See the table below for a list of all possible events. The second parameter is the name of the action, which has to be defined under the Trigger prototype. And the third part is a data object. For most triggers, this data will be just enabled = true or false. But for more complicated triggers (range triggers, time triggers, ...) this data can contain other elements, such as the the distance of the range trigger, or the interval of the timer. Again, see the data in the table below.
+
+The combination of event and action name must be unique. This combination can be used to enable and disable triggers. Registering a trigger twice isn't possible, and tou will be warned when you do that.
+
+When you have your first triggers registered, they can fire actions, but actions can again register new triggers. As this time, it happens within the `Trigger` prototype, you can access `cmpTrigger` simply with `this`.
+
+{{{
+#!js
+Trigger.prototype.MyTriggerRegisteringAction = function(data)
 {
     var myData = {"enabled": true};
-    this.RegisterTrigger("OnPlayerCommand", "MyAction", myData);
-};
-}}}
-
-The first parameter of the trigger is the event on which it will be executed. In the example, the trigger will be executed for every player command. See the table below for a list of all possible events. The second parameter is the name of the action, which has to be defined under the Trigger prototype. And the third part is a data object. For most triggers, this data will be just enabled = true or false. But for more complicated triggers (range triggers, time triggers, ...) this data can contain other elements, such as the the distance of the range trigger, or the interval of the timer. Again, see the data in the table below.
-
-The combination of event and action name must be unique. This combination can be used to enable and disable triggers. Registering a trigger twice isn't possible, and tou will be warned when you do that.
-
-Enabling and disabling triggers happens as shown:
-
-{{{
-#!js
-this.EnableTrigger("OnPlayerCommand", "MyAction");
-this.DisableTrigger("OnPlayerCommand", "MyAction");
+    this.RegisterTrigger("OnPlayerCommand", "MySecondAction", myData);
+};
+}}}
+
+
+Enabling and disabling triggers in action functions happens as shown:
+
+{{{
+#!js
+Trigger.prototype.MySecondAction = function(data)
+{
+    this.EnableTrigger("OnPlayerCommand", "MyAction");
+    // OR
+    this.DisableTrigger("OnPlayerCommand", "MyAction");
+};
 }}}