Changes between Version 8 and Version 9 of Triggers

Timestamp:

Jun 23, 2014, 11:14:15 AM (10 years ago)

Author:

sanderd17

Comment:

Syntax highlighting in the reference table

Triggers

@@ -131 +131 @@
 You can enable and disable triggers as often as you want.
 
-
 == Reference Table ==
 
-||= Event name            =||= Accepted data format                  =||= Returned data format =||= Notes =||
-|| `OnStructureBuilt`      || `{"enabled": bool}`                     || `{"building": constructedBuilding}` || Happens when a foundation gets finished or a building gets completely repaired ||
-|| `OnConstructionStarted` || `{"enabled": bool}`                     || `{"foundation": entityId, "template": this.templateName}` || Happens when the building of the foundation starts ||
-|| `OnTrainingFinished`    || `{"enabled": bool}`                     || `{"entities": [entityId], "owner": playerId, "metadata": metadata}` || Happens when training of some units is finished ||
-|| `OnTrainingQueued`      || `{"enabled": bool}`                     || `{"playerid": playerId, "unitTemplate": templateName, "count": number, "metadata": metadata, "trainerEntity": entityId}` || ||
-|| `OnResearchFinished`    || `{"enabled": bool}`                     || `{"player": playerId, "tech": templateName}` || ||
-|| `OnResearchQueued`      || `{"enabled": bool}`                     || `{"playerid": playerId, "technologyTemplate": templateName, "researcherEntity": entityId}` || ||
-|| `OnPlayerCommand`       || `{"enabled": bool}`                     || `{"player": playerId, "cmd": unitCommand}` || Any command a player sends. The "cmd" part of a command always have a type, and per type can have different other atributes. Check the documentation in the source file ([source:ps/trunk/binaries/data/mods/public/simulation/helpers/Commands.js Commands.js]) for documentation ||
-|| `OnInterval`            || `{"delay": number, "interval": number, "enabled": bool}` || TODO || ||
-|| `OnRange`               || `{"entities": [entityId], "players": [playerId], "minRange": number, "maxRange": number, "requiredComponent": componentId, "enabled": bool}` || `{"added": [entityId], "removed": [entityId], "currenctCollection": [entityId]}` ||  ||
+{{{#!th
+Event name
+}}}
+{{{#!th
+Accepted Data format
+}}}
+{{{#!th
+Returned data format
+}}}
+{{{#!th
+Notes
+}}}
+|----------------
+{{{#!td
+`OnStructureBuilt`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {"building": constructedBuilding}
+  }}}
+}}}
+{{{#!td
+Happens when a foundation gets finished or a building gets completely repaired
+}}}
+|----------------
+{{{#!td
+`OnConstructionStarted`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "foundation": entityId,
+      "template": this.templateName
+    }
+  }}}
+}}}
+{{{#!td
+Happens when the building of the foundation starts
+}}}
+|----------------
+{{{#!td
+`OnTrainingFinished`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "entities": [entityId],
+      "owner": playerId,
+      "metadata": metadata
+    }
+  }}}
+}}}
+{{{#!td
+Happens when training of some units is finished
+}}}
+|----------------
+{{{#!td
+`OnTrainingQueued`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "playerid": playerId,
+      "unitTemplate": templateName,
+      "count": number,
+      "metadata": metadata,
+      "trainerEntity": entityId
+    }
+  }}}
+}}}
+{{{#!td
+
+}}}
+|----------------
+{{{#!td
+`OnResearchFinished`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "player": playerId,
+      "tech": templateName
+    }
+  }}}
+}}}
+{{{#!td
+
+}}}
+|----------------
+{{{#!td
+`OnResearchQueued`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "playerid": playerId,
+      "technologyTemplate": templateName,
+      "researcherEntity": entityId
+    }
+  }}}
+}}}
+{{{#!td
+
+}}}
+|----------------
+{{{#!td
+`OnPlayerCommand`
+}}}
+{{{#!td
+  {{{#!js
+    {"enabled": bool}
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "player": playerId,
+      "cmd": unitCommand
+    }
+  }}}
+}}}
+{{{#!td
+Any command a player sends. The "cmd" part of a command always have a type, and per type can have different other atributes. Check the documentation in the source file ([source:ps/trunk/binaries/data/mods/public/simulation/helpers/Commands.js Commands.js]) for documentation
+}}}
+|----------------
+{{{#!td
+`OnInterval`
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "delay": number,
+      "interval": number,
+      "enabled": bool
+    }
+  }}}
+}}}
+{{{#!td
+TODO
+}}}
+{{{#!td
+
+}}}
+|----------------
+{{{#!td
+`OnRange`
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "entities": [entityId],
+      "players": [playerId],
+      "minRange": number,
+      "maxRange": number,
+      "requiredComponent": componentId,
+      "enabled": bool
+    }
+  }}}
+}}}
+{{{#!td
+  {{{#!js
+    {
+      "added": [entityId],
+      "removed": [entityId],
+      "currenctCollection": [entityId]
+    }
+  }}}
+}}}
+{{{#!td
+
+}}}