Pulling all pending Bukkit-JavaDoc changes
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
@@ -24,7 +24,7 @@ import org.bukkit.plugin.messaging.PluginMessageRecipient;
|
||||
public interface Player extends HumanEntity, Conversable, CommandSender, OfflinePlayer, PluginMessageRecipient {
|
||||
/**
|
||||
* Gets the "friendly" name to display of this player. This may include color.
|
||||
* <p />
|
||||
* <p>
|
||||
* Note that this name will not be displayed in game, only in chat and places
|
||||
* defined by plugins
|
||||
*
|
||||
@@ -34,7 +34,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Sets the "friendly" name to display of this player. This may include color.
|
||||
* <p />
|
||||
* <p>
|
||||
* Note that this name will not be displayed in game, only in chat and places
|
||||
* defined by plugins
|
||||
*
|
||||
@@ -51,11 +51,11 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Sets the name that is shown on the in-game player list.
|
||||
* <p />
|
||||
* <p>
|
||||
* The name cannot be longer than 16 characters, but {@link ChatColor} is supported.
|
||||
* <p />
|
||||
* <p>
|
||||
* If the value is null, the name will be identical to {@link #getName()}.
|
||||
* <p />
|
||||
* <p>
|
||||
* This name is case sensitive and unique, two names with different casing will
|
||||
* appear as two different people. If a player joins afterwards with
|
||||
* a name that conflicts with a player's custom list name, the
|
||||
@@ -155,7 +155,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Loads the players current location, health, inventory, motion, and other information from the username.dat file, in the world/player folder
|
||||
* <p />
|
||||
* <p>
|
||||
* Note: This will overwrite the players current inventory, health, motion, etc, with the state from the saved dat file.
|
||||
*/
|
||||
public void loadData();
|
||||
@@ -202,7 +202,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Play a sound for a player at the location.
|
||||
* <p />
|
||||
* <p>
|
||||
* This function will fail silently if Location or Sound are null.
|
||||
*
|
||||
* @param location The location to play the sound
|
||||
@@ -244,7 +244,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
* Send a chunk change. This fakes a chunk change packet for a user at
|
||||
* a certain location. The updated cuboid must be entirely within a single
|
||||
* chunk. This will not actually change the world in any way.
|
||||
* <p />
|
||||
* <p>
|
||||
* At least one of the dimensions of the cuboid must be even. The size of the
|
||||
* data buffer must be 2.5*sx*sy*sz and formatted in accordance with the Packet51
|
||||
* format.
|
||||
@@ -270,7 +270,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Render a map and send it to the player in its entirety. This may be used
|
||||
* when streaming the map in the normal manner is not desirbale.
|
||||
* when streaming the map in the normal manner is not desirable.
|
||||
*
|
||||
* @param map The map to be sent
|
||||
*/
|
||||
@@ -326,7 +326,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
/**
|
||||
* Sets the current time on the player's client. When relative is true the player's time
|
||||
* will be kept synchronized to its world time with the specified offset.
|
||||
* <p />
|
||||
* <p>
|
||||
* When using non relative time the player's time will stay fixed at the specified time parameter. It's up to
|
||||
* the caller to continue updating the player's time. To restore player time to normal use resetPlayerTime().
|
||||
*
|
||||
@@ -403,7 +403,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Gets the players current experience points towards the next level.
|
||||
* <p />
|
||||
* <p>
|
||||
* This is a percentage value. 0 is "no progress" and 1 is "next level".
|
||||
*
|
||||
* @return Current experience points
|
||||
@@ -412,7 +412,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Sets the players current experience points towards the next level
|
||||
* <p />
|
||||
* <p>
|
||||
* This is a percentage value. 0 is "no progress" and 1 is "next level".
|
||||
*
|
||||
* @param exp New experience points
|
||||
@@ -449,7 +449,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Gets the players current exhaustion level.
|
||||
* <p />
|
||||
* <p>
|
||||
* Exhaustion controls how fast the food level drops. While you have a certain
|
||||
* amount of exhaustion, your saturation will drop to zero, and then your food
|
||||
* will drop to zero.
|
||||
@@ -467,7 +467,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Gets the players current saturation level.
|
||||
* <p />
|
||||
* <p>
|
||||
* Saturation is a buffer for food level. Your food level will not drop if you
|
||||
* are saturated > 0.
|
||||
*
|
||||
@@ -606,14 +606,14 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
|
||||
|
||||
/**
|
||||
* Request that the player's client download and switch texture packs.
|
||||
* <p />
|
||||
* <p>
|
||||
* The player's client will download the new texture pack asynchronously in the background, and
|
||||
* will automatically switch to it once the download is complete. If the client has downloaded
|
||||
* and cached the same texture pack in the past, it will perform a quick timestamp check over
|
||||
* the network to determine if the texture pack has changed and needs to be downloaded again.
|
||||
* When this request is sent for the very first time from a given server, the client will first
|
||||
* display a confirmation GUI to the player before proceeding with the download.
|
||||
* <p />
|
||||
* <p>
|
||||
* Notes:
|
||||
* <ul>
|
||||
* <li>Players can disable server textures on their client, in which case this method will have no affect on them.</li>
|
||||
|
||||
Reference in New Issue
Block a user