Revision as of 21:14, 17 April 2016

File:Titans-icon.png Planetary Annihilation mods API

Returns a list of mounted mod in context.

context	mandatory	string	client or server
callback	mandatory	function(data)	data contains an array of modinfo objects

api.mods.getMountedMods('client',function(data){console.log(data);});

Returns a promise for a list of mounted mods in context.

context	mandatory	string	client or server
raw	optional	boolean	true to return full modinfo objects
returns		promise	object with a single property mounted_mods which contains an array of modinfo objects

api.mods.getMounted('client',true).always(function(data){console.log(data);});

@@ Line 24: / Line 24: @@
 == api.mods.getMounted( context, raw ) ==
-returns a promise for a list of mounted mods in context:
+Returns a promise for a list of mounted mods in context.
-* context: client or server string
-* raw: boolean (use true to return full modinfo)
-promise data contains an object with a single property mounted_mods which contains an array of modinfo objects.
+{| class="wikitable"
+!context
+|mandatory
+|string
+|client or server
+|-
+!raw
+|optional
+|boolean
+|true to return full modinfo objects
+|-
+!returns
+|
+|promise
+|object with a single property mounted_mods which contains an array of modinfo objects
+|}
-Example: api.mods.getMounted('client',true).always(function(data){console.log(data);});
+<pre>api.mods.getMounted('client',true).always(function(data){console.log(data);});</pre>