Merge pull request #70 from FreezePhoenix/patch-5

Implement equip_batch

docs/directory.py

@@ -63,6 +63,7 @@ docs={
 		"sell",
 		"consume",
 		"equip",
+		"equip_batch",
 		"unequip",
 		"lock_item",
 		"seal_item",
@@ -160,6 +161,7 @@ docs={
 		"is_array",
 	],
 	"documented":[
+		"equip_batch",
 		"attack",
 		"heal",
 		"buy",
@@ -338,4 +340,4 @@ docs={
 	}
 }
 
-docs["functions"].sort()
+docs["functions"].sort()

docs/functions/equip_batch.html

@@ -0,0 +1,47 @@
+<p>
+	Arguments:
+	<div>&nbsp;<b>*</b> Array - An array of equip definitions</div>
+</p>
+<p>
+	Returns:
+	<div>&nbsp; <b>*</b> Promise</div>
+</p>
+
+<p>Example usages:</p>
+
+<div class='code'>
+equip_batch([{ num: 0, slot: "chest" }, { num: 1, slot: "orb" }]);
+equip_batch([{ num: 0, slot: "chest" }, { num: 1, slot: "orb" }]).then(
+	function(data){
+		game_log("Yes!"); // Not all items may have been equipped. All this means is that you send the correct layout of data.
+	}, 
+    function(data) {
+    	game_log("equip_batch failed: " + data.reason);
+	},
+);
+</div>
+
+<p>Promise Reference:</p>
+
+<span class='dlabel'>"resolve"</span>
+<div class='code'>
+{
+	place: "equip_batch",
+    response: "data",
+    slots: [{ num: 0, slot: "chest" }, "no_item"] // Note that even though equipping the orb failed, we still received a success response.
+}
+</div>
+<div style='margin-bottom: 10px'></div>
+
+<span class='dlabel'>"reject"</span>
+<div class='code'>
+{
+	place: "equip_batch",
+    failed: true,
+    response: "invalid",
+    reason: "invalid", // You didn't send an array.
+}
+</div>
+
+<p></p>
+<span class='redlabel'>"source"</span>