Many javadoc fixes thanks to Celtic Minstrel
By: Dinnerbone <dinnerbone@dinnerbone.com>
This commit is contained in:
@@ -33,14 +33,14 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* Note that this name will not be displayed in game, only in chat and places
|
||||
* defined by plugins
|
||||
*
|
||||
* @param name
|
||||
* @param name The new display name.
|
||||
*/
|
||||
public void setDisplayName(String name);
|
||||
|
||||
/**
|
||||
* Set the target of the player's compass.
|
||||
*
|
||||
* @param loc
|
||||
* @param loc Location to point to
|
||||
*/
|
||||
public void setCompassTarget(Location loc);
|
||||
|
||||
@@ -130,14 +130,14 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* next day. If everyone has this flag set but no one is actually in bed,
|
||||
* then nothing will happen.
|
||||
*
|
||||
* @param isSleeping
|
||||
* @param isSleeping Whether to ignore.
|
||||
*/
|
||||
public void setSleepingIgnored(boolean isSleeping);
|
||||
|
||||
/**
|
||||
* Returns whether the player is sleeping ignored.
|
||||
*
|
||||
* @return
|
||||
* @return Whether player is ignoring sleep.
|
||||
*/
|
||||
public boolean isSleepingIgnored();
|
||||
|
||||
@@ -146,9 +146,9 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* at the particular location (as far as the client is concerned). This
|
||||
* will not work without a note block. This will not work with cake.
|
||||
*
|
||||
* @param loc
|
||||
* @param instrument
|
||||
* @param note
|
||||
* @param loc The location of a note block.
|
||||
* @param instrument The instrument ID.
|
||||
* @param note The note ID.
|
||||
*/
|
||||
public void playNote(Location loc, byte instrument, byte note);
|
||||
|
||||
@@ -157,16 +157,16 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* at the particular location (as far as the client is concerned). This
|
||||
* will not work without a note block. This will not work with cake.
|
||||
*
|
||||
* @param loc
|
||||
* @param instrument
|
||||
* @param note
|
||||
* @param loc The location of a note block
|
||||
* @param instrument The instrument
|
||||
* @param note The note
|
||||
*/
|
||||
public void playNote(Location loc, Instrument instrument, Note note);
|
||||
|
||||
/**
|
||||
* Plays an effect to just this player.
|
||||
*
|
||||
* @param loc the player to play the effect for
|
||||
* @param loc the location to play the effect at
|
||||
* @param effect the {@link Effect}
|
||||
* @param data a data bit needed for the RECORD_PLAY, SMOKE, and STEP_SOUND sounds
|
||||
*/
|
||||
@@ -176,9 +176,9 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* Send a block change. This fakes a block change packet for a user at
|
||||
* a certain location. This will not actually change the world in any way.
|
||||
*
|
||||
* @param loc
|
||||
* @param material
|
||||
* @param data
|
||||
* @param loc The location of the changed block
|
||||
* @param material The new block
|
||||
* @param data The block data
|
||||
*/
|
||||
public void sendBlockChange(Location loc, Material material, byte data);
|
||||
|
||||
@@ -205,9 +205,9 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* Send a block change. This fakes a block change packet for a user at
|
||||
* a certain location. This will not actually change the world in any way.
|
||||
*
|
||||
* @param loc
|
||||
* @param material
|
||||
* @param data
|
||||
* @param loc The location of the changed block
|
||||
* @param material The new block ID
|
||||
* @param data The block data
|
||||
*/
|
||||
public void sendBlockChange(Location loc, int material, byte data);
|
||||
|
||||
@@ -215,7 +215,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* 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.
|
||||
*
|
||||
* @pram map The map to be sent
|
||||
* @param map The map to be sent
|
||||
*/
|
||||
public void sendMap(MapView map);
|
||||
|
||||
@@ -281,7 +281,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
/**
|
||||
* Returns the player's current timestamp.
|
||||
*
|
||||
* @return
|
||||
* @return The player's time
|
||||
*/
|
||||
public long getPlayerTime();
|
||||
|
||||
@@ -289,7 +289,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
* Returns the player's current time offset relative to server time, or the current player's fixed time
|
||||
* if the player's time is absolute.
|
||||
*
|
||||
* @return
|
||||
* @return The player's time
|
||||
*/
|
||||
public long getPlayerTimeOffset();
|
||||
|
||||
@@ -332,7 +332,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
|
||||
/**
|
||||
* Sets the players current experience level
|
||||
*
|
||||
* @param exp New experience level
|
||||
* @param level New experience level
|
||||
*/
|
||||
public void setLevel(int level);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user