Changes between Version 2 and Version 3 of Triggers

Timestamp:

Jun 22, 2014, 11:55:22 AM (10 years ago)

Author:

sanderd17

Comment:

Info on registering triggers

Triggers

@@ -34 +34 @@
 This should show a yellow warning in the top left of your screen when the map loading is finished.
 
-'''Tip:''' See [wiki:Logging Logging] for more logging options.
+'''Tip:''' See [wiki:Logging Logging] for more logging options, and use `uneval(data)` to transform any JS data into human-readable text.
 
 == Writing the trigger scripts ==
@@ -42 +42 @@
 === Action functions ===
 
-Actions are regular JavaScript functions, registered under the `Trigger` prototype. 
+Actions are regular JavaScript functions, registered under the `Trigger` prototype. Actions called by triggers always receive a data object with more information about the event that just happened. How the data looks depends on the actual event. See the table below (TODO ''guess we need to make a table'').
 
 {{{
@@ -85 +85 @@
     this.executedTriggers = 0;
     this.killedUnits = 0;
+    this.state = "initialising";
 }
 }}}
@@ -104 +105 @@
 
 == Registering functions ==
+
+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:
+
+{{{
+#!js
+Trigger.prototype.InitGame = 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 (TODO ''we do need that table''). 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");
+}}}
+
+You can enable and disable triggers as often as you want.