Documentation updates

Author: PseudoKnight

src/main/java/com/laytonsmith/core/functions/EntityManagement.java

@@ -590,7 +590,7 @@ public String getName() {
 
 		@Override
 		public String docs() {
-			return "mixed {entityID} Returns the EntityType of the entity with the specified ID."
+			return "string {entityID} Returns the EntityType of the entity with the specified ID."
 					+ " Returns null if the entity does not exist.";
 		}
 
@@ -1272,7 +1272,7 @@ public String getName() {
 
 		@Override
 		public String docs() {
-			return "mixed {entityID} Returns the ID of the given entity's rider, or null if it doesn't have one.";
+			return "string {entityID} Returns the ID of the given entity's rider, or null if it doesn't have one.";
 		}
 
 		@Override
@@ -1300,7 +1300,7 @@ public String getName() {
 
 		@Override
 		public String docs() {
-			return "mixed {entityID} Returns the ID of the given entity's vehicle, or null if it doesn't have one. ----"
+			return "string {entityID} Returns the ID of the given entity's vehicle, or null if it doesn't have one. ----"
 					+ " If the entity is on top of a stack of other entities, this returns the bottom most entity"
 					+ " on Bukkit versions 1.9 through much of 1.12.2. This was a bug. It returns the direct entity"
 					+ " underneath on other versions.";

src/main/java/com/laytonsmith/core/functions/InventoryManagement.java

@@ -47,6 +47,12 @@ public static String docs() {
 		return "Provides methods for managing inventory related tasks.";
 	}
 
+	private static final String ITEM_OBJECT = " An item object consists of an associative array with the following keys,"
+			+ " name: the string id of the item,"
+			+ " type: The numeric id of the item (deprecated),"
+			+ " data: The data value of the item, or the damage if a damageable item,"
+			+ " qty: The number of items in their inventory,"
+			+ " meta: An array of item meta or null if none exists (see {{function|get_itemmeta}} for details).";
 	@api(environments = {CommandHelperEnvironment.class})
 	public static class pinv extends AbstractFunction {
 
@@ -62,19 +68,15 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {[player, [slot]]} Gets the inventory information for the specified player, or the current "
+			return "array {[player, [slot]]} Gets the inventory information for the specified player, or the current "
 					+ " player if none specified. If the index is specified, only the slot given will be returned."
 					+ " The index of the array in the array is 0 - 35, 100 - 103, -106, which corresponds to the slot"
 					+ " in the player's inventory. To access armor slots, you may also specify the index. (100 - 103)."
 					+ " The quick bar is 0 - 8. If index is null, the item in the player's hand is returned, regardless"
 					+ " of what slot is selected. If index is -106, the player's off-hand item is returned. If there is"
 					+ " no item at the slot specified, null is returned."
 					+ " ---- If all slots are requested, an associative array of item objects is returned, and if"
-					+ " only one item is requested, just that single item object is returned. An item object"
-					+ " consists of the following associative array(name: the string id of the item,"
-					+ " type: The numeric id of the item, data: The data value of the item,"
-					+ " or the damage if a damagable item, qty: The number of items in their inventory, meta: An array"
-					+ " of item meta or null if none exists. See {{function|get_itemmeta}} for details about item meta.";
+					+ " only one item is requested, just that single item object is returned." + ITEM_OBJECT;
 		}
 
 		@Override
@@ -442,8 +444,7 @@ public String docs() {
 					+ " second slot to be a stack of stone. set_pinv(array(103: array(type: 298))) gives them a hat."
 					+ " To set the item in hand, use something like set_pinv(player(), null, array(type: 298))."
 					+ " If you set a null key in an inventory array, only one of the items will be used (which one is"
-					+ " undefined). Use an index of -106 to set the item in the player's off-hand. The type key"
-					+ " supports the string item format (eg. \"35:11\") for convenience and backwards compatibility.";
+					+ " undefined). Use an index of -106 to set the item in the player's off-hand.";
 
 		}
 
@@ -1203,9 +1204,7 @@ public String docs() {
 					+ " enderchest would be: set_penderchest(array(2: array(type: 1, qty: 64))) This sets the chest's second slot"
 					+ " to be a stack of stone. set_penderchest(array(103: array(type: 298))) gives them a hat."
 					+ " Note that this uses the unsafe"
-					+ " enchantment mechanism to add enchantments, so any enchantment value will work. If"
-					+ " type uses the old format (for instance, \"35:11\"), then the second number is taken"
-					+ " to be the data, making this backwards compatible (and sometimes more convenient).";
+					+ " enchantment mechanism to add enchantments, so any enchantment value will work.";
 
 		}
 
@@ -1301,16 +1300,12 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {[player, [index]]} Gets the inventory information for the specified player's enderchest, or the current player if none specified. If the index is specified, only the slot "
-					+ " given will be returned."
-					+ " The index of the array in the array is 0 - 26, which corresponds to the slot in the enderchest inventory."
-					+ " If there is no item at the slot specified, null is returned."
+			return "array {[player, [index]]} Gets the inventory for the specified player's enderchest, or the current"
+					+ " player if none specified. If the index is specified, only the slot given will be returned."
+					+ " The index of the array in the array is 0 - 26, which corresponds to the slot in the enderchest"
+					+ " inventory. If there is no item at the slot specified, null is returned."
 					+ " ---- If all slots are requested, an associative array of item objects is returned, and if"
-					+ " only one item is requested, just that single item object is returned. An item object"
-					+ " consists of the following associative array(type: The id of the item, data: The data value of the item,"
-					+ " or the damage if a damagable item, qty: The number of items in their inventory, enchants: An array"
-					+ " of enchant objects, with 0 or more associative arrays which look like:"
-					+ " array(etype: The type of enchantment, elevel: The strength of the enchantment))";
+					+ " only one item is requested, just that single item object is returned." + ITEM_OBJECT;
 		}
 
 		@Override
@@ -1749,16 +1744,12 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {entityID, [index] | locationArray, [index]} Gets the inventory information for the specified block or entity."
+			return "array {entityID, [index] | locationArray, [index]} Gets the inventory for the specified block or entity."
 					+ " If the block or entity can't have an inventory, a FormatException is thrown. If the index is specified,"
-					+ " only the slot given will be returned. The max index of the array in the array is different for different types"
-					+ " of inventories. If there is no item at the slot specified, null is returned."
+					+ " only the slot given will be returned. The max index of the array in the array is different for"
+					+ " different types of inventories. If there is no item at the slot specified, null is returned."
 					+ " ---- If all slots are requested, an associative array of item objects is returned, and if"
-					+ " only one item is requested, just that single item object is returned. An item object"
-					+ " consists of the following associative array(type: The id of the item, data: The data value of the item,"
-					+ " or the damage if a damagable item, qty: The number of items in their inventory, enchants: An array"
-					+ " of enchant objects, with 0 or more associative arrays which look like:"
-					+ " array(etype: The type of enchantment, elevel: The strength of the enchantment))";
+					+ " only one item is requested, just that single item object is returned." + ITEM_OBJECT;
 		}
 
 		@Override
@@ -1835,9 +1826,7 @@ public String docs() {
 					+ " and it is skipped, but the function will not fail as a whole. A simple way to set one item would be:"
 					+ " set_inventory(123, array(2: array(type: 1, qty: 64))) This sets the inventory second slot"
 					+ " to be a stack of stone for entity with ID = 123. Note that this uses the unsafe"
-					+ " enchantment mechanism to add enchantments, so any enchantment value will work. If"
-					+ " type uses the old format (for instance, \"35:11\"), then the second number is taken"
-					+ " to be the data, making this backwards compatible (and sometimes more convenient).";
+					+ " enchantment mechanism to add enchantments, so any enchantment value will work.";
 
 		}
 

src/main/java/com/laytonsmith/core/functions/ItemMeta.java

@@ -40,18 +40,26 @@ public static String docs() {
 	}
 
 	private static final String applicableItemMeta = "<ul>"
-			+ "<li>All items - display (string), lore (array of strings), enchants (An array of enchantment arrays, "
-			+ " which are associative arrays that look like: array(etype: The type of enchantment, elevel:"
-			+ " The strength of the enchantment)), repair (int, repair cost), flags(array). Possible flags: "
-			+ StringUtils.Join(MCItemFlag.values(), ", ", " or ") + "</li>"
-			+ "<li>Books - title (string), author (string), pages (array of strings)</li>"
-			+ "<li>EnchantedBooks - stored (array of enchantment arrays (see Example))</li>"
-			+ "<li>Leather Armor - color (color array (see Example))</li>"
-			+ "<li>Skulls - owner (string) NOTE: the visual change only applies to player skulls</li>"
-			+ "<li>Potions - potions (array of potion arrays), main(int, the id of the main effect)</li>"
-			+ "<li>Banners - basecolor (string), patterns (array of pattern arrays)</li>"
-			+ "<li>Fireworks - firework (array with strength (int), effects (array of effect arrays (see Example)))</li>"
-			+ "<li>Firework Charges - effect (single Firework effect array)"
+			+ "<li>All items - \"display\" (string), \"lore\" (array of strings), \"enchants\" (An array of enchantment"
+			+ " arrays, which are associative arrays that look like: array(\"etype\": The type of enchantment, \"elevel\":"
+			+ " The strength of the enchantment)), \"repair\" (int, repair cost), \"unbreakable\" (boolean), \"flags\""
+			+ " (array). Possible flags: " + StringUtils.Join(MCItemFlag.values(), ", ", " or ") + "</li>"
+			+ "<li>Books - \"title\" (string), author (string), \"pages\" (array of strings)</li>"
+			+ "<li>EnchantedBooks - \"stored\" (array of enchantment arrays (see Example))</li>"
+			+ "<li>Leather Armor - \"color\" (color array (see Example))</li>"
+			+ "<li>Player Skulls - \"owner\" (string) or \"owneruuid\" (string)</li>"
+			+ "<li>Potions - \"potions\" (array of potion arrays), \"base\" (an array with the keys \"type\","
+			+ " \"extended\", and \"upgraded\")</li>"
+			+ "<li>Banners - \"basecolor\" (string), \"patterns\" (an array of pattern arrays, each with the keys"
+			+ " \"shape\" and \"color\")</li>"
+			+ "<li>Fireworks - \"firework\" (array with strength (int), \"effects\" (array of effect arrays (see Example)))</li>"
+			+ "<li>Firework Charges - \"effect\" (single Firework effect array)</li>"
+			+ "<li>Storage Blocks - \"inventory\" (an array of item arrays)</li>"
+			+ "<li>Mob Eggs/Spawners - \"spawntype\" (an entity type)</li>"
+			+ "<li>Furnace - \"burntime\" (int), \"cooktime\" (int), and in \"inventory\" these keys can exist if an"
+			+ " item exists in that slot: \"result\", \"fuel\", and \"smelting\".</li>"
+			+ "<li>Brewing Stand - \"brewtime\" (int), \"fuel\" (int), and in \"inventory\" these keys can exist if an"
+			+ " item exists in that slot: \"fuel\", \"ingredient\", \"leftbottle\", \"middlebottle\", and \"rightbottle\".</li>"
 			+ "</ul>";
 
 	@api(environments = {CommandHelperEnvironment.class})
@@ -107,7 +115,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {[player,] inventorySlot} Returns an associative array of known ItemMeta for the slot given,"
+			return "array {[player,] inventorySlot} Returns an associative array of known ItemMeta for the slot given,"
 					+ " or null if there isn't any. All items can have a display(name), lore, and/or enchants, "
 					+ " and more info will be available for the items that have it. ---- Returned keys: "
 					+ applicableItemMeta;

src/main/java/com/laytonsmith/core/functions/Meta.java

@@ -597,7 +597,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {} Gets the command (as a string) that ended up triggering this script, exactly"
+			return "string {} Gets the command (as a string) that ended up triggering this script, exactly"
 					+ " how it was entered by the player. This could be null, if for instance"
 					+ " it is called from within an event.";
 		}

src/main/java/com/laytonsmith/core/functions/Persistence.java

@@ -150,7 +150,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "Mixed {[namespace, ...,] key} Returns a stored value stored with store_value. If the key doesn't exist in storage, null"
+			return "mixed {[namespace, ...,] key} Returns a stored value stored with store_value. If the key doesn't exist in storage, null"
 					+ " is returned. On a more detailed note: If the value stored in the persistence database is not actually a construct,"
 					+ " then null is also returned.";
 		}

src/main/java/com/laytonsmith/core/functions/PlayerManagement.java

@@ -4546,7 +4546,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {[player]} Returns ID of vehicle which player is in or null if player is outside the vehicle";
+			return "string {[player]} Returns ID of vehicle which player is in or null if player is outside the vehicle";
 		}
 
 		@Override

src/main/resources/docs/Compatibility

@@ -1,6 +1,6 @@
 This page lists compatibility of various milestone versions of CommandHelper. Note that this chart was created starting with build 1498, so earlier builds may not be accurate. In general, the compatibility requirements, if not listed, are the same as the previous milestone build. The minimum requirements for the current builds are:
 
-* Java 7
+* Java 8
 * Bukkit version as specified below (when used as a Bukkit plugin)
 
 Also note that CommandHelper may still be backwards and forward compatible to a large degree, many of the advanced features that normally have hard dependencies on certain versions of external dependencies have been configured to "soft" fail, that is, individual components may not work, but in general the plugin should continue to function. Regardless, only the most current dev builds are officially supported.
@@ -13,8 +13,8 @@ Also note that CommandHelper may still be backwards and forward compatible to a
 ! scope="col" width="40%" | Milestone
 ! scope="col" width="50%" | Compatibility
 |-
-| ??
-| ??
+| [http://builds.enginehub.org/job/commandhelper/10106 #3345-]
+| [https://github.com/EngineHub/CommandHelper/commit/40dc779ee121f771b1ac643e5d180365bec2ac80 40dc779e]
 | Updated several dependencies
 * com.jcraft:jsch ..................................... 0.1.51 -> 0.1.54
 * commons-codec:commons-codec .............................. 1.9 -> 1.11
@@ -27,29 +27,44 @@ Also note that CommandHelper may still be backwards and forward compatible to a
 * org.yaml:snakeyaml ...................................... 1.13 -> 1.20
 * redis.clients:jedis ................................... 2.5.1 -> 2.9.0
 |-
+| [http://builds.enginehub.org/job/commandhelper/9952 #3260-]
+| [https://github.com/EngineHub/commandhelper/commit/7450f62119a36d03c12620913e4ede4728da68e1 7450f621]
+| Removed remaining backwards compatibility for versions prior to 1.7.10
+| Bukkit 1.7.10 - 1.12.2
+|-
 | [http://builds.enginehub.org/job/commandhelper/9876 #3219-]
 | [https://github.com/EngineHub/CommandHelper/commit/4d970d0dc2edb1a7a648904df01af148bba761e1 4d970d0]
-| Updated for Spigot 1.12.1
-| Spigot 1.7.8 - 1.12.1
+| Updated for Bukkit 1.12.1
+| Bukkit 1.7.8 - 1.12.1
+|-
+| [http://builds.enginehub.org/job/commandhelper/8735 #3091-]
+| [https://github.com/sk89q/commandhelper/commit/8086fe6a80b7ee2b2250d775a7f0c4a711127aa2 8086fe]
+| Finished updating for Bukkit 1.9
+| Bukkit 1.7.8 - 1.9.0
+|-
+| [http://builds.enginehub.org/job/commandhelper/8450 #3040-]
+| [https://github.com/sk89q/commandhelper/commit/8b08d139216fd13519ceb5d85ca195c77e41aca1 8b08d139]
+| 3.3.2 snapshots start. All extensions need to be updated.
+| Bukkit 1.7.8 - 1.8.8
 |-
 | [http://builds.enginehub.org/job/commandhelper/7014 #2895-]
 | [https://github.com/sk89q/commandhelper/commit/6304f912f0be41e3522e0ae4191b1319ef8a8b89 6304f91]
-| Should still be compatible with former build
-| Spigot 1.7.6 - 1.8.6
+| Updated for Bukkit 1.8.6
+| Bukkit 1.7.6 - 1.8.6
 |-
 | [http://builds.enginehub.org/job/commandhelper/6821 #2857-]
 | [https://github.com/sk89q/commandhelper/commit/f8953eb485a6689299381c8f644ea16fb92e9853 f8953eb]
-| Removed WorldEdit dependency (See SKCompat extension)
+| Removed WorldEdit dependency (See https://letsbuild.net/jenkins/job/SKCompat/ SKCompat] extension)
 |-
 | [http://builds.enginehub.org/job/commandhelper/6776 #2842-]
 | [https://github.com/sk89q/commandhelper/commit/4b485fd208f2b43d0e5bae71c74b48b212dc0140 4b485fd]
-| Removed vault dependency (See CHVault extension)
+| Removed vault dependency (See [https://letsbuild.net/jenkins/job/CHVault/ CHVault] extension)
 |-
 | [http://builds.enginehub.org/job/commandhelper/6492 #2802-]
 | [https://github.com/sk89q/CommandHelper/commit/cc0f80e9983b13c2ff6f643fbbc441f8f86268e8 cc0f80e]
-| Updated for Spigot 1.8.
+| Updated for Bukkit 1.8
 * Vault 1.4
-| Spigot 1.7.2 - 1.8
+| Bukkit 1.7.2 - 1.8.0
 |-
 | [http://builds.enginehub.org/job/commandhelper/5115/ #2717-aca997c]
 | [https://github.com/sk89q/commandhelper/commit/aca997cf7a09f00a92cd46aefc3a8f44f478a3d5 aca997c]
@@ -63,17 +78,17 @@ Also note that CommandHelper may still be backwards and forward compatible to a
 * mysql-connector-java 5.1.30
 * jedis: 2.5.1
 |-
-| [http://builds.enginehub.org/job/commandhelper/5114/ #2716-512d9d3]
+| [http://builds.enginehub.org/job/commandhelper/5114/ #2716-]
 | [https://github.com/sk89q/commandhelper/commit/484c0645d302e22b8eec815acb54b91ea31c3b10 484c064]
 | Updated for Minecraft 1.7.9 (should still be compatible with 1.7.2 builds, excepting that Sound.BREATH and Sound.HURT have been removed).
 | Bukkit 1.7.2 - 1.7.9
 |-
-| [http://builds.enginehub.org/job/commandhelper/4876/ #2681-773d877]
+| [http://builds.enginehub.org/job/commandhelper/4876/ #2681-]
 | [https://github.com/sk89q/commandhelper/commit/773d877048514bb422b1e8755c9520ac99d9852a 773d877]
 | Updated to Minecraft 1.7.8 (should still be compatible with 1.7.2 builds, however)
 | Bukkit 1.7.2 - 1.7.8
 |-
-| [http://builds.enginehub.org/job/commandhelper/3463/ #2445-8c4b165]
+| [http://builds.enginehub.org/job/commandhelper/3463/ #2445-]
 | [https://github.com/sk89q/commandhelper/commit/8c4b1652ed5c43dddb95c7e6612aea072716aea5 8c4b165]
 | Updated to Minecraft 1.7.2
 | Bukkit 1.7.2

src/main/resources/docs/Logic

@@ -279,7 +279,7 @@ Had we left the break() out, case 2 and the default case would have merged toget
 
 {{TakeNote|text=While break() is in fact optional, it is still recommended that you use it when applicable.}}
 
-Using break() is still recommeneded however, even though it is technically optional. Consider the following example.
+Using break() is still recommended however, even though it is technically optional. Consider the following example.
 
 %%CODE|
 switch(@v){