Use locationArray more consistently in function docs

Author: PseudoKnight

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

@@ -44,9 +44,6 @@
 import com.laytonsmith.core.exceptions.CancelCommandException;
 import com.laytonsmith.core.exceptions.ConfigRuntimeException;
 
-/**
- *
- */
 public class Environment {
 
 	public static String docs() {
@@ -68,7 +65,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "string {x, y, z, [world] | xyzArray, [world]} Gets the id of the block at the coordinates. The format"
+			return "string {x, y, z, [world] | locationArray, [world]} Gets the id of the block at the coordinates. The format"
 					+ " of the return will be x:y where x is the id of the block, and y is the meta data for the block."
 					+ " All blocks will return in this format, but blocks that don't have meta data will return 0 in y"
 					+ " (eg. air is \"0:0\"). If a world isn't provided in the location array or as an argument, the"
@@ -268,7 +265,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "void {xyzLocation, lineArray | xyzLocation, line1, [line2, [line3, [line4]]]}"
+			return "void {locationArray, lineArray | locationArray, line1, [line2, [line3, [line4]]]}"
 					+ " Sets the text of the sign at the given location. If the block at x,y,z isn't a sign,"
 					+ " a RangeException is thrown. If the text on a line overflows 15 characters, it is simply"
 					+ " truncated.";
@@ -363,8 +360,8 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "array {xyzLocation} Given a location array, returns an array of 4 strings of the text in the sign at that"
-					+ " location. If the location given isn't a sign, then a RangeException is thrown.";
+			return "array {locationArray} Given a location array, returns an array of 4 strings of the text in the sign"
+					+ " at that location. If the location given isn't a sign, then a RangeException is thrown.";
 		}
 
 		@Override
@@ -423,7 +420,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "boolean {xyzLocation} Returns true if the block at this location is a sign.";
+			return "boolean {locationArray} Returns true if the block at this location is a sign.";
 		}
 
 		@Override
@@ -473,8 +470,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "void {locationArray} Mostly simulates a block break at a location. Does not trigger an event. Only works with"
-					+ " craftbukkit.";
+			return "void {locationArray} Mostly simulates a block break at a location. Does not trigger an event.";
 		}
 
 		@Override
@@ -604,8 +600,8 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "string {x, z, [world] | locationArray} Returns the biome type of this block column. The location array's"
-					+ " y value is ignored. ---- The value returned"
+			return "string {x, z, [world] | locationArray} Returns the biome type of this block column. The location"
+					+ " array's y value is ignored. ---- The value returned"
 					+ " may be one of the following: " + StringUtils.Join(MCBiomeType.types(), ", ", ", or ");
 		}
 
@@ -677,7 +673,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "array {x, z, [world] | xyzArray, [world]} Gets the xyz of the highest block at a x and a z."
+			return "array {x, z, [world] | locationArray, [world]} Gets the xyz of the highest block at a x and a z."
 					+ "It works the same as get_block_at, except that it doesn't matter now what the Y is."
 					+ "You can set it to -1000 or to 92374 it will just be ignored.";
 		}
@@ -760,11 +756,11 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "void {Locationarray, [size], [safe]} Creates an explosion with the given size at the given location."
-					+ "Size defaults to size of a creeper (3), and null uses the default. If safe is true, (defaults to false)"
-					+ " the explosion"
-					+ " won't hurt the surrounding blocks. If size is 0, and safe is true, you will still see the animation"
-					+ " and hear the sound, but players won't be hurt, and neither will the blocks.";
+			return "void {locationArray, [size], [safe]} Creates an explosion with a given size at a given location."
+					+ " Size defaults to size of a creeper (3), and null uses the default. If safe is true,"
+					+ " (defaults to false) the explosion won't hurt the surrounding blocks. If size is 0, and safe is"
+					+ " true, you will still see the animation and hear the sound, but players won't be hurt, and"
+					+ " neither will the blocks.";
 		}
 
 		@Override
@@ -933,7 +929,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "void {[player], instrument, note, [location]} Plays a note for the given player, at the given location."
+			return "void {[player], instrument, note, [locationArray]} Plays a note for the given player, at the given location."
 					+ " Player defaults to the current player, and location defaults to the player's location. Instrument may be one of:"
 					+ " " + StringUtils.Join(MCInstrument.values(), ", ", ", or ") + ", and note is an associative array with 2 values,"
 					+ " array(octave: 0, tone: 'F#') where octave is either 0, 1, or 2, and tone is one of the notes "

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

@@ -324,7 +324,7 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "void {xyzArray, effect, [radius]} Plays the specified effect (sound effect) at the given location, for all players within"
+			return "void {locationArray, effect, [radius]} Plays the specified effect (sound effect) at the given location, for all players within"
 					+ " the radius (or 64 by default). The effect can be one of the following: "
 					+ StringUtils.Join(MCEffect.values(), ", ", ", or ", " or ")
 					+ ". Additional data can be supplied with the syntax EFFECT:DATA. The RECORD_PLAY effect takes the item"

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

@@ -826,24 +826,35 @@ public Integer[] numArgs() {
 
 		@Override
 		public String docs() {
-			return "mixed {[pName], [value]} Returns various information about the player specified, or the current player if no argument was given. ---- "
-					+ "If value is set, it should be an integer of one of the following indexes, and only that information for that index"
-					+ " will be returned. Otherwise if value is not specified (or is -1), it returns an array of"
-					+ " information with the following pieces of information in the specified index: "
-					+ "<ul><li>0 - player's name; This will return the player's exact name, "
-					+ " even if called with a partial match.</li><li>1 - player's location; an array of the player's xyz coordinates</li><li>2 - player's cursor; an array of the "
-					+ "location of the player's cursor, or null if the block is out of sight.</li><li>3 - player's IP; Returns the IP address of this player.</li><li>4 - Display name; The name that is used when the"
-					+ " player's name is displayed on screen typically. </li><li>5 - player's health; Gets the current health of the player, which will be an int"
-					+ " from 0-20.</li><li>6 - Item in hand; The value returned by this will be similar to the value returned by get_block_at()</li><li>7 - "
-					+ "World name; Gets the name of the world this player is in.</li><li>8 - Is Op; true or false if this player is an op.</li><li>9 - player groups;"
-					+ " An array of the permissions groups the player is in.</li><li>10 - The player's hostname (or IP if a hostname can't be found)</li>"
-					+ " <li>11 - Is sneaking?</li><li>12 - Host; The host the player connected to.</li>"
-					+ " <li>13 - Player UUID (This is the same as 20, but is left in for backwards compatibility reasons.)</li>"
-					+ " <li>14 - Is player in a vehicle? Returns true or false.</li>"
-					+ " <li>15 - The slot number of the player's current hand.</li>"
-					+ " <li>16 - Is sleeping?</li><li>17 - Is blocking?</li><li>18 - Is flying?</li><li>19 - Is sprinting?</li>"
-					+ " <li>20 - Player UUID"
-					+ " </ul>";
+			return "mixed {[player], [value]} Returns various information about the player specified, or the current"
+					+ " player if no argument was given. ----"
+					+ " If value is set, it should be an integer of one of the following indexes, and only that"
+					+ " information for that index will be returned. Otherwise if value is not specified (or is -1), it"
+					+ " returns an array of information with the following pieces of information in the specified index:"
+					+ "<ul>"
+					+ "<li>0 - player's name; This will return the player's exact name,"
+					+ " even if called with a partial match.</li>"
+					+ "<li>1 - player's location; a location array of the player's coordinates</li>"
+					+ "<li>2 - player's cursor; an array of the location of the player's cursor,"
+					+ " or null if the block is out of sight.</li>"
+					+ "<li>3 - player's IP; Returns the IP address of this player.</li>"
+					+ "<li>4 - Display name; The name that is typically used when displayed on screen.</li>"
+					+ "<li>5 - player's health; The current health of the player, which will be an int from 0-20.</li>"
+					+ "<li>6 - Item in hand; The type and data for the item in the 0:0 format. (deprecated)</li>"
+					+ "<li>7 - World name; Gets the name of the world this player is in.</li>"
+					+ "<li>8 - Is Op; true or false if this player is an op.</li>"
+					+ "<li>9 - player groups; An array of the groups the player is in, by permission nodes.</li>"
+					+ "<li>10 - The player's hostname (or IP if a hostname can't be found)</li>"
+					+ "<li>11 - Is sneaking?</li><li>12 - Host; The host the player connected to.</li>"
+					+ "<li>13 - Player UUID; (This is the same as 20, but exists for backwards compatibility.)</li>"
+					+ "<li>14 - Is player in a vehicle? Returns true or false.</li>"
+					+ "<li>15 - Held Slot; The slot number of the player's current hand.</li>"
+					+ "<li>16 - Is sleeping?</li>"
+					+ "<li>17 - Is blocking?</li>"
+					+ "<li>18 - Is flying?</li>"
+					+ "<li>19 - Is sprinting?</li>"
+					+ "<li>20 - Player UUID; The unique identifier for this player's account as returned by puuid()."
+					+ "</ul>";
 		}
 
 		@Override