Changes between Initial Version and Version 1 of Cheat_Templates

Timestamp:

May 4, 2014, 5:24:37 AM (10 years ago)

Author:

leper

Comment:

Initial version

Cheat_Templates

@@ +1 @@
+Cheat template files use the [wiki:JSON JSON] format and are put in [source:/ps/trunk/binaries/data/mods/public/simulation/data/cheats simulation/data/cheats] (see [wiki:Mod_Layout mod layout]).
+
+The basic format is:
+{{{
+#!js
+{
+        "Name": "i want pizza",
+        "Data": {
+                "Action": "addresource",
+                "Type": "food",
+                "DefaultParameter": 1000,
+                "isNumeric": true,
+                "Templates": []
+        }
+}
+}}}
+
+'''Name''' is the string which has to be entered in the chat to execute the '''Action''' (if cheats are enabled). The code which decides what to do (based on the '''Action''' is [source:/ps/trunk/binaries/data/mods/public/simulation/helpers/Cheat.js Cheat.js].
+
+'''Type''': '''Optional''' passed as an additional parameter (to differentiate between similar actions).
+
+'''!DefaultParameter''': '''Optional'''. If this is defined the cheat takes an additional parameter. The default, which is used if no additional parameter is provided is the value of '''!DefaultParameter'''.
+
+'''isNumeric''': '''Optional''', only used iff the cheat takes a parameter. If true the parameter is passed as a number, else it is passed as a string. Only positive integers are currently passed on.
+
+'''Templates''': '''Optional'''. Array of templates that the cheat uses (eg [source:/ps/trunk/binaries/data/mods/public/simulation/data/cheats/createPlane.json createPlane.json]).