Player (PaperSpigot-API 1.7.10-R0.1-SNAPSHOT API)

All Superinterfaces:

AnimalTamer, CommandSender, ConfigurationSerializable, Conversable, Damageable, Entity, HumanEntity, InventoryHolder, LivingEntity, Metadatable, OfflinePlayer, Permissible, PluginMessageRecipient, ProjectileSource, ServerOperator
```
public interface Player
extends HumanEntity, Conversable, CommandSender, OfflinePlayer, PluginMessageRecipient
```
Represents a player, connected or not

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Player.Spigot

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Player.Spigot`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`awardAchievement(Achievement achievement)` Awards the given achievement and any parent achievements that the player does not have.
`boolean`	`canSee(Player player)` Checks to see if a player has been hidden from this player
`void`	`chat(String msg)` Says a message (or runs a command).
`void`	`decrementStatistic(Statistic statistic)` Decrements the given statistic for this player.
`void`	`decrementStatistic(Statistic statistic, EntityType entityType)` Decrements the given statistic for this player for the given entity.
`void`	`decrementStatistic(Statistic statistic, EntityType entityType, int amount)` Decrements the given statistic for this player for the given entity.
`void`	`decrementStatistic(Statistic statistic, int amount)` Decrements the given statistic for this player.
`void`	`decrementStatistic(Statistic statistic, Material material)` Decrements the given statistic for this player for the given material.
`void`	`decrementStatistic(Statistic statistic, Material material, int amount)` Decrements the given statistic for this player for the given material.
`InetSocketAddress`	`getAddress()` Gets the socket address of this player
`boolean`	`getAllowFlight()` Determines if the Player is allowed to fly via jump key double-tap like in creative mode.
`Location`	`getBedSpawnLocation()` Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.
`Location`	`getCompassTarget()` Get the previously set compass target.
`String`	`getDisplayName()` Gets the "friendly" name to display of this player.
`float`	`getExhaustion()` Gets the players current exhaustion level.
`float`	`getExp()` Gets the players current experience points towards the next level.
`float`	`getFlySpeed()` Gets the current allowed speed that a client can fly.
`int`	`getFoodLevel()` Gets the players current food level
`double`	`getHealthScale()` Gets the number that health is scaled to for the client.
`int`	`getLevel()` Gets the players current experience level
`String`	`getPlayerListName()` Gets the name that is shown on the player list.
`long`	`getPlayerTime()` Returns the player's current timestamp.
`long`	`getPlayerTimeOffset()` 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.
`WeatherType`	`getPlayerWeather()` Returns the type of weather the player is currently experiencing.
`float`	`getSaturation()` Gets the players current saturation level.
`Scoreboard`	`getScoreboard()` Gets the Scoreboard displayed to this player
`int`	`getStatistic(Statistic statistic)` Gets the value of the given statistic for this player.
`int`	`getStatistic(Statistic statistic, EntityType entityType)` Gets the value of the given statistic for this player.
`int`	`getStatistic(Statistic statistic, Material material)` Gets the value of the given statistic for this player.
`int`	`getTotalExperience()` Gets the players total experience points
`float`	`getWalkSpeed()` Gets the current allowed speed that a client can walk.
`void`	`giveExp(int amount)` Gives the player the amount of experience specified.
`void`	`giveExpLevels(int amount)` Gives the player the amount of experience levels specified.
`boolean`	`hasAchievement(Achievement achievement)` Gets whether this player has the given achievement.
`void`	`hidePlayer(Player player)` Hides a player from this player
`void`	`incrementStatistic(Statistic statistic)` Increments the given statistic for this player.
`void`	`incrementStatistic(Statistic statistic, EntityType entityType)` Increments the given statistic for this player for the given entity.
`void`	`incrementStatistic(Statistic statistic, EntityType entityType, int amount)` Increments the given statistic for this player for the given entity.
`void`	`incrementStatistic(Statistic statistic, int amount)` Increments the given statistic for this player.
`void`	`incrementStatistic(Statistic statistic, Material material)` Increments the given statistic for this player for the given material.
`void`	`incrementStatistic(Statistic statistic, Material material, int amount)` Increments the given statistic for this player for the given material.
`boolean`	`isFlying()` Checks to see if this player is currently flying or not.
`boolean`	`isHealthScaled()` Gets if the client is displayed a 'scaled' health, that is, health on a scale from 0-`getHealthScale()`.
`boolean`	`isOnGround()` Deprecated. Inconsistent with `Entity.isOnGround()`
`boolean`	`isPlayerTimeRelative()` Returns true if the player's time is relative to the server time, otherwise the player's time is absolute and will not change its current time unless done so with setPlayerTime().
`boolean`	`isSleepingIgnored()` Returns whether the player is sleeping ignored.
`boolean`	`isSneaking()` Returns if the player is in sneak mode
`boolean`	`isSprinting()` Gets whether the player is sprinting or not.
`void`	`kickPlayer(String message)` Kicks player with custom kick message.
`void`	`loadData()` Loads the players current location, health, inventory, motion, and other information from the username.dat file, in the world/player folder.
`boolean`	`performCommand(String command)` Makes the player perform the given command
`void`	`playEffect(Location loc, Effect effect, int data)` Deprecated. Magic value
`<T> void`	`playEffect(Location loc, Effect effect, T data)` Plays an effect to just this player.
`void`	`playNote(Location loc, byte instrument, byte note)` Deprecated. Magic value
`void`	`playNote(Location loc, Instrument instrument, Note note)` Play a note for a player at a location.
`void`	`playSound(Location location, Sound sound, float volume, float pitch)` Play a sound for a player at the location.
`void`	`playSound(Location location, String sound, float volume, float pitch)` Deprecated. Magic value
`void`	`removeAchievement(Achievement achievement)` Removes the given achievement and any children achievements that the player has.
`void`	`resetPlayerTime()` Restores the normal condition where the player's time is synchronized with the server time.
`void`	`resetPlayerWeather()` Restores the normal condition where the player's weather is controlled by server conditions.
`void`	`saveData()` Saves the players current location, health, inventory, motion, and other information into the username.dat file, in the world/player folder
`void`	`sendBlockChange(Location loc, int material, byte data)` Deprecated. Magic value
`void`	`sendBlockChange(Location loc, Material material, byte data)` Deprecated. Magic value
`boolean`	`sendChunkChange(Location loc, int sx, int sy, int sz, byte[] data)` Deprecated. Magic value
`void`	`sendMap(MapView map)` Render a map and send it to the player in its entirety.
`void`	`sendRawMessage(String message)` Sends this sender a message raw
`void`	`sendSignChange(Location loc, String[] lines)` Send a sign change.
`void`	`setAllowFlight(boolean flight)` Sets if the Player is allowed to fly via jump key double-tap like in creative mode.
`void`	`setBedSpawnLocation(Location location)` Sets the Location where the player will spawn at their bed.
`void`	`setBedSpawnLocation(Location location, boolean force)` Sets the Location where the player will spawn at their bed.
`void`	`setCompassTarget(Location loc)` Set the target of the player's compass.
`void`	`setDisplayName(String name)` Sets the "friendly" name to display of this player.
`void`	`setExhaustion(float value)` Sets the players current exhaustion level
`void`	`setExp(float exp)` Sets the players current experience points towards the next level
`void`	`setFlying(boolean value)` Makes this player start or stop flying.
`void`	`setFlySpeed(float value)` Sets the speed at which a client will fly.
`void`	`setFoodLevel(int value)` Sets the players current food level
`void`	`setHealthScale(double scale)` Sets the number to scale health to for the client; this will also `setHealthScaled(true)`.
`void`	`setHealthScaled(boolean scale)` Sets if the client is displayed a 'scaled' health, that is, health on a scale from 0-`getHealthScale()`.
`void`	`setLevel(int level)` Sets the players current experience level
`void`	`setPlayerListName(String name)` Sets the name that is shown on the in-game player list.
`void`	`setPlayerTime(long time, boolean relative)` Sets the current time on the player's client.
`void`	`setPlayerWeather(WeatherType type)` Sets the type of weather the player will see.
`void`	`setResourcePack(String url)` Request that the player's client download and switch resource packs.
`void`	`setSaturation(float value)` Sets the players current saturation level
`void`	`setScoreboard(Scoreboard scoreboard)` Sets the player's visible Scoreboard.
`void`	`setSleepingIgnored(boolean isSleeping)` Sets whether the player is ignored as not sleeping.
`void`	`setSneaking(boolean sneak)` Sets the sneak mode the player
`void`	`setSprinting(boolean sprinting)` Sets whether the player is sprinting or not.
`void`	`setStatistic(Statistic statistic, EntityType entityType, int newValue)` Sets the given statistic for this player for the given entity.
`void`	`setStatistic(Statistic statistic, int newValue)` Sets the given statistic for this player.
`void`	`setStatistic(Statistic statistic, Material material, int newValue)` Sets the given statistic for this player for the given material.
`void`	`setTexturePack(String url)` Deprecated. Minecraft no longer uses textures packs. Instead you should use `setResourcePack(String)`.
`void`	`setTotalExperience(int exp)` Sets the players current experience level
`void`	`setWalkSpeed(float value)` Sets the speed at which a client will walk.
`void`	`showPlayer(Player player)` Allows this player to see a player that was previously hidden
`Player.Spigot`	`spigot()`
`void`	`updateInventory()` Forces an update of the player's entire inventory.

Methods inherited from interface org.bukkit.entity.HumanEntity
closeInventory, getEnderChest, getExpToLevel, getGameMode, getInventory, getItemInHand, getItemOnCursor, getName, getOpenInventory, getSleepTicks, isBlocking, isSleeping, openEnchanting, openInventory, openInventory, openWorkbench, setGameMode, setItemInHand, setItemOnCursor, setWindowProperty

Methods inherited from interface org.bukkit.entity.Damageable
_INVALID_damage, _INVALID_damage, _INVALID_getHealth, _INVALID_getMaxHealth, _INVALID_setHealth, _INVALID_setMaxHealth, damage, damage, getHealth, getMaxHealth, resetMaxHealth, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity
eject, getEntityId, getFallDistance, getFireTicks, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getPassenger, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWorld, isDead, isEmpty, isInsideVehicle, isValid, leaveVehicle, playEffect, remove, setFallDistance, setFireTicks, setLastDamageCause, setPassenger, setTicksLived, setVelocity, teleport, teleport, teleport, teleport

Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.projectiles.ProjectileSource
launchProjectile, launchProjectile

Methods inherited from interface org.bukkit.conversations.Conversable
abandonConversation, abandonConversation, acceptConversationInput, beginConversation, isConversing

Methods inherited from interface org.bukkit.command.CommandSender
getName, getServer, sendMessage, sendMessage

Methods inherited from interface org.bukkit.permissions.Permissible
addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator
isOp, setOp

Methods inherited from interface org.bukkit.OfflinePlayer
getFirstPlayed, getLastPlayed, getName, getPlayer, getUniqueId, hasPlayedBefore, isBanned, isOnline, isWhitelisted, setBanned, setWhitelisted

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable
serialize

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient
getListeningPluginChannels, sendPluginMessage

- Method Detail
  - getDisplayName
```
String getDisplayName()
```
    Gets the "friendly" name to display of this player. This may include color.
    Note that this name will not be displayed in game, only in chat and places defined by plugins.
    
    Returns:
    
    the friendly name
  - setDisplayName
```
void setDisplayName(String name)
```
    Sets the "friendly" name to display of this player. This may include color.
    Note that this name will not be displayed in game, only in chat and places defined by plugins.
    
    Parameters:
    
    name - The new display name.
  - getPlayerListName
```
String getPlayerListName()
```
    Gets the name that is shown on the player list.
    
    Returns:
    
    the player list name
  - setPlayerListName
```
void setPlayerListName(String name)
```
    Sets the name that is shown on the in-game player list.
    The name cannot be longer than 16 characters, but ChatColor is supported.
    If the value is null, the name will be identical to HumanEntity.getName().
    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 joining player's player list name will have a random number appended to it (1-2 characters long in the default implementation). If the joining player's name is 15 or 16 characters long, part of the name will be truncated at the end to allow the addition of the two digits.
    
    Parameters:
    
    name - new player list name
    
    Throws:
    
    IllegalArgumentException - if the name is already used by someone else
    
    IllegalArgumentException - if the length of the name is too long
  - setCompassTarget
```
void setCompassTarget(Location loc)
```
    Set the target of the player's compass.
    
    Parameters:
    
    loc - Location to point to
  - getCompassTarget
```
Location getCompassTarget()
```
    Get the previously set compass target.
    
    Returns:
    
    location of the target
  - getAddress
```
InetSocketAddress getAddress()
```
    Gets the socket address of this player
    
    Returns:
    
    the player's address
  - sendRawMessage
```
void sendRawMessage(String message)
```
    Sends this sender a message raw
    
    Specified by:
    
    sendRawMessage in interface Conversable
    
    Parameters:
    
    message - Message to be displayed
  - kickPlayer
```
void kickPlayer(String message)
```
    Kicks player with custom kick message.
    
    Parameters:
    
    message - kick message
  - chat
```
void chat(String msg)
```
    Says a message (or runs a command).
    
    Parameters:
    
    msg - message to print
  - performCommand
```
boolean performCommand(String command)
```
    Makes the player perform the given command
    
    Parameters:
    
    command - Command to perform
    
    Returns:
    
    true if the command was successful, otherwise false
  - isSneaking
```
boolean isSneaking()
```
    Returns if the player is in sneak mode
    
    Returns:
    
    true if player is in sneak mode
  - setSneaking
```
void setSneaking(boolean sneak)
```
    Sets the sneak mode the player
    
    Parameters:
    
    sneak - true if player should appear sneaking
  - isSprinting
```
boolean isSprinting()
```
    Gets whether the player is sprinting or not.
    
    Returns:
    
    true if player is sprinting.
  - setSprinting
```
void setSprinting(boolean sprinting)
```
    Sets whether the player is sprinting or not.
    
    Parameters:
    
    sprinting - true if the player should be sprinting
  - saveData
```
void saveData()
```
    Saves the players current location, health, inventory, motion, and other information into the username.dat file, in the world/player folder
  - loadData
```
void loadData()
```
    Loads the players current location, health, inventory, motion, and other information from the username.dat file, in the world/player folder.
    Note: This will overwrite the players current inventory, health, motion, etc, with the state from the saved dat file.
  - setSleepingIgnored
```
void setSleepingIgnored(boolean isSleeping)
```
    Sets whether the player is ignored as not sleeping. If everyone is either sleeping or has this flag set, then time will advance to the next day. If everyone has this flag set but no one is actually in bed, then nothing will happen.
    
    Parameters:
    
    isSleeping - Whether to ignore.
  - isSleepingIgnored
```
boolean isSleepingIgnored()
```
    Returns whether the player is sleeping ignored.
    
    Returns:
    
    Whether player is ignoring sleep.
  - playNote
```
@Deprecated
void playNote(Location loc,
                           byte instrument,
                           byte note)
```
    Deprecated. Magic value
    
    Play a note for a player at a location. This requires a note block 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.
    
    Parameters:
    
    loc - The location of a note block.
    
    instrument - The instrument ID.
    
    note - The note ID.
  - playNote
```
void playNote(Location loc,
              Instrument instrument,
              Note note)
```
    Play a note for a player at a location. This requires a note block 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.
    
    Parameters:
    
    loc - The location of a note block
    
    instrument - The instrument
    
    note - The note
  - playSound
```
void playSound(Location location,
               Sound sound,
               float volume,
               float pitch)
```
    Play a sound for a player at the location.
    This function will fail silently if Location or Sound are null.
    
    Parameters:
    
    location - The location to play the sound
    
    sound - The sound to play
    
    volume - The volume of the sound
    
    pitch - The pitch of the sound
  - playSound
```
@Deprecated
void playSound(Location location,
                            String sound,
                            float volume,
                            float pitch)
```
    Deprecated. Magic value
    
    Play a sound for a player at the location.
    This function will fail silently if Location or Sound are null. No sound will be heard by the player if their client does not have the respective sound for the value passed.
    
    Parameters:
    
    location - the location to play the sound
    
    sound - the internal sound name to play
    
    volume - the volume of the sound
    
    pitch - the pitch of the sound
  - playEffect
```
@Deprecated
void playEffect(Location loc,
                             Effect effect,
                             int data)
```
    Deprecated. Magic value
    
    Plays an effect to just this player.
    
    Parameters:
    
    loc - the location to play the effect at
    
    effect - the Effect
    
    data - a data bit needed for some effects
  - playEffect
```
<T> void playEffect(Location loc,
                    Effect effect,
                    T data)
```
    Plays an effect to just this player.
    
    Parameters:
    
    loc - the location to play the effect at
    
    effect - the Effect
    
    data - a data bit needed for some effects
  - sendBlockChange
```
@Deprecated
void sendBlockChange(Location loc,
                                  Material material,
                                  byte data)
```
    Deprecated. Magic value
    
    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.
    
    Parameters:
    
    loc - The location of the changed block
    
    material - The new block
    
    data - The block data
  - sendChunkChange
```
@Deprecated
boolean sendChunkChange(Location loc,
                                     int sx,
                                     int sy,
                                     int sz,
                                     byte[] data)
```
    Deprecated. Magic value
    
    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.
    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.
    
    Parameters:
    
    loc - The location of the cuboid
    
    sx - The x size of the cuboid
    
    sy - The y size of the cuboid
    
    sz - The z size of the cuboid
    
    data - The data to be sent
    
    Returns:
    
    true if the chunk change packet was sent
  - sendBlockChange
```
@Deprecated
void sendBlockChange(Location loc,
                                  int material,
                                  byte data)
```
    Deprecated. Magic value
    
    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.
    
    Parameters:
    
    loc - The location of the changed block
    
    material - The new block ID
    
    data - The block data
  - sendSignChange
```
void sendSignChange(Location loc,
                    String[] lines)
             throws IllegalArgumentException
```
    Send a sign change. This fakes a sign change packet for a user at a certain location. This will not actually change the world in any way. This method will use a sign at the location's block or a faked sign sent via sendBlockChange(org.bukkit.Location, int, byte) or sendBlockChange(org.bukkit.Location, org.bukkit.Material, byte).
    If the client does not have a sign at the given location it will display an error message to the user.
    
    Parameters:
    
    loc - the location of the sign
    
    lines - the new text on the sign or null to clear it
    
    Throws:
    
    IllegalArgumentException - if location is null
    
    IllegalArgumentException - if lines is non-null and has a length less than 4
  - sendMap
```
void sendMap(MapView map)
```
    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 desirable.
    
    Parameters:
    
    map - The map to be sent
  - updateInventory
```
void updateInventory()
```
    Forces an update of the player's entire inventory.
  - awardAchievement
```
void awardAchievement(Achievement achievement)
```
    Awards the given achievement and any parent achievements that the player does not have.
    
    Parameters:
    
    achievement - Achievement to award
    
    Throws:
    
    IllegalArgumentException - if achievement is null
  - removeAchievement
```
void removeAchievement(Achievement achievement)
```
    Removes the given achievement and any children achievements that the player has.
    
    Parameters:
    
    achievement - Achievement to remove
    
    Throws:
    
    IllegalArgumentException - if achievement is null
  - hasAchievement
```
boolean hasAchievement(Achievement achievement)
```
    Gets whether this player has the given achievement.
    
    Returns:
    
    whether the player has the achievement
    
    Throws:
    
    IllegalArgumentException - if achievement is null
  - incrementStatistic
```
void incrementStatistic(Statistic statistic)
                 throws IllegalArgumentException
```
    Increments the given statistic for this player.
    This is equivalent to the following code: incrementStatistic(Statistic, 1)
    
    Parameters:
    
    statistic - Statistic to increment
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if the statistic requires an additional parameter
  - decrementStatistic
```
void decrementStatistic(Statistic statistic)
                 throws IllegalArgumentException
```
    Decrements the given statistic for this player.
    This is equivalent to the following code: decrementStatistic(Statistic, 1)
    
    Parameters:
    
    statistic - Statistic to decrement
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if the statistic requires an additional parameter
  - incrementStatistic
```
void incrementStatistic(Statistic statistic,
                        int amount)
                 throws IllegalArgumentException
```
    Increments the given statistic for this player.
    
    Parameters:
    
    statistic - Statistic to increment
    
    amount - Amount to increment this statistic by
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if amount is negative
    
    IllegalArgumentException - if the statistic requires an additional parameter
  - decrementStatistic
```
void decrementStatistic(Statistic statistic,
                        int amount)
                 throws IllegalArgumentException
```
    Decrements the given statistic for this player.
    
    Parameters:
    
    statistic - Statistic to decrement
    
    amount - Amount to decrement this statistic by
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if amount is negative
    
    IllegalArgumentException - if the statistic requires an additional parameter
  - setStatistic
```
void setStatistic(Statistic statistic,
                  int newValue)
           throws IllegalArgumentException
```
    Sets the given statistic for this player.
    
    Parameters:
    
    statistic - Statistic to set
    
    newValue - The value to set this statistic to
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if newValue is negative
    
    IllegalArgumentException - if the statistic requires an additional parameter
  - getStatistic
```
int getStatistic(Statistic statistic)
          throws IllegalArgumentException
```
    Gets the value of the given statistic for this player.
    
    Parameters:
    
    statistic - Statistic to check
    
    Returns:
    
    the value of the given statistic
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if the statistic requires an additional parameter
  - incrementStatistic
```
void incrementStatistic(Statistic statistic,
                        Material material)
                 throws IllegalArgumentException
```
    Increments the given statistic for this player for the given material.
    This is equivalent to the following code: incrementStatistic(Statistic, Material, 1)
    
    Parameters:
    
    statistic - Statistic to increment
    
    material - Material to offset the statistic with
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if material is null
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - decrementStatistic
```
void decrementStatistic(Statistic statistic,
                        Material material)
                 throws IllegalArgumentException
```
    Decrements the given statistic for this player for the given material.
    This is equivalent to the following code: decrementStatistic(Statistic, Material, 1)
    
    Parameters:
    
    statistic - Statistic to decrement
    
    material - Material to offset the statistic with
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if material is null
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - getStatistic
```
int getStatistic(Statistic statistic,
                 Material material)
          throws IllegalArgumentException
```
    Gets the value of the given statistic for this player.
    
    Parameters:
    
    statistic - Statistic to check
    
    material - Material offset of the statistic
    
    Returns:
    
    the value of the given statistic
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if material is null
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - incrementStatistic
```
void incrementStatistic(Statistic statistic,
                        Material material,
                        int amount)
                 throws IllegalArgumentException
```
    Increments the given statistic for this player for the given material.
    
    Parameters:
    
    statistic - Statistic to increment
    
    material - Material to offset the statistic with
    
    amount - Amount to increment this statistic by
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if material is null
    
    IllegalArgumentException - if amount is negative
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - decrementStatistic
```
void decrementStatistic(Statistic statistic,
                        Material material,
                        int amount)
                 throws IllegalArgumentException
```
    Decrements the given statistic for this player for the given material.
    
    Parameters:
    
    statistic - Statistic to decrement
    
    material - Material to offset the statistic with
    
    amount - Amount to decrement this statistic by
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if material is null
    
    IllegalArgumentException - if amount is negative
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - setStatistic
```
void setStatistic(Statistic statistic,
                  Material material,
                  int newValue)
           throws IllegalArgumentException
```
    Sets the given statistic for this player for the given material.
    
    Parameters:
    
    statistic - Statistic to set
    
    material - Material to offset the statistic with
    
    newValue - The value to set this statistic to
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if material is null
    
    IllegalArgumentException - if newValue is negative
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - incrementStatistic
```
void incrementStatistic(Statistic statistic,
                        EntityType entityType)
                 throws IllegalArgumentException
```
    Increments the given statistic for this player for the given entity.
    This is equivalent to the following code: incrementStatistic(Statistic, EntityType, 1)
    
    Parameters:
    
    statistic - Statistic to increment
    
    entityType - EntityType to offset the statistic with
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if entityType is null
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - decrementStatistic
```
void decrementStatistic(Statistic statistic,
                        EntityType entityType)
                 throws IllegalArgumentException
```
    Decrements the given statistic for this player for the given entity.
    This is equivalent to the following code: decrementStatistic(Statistic, EntityType, 1)
    
    Parameters:
    
    statistic - Statistic to decrement
    
    entityType - EntityType to offset the statistic with
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if entityType is null
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - getStatistic
```
int getStatistic(Statistic statistic,
                 EntityType entityType)
          throws IllegalArgumentException
```
    Gets the value of the given statistic for this player.
    
    Parameters:
    
    statistic - Statistic to check
    
    entityType - EntityType offset of the statistic
    
    Returns:
    
    the value of the given statistic
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if entityType is null
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - incrementStatistic
```
void incrementStatistic(Statistic statistic,
                        EntityType entityType,
                        int amount)
                 throws IllegalArgumentException
```
    Increments the given statistic for this player for the given entity.
    
    Parameters:
    
    statistic - Statistic to increment
    
    entityType - EntityType to offset the statistic with
    
    amount - Amount to increment this statistic by
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if entityType is null
    
    IllegalArgumentException - if amount is negative
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - decrementStatistic
```
void decrementStatistic(Statistic statistic,
                        EntityType entityType,
                        int amount)
```
    Decrements the given statistic for this player for the given entity.
    
    Parameters:
    
    statistic - Statistic to decrement
    
    entityType - EntityType to offset the statistic with
    
    amount - Amount to decrement this statistic by
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if entityType is null
    
    IllegalArgumentException - if amount is negative
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - setStatistic
```
void setStatistic(Statistic statistic,
                  EntityType entityType,
                  int newValue)
```
    Sets the given statistic for this player for the given entity.
    
    Parameters:
    
    statistic - Statistic to set
    
    entityType - EntityType to offset the statistic with
    
    newValue - The value to set this statistic to
    
    Throws:
    
    IllegalArgumentException - if statistic is null
    
    IllegalArgumentException - if entityType is null
    
    IllegalArgumentException - if newValue is negative
    
    IllegalArgumentException - if the given parameter is not valid for the statistic
  - setPlayerTime
```
void setPlayerTime(long time,
                   boolean relative)
```
    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.
    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().
    
    Parameters:
    
    time - The current player's perceived time or the player's time offset from the server time.
    
    relative - When true the player time is kept relative to its world time.
  - getPlayerTime
```
long getPlayerTime()
```
    Returns the player's current timestamp.
    
    Returns:
    
    The player's time
  - getPlayerTimeOffset
```
long getPlayerTimeOffset()
```
    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.
    
    Returns:
    
    The player's time
  - isPlayerTimeRelative
```
boolean isPlayerTimeRelative()
```
    Returns true if the player's time is relative to the server time, otherwise the player's time is absolute and will not change its current time unless done so with setPlayerTime().
    
    Returns:
    
    true if the player's time is relative to the server time.
  - resetPlayerTime
```
void resetPlayerTime()
```
    Restores the normal condition where the player's time is synchronized with the server time.
    Equivalent to calling setPlayerTime(0, true).
  - setPlayerWeather
```
void setPlayerWeather(WeatherType type)
```
    Sets the type of weather the player will see. When used, the weather status of the player is locked until resetPlayerWeather() is used.
    
    Parameters:
    
    type - The WeatherType enum type the player should experience
  - getPlayerWeather
```
WeatherType getPlayerWeather()
```
    Returns the type of weather the player is currently experiencing.
    
    Returns:
    
    The WeatherType that the player is currently experiencing or null if player is seeing server weather.
  - resetPlayerWeather
```
void resetPlayerWeather()
```
    Restores the normal condition where the player's weather is controlled by server conditions.
  - giveExp
```
void giveExp(int amount)
```
    Gives the player the amount of experience specified.
    
    Parameters:
    
    amount - Exp amount to give
  - giveExpLevels
```
void giveExpLevels(int amount)
```
    Gives the player the amount of experience levels specified. Levels can be taken by specifying a negative amount.
    
    Parameters:
    
    amount - amount of experience levels to give or take
  - getExp
```
float getExp()
```
    Gets the players current experience points towards the next level.
    This is a percentage value. 0 is "no progress" and 1 is "next level".
    
    Returns:
    
    Current experience points
  - setExp
```
void setExp(float exp)
```
    Sets the players current experience points towards the next level
    This is a percentage value. 0 is "no progress" and 1 is "next level".
    
    Parameters:
    
    exp - New experience points
  - getLevel
```
int getLevel()
```
    Gets the players current experience level
    
    Returns:
    
    Current experience level
  - setLevel
```
void setLevel(int level)
```
    Sets the players current experience level
    
    Parameters:
    
    level - New experience level
  - getTotalExperience
```
int getTotalExperience()
```
    Gets the players total experience points
    
    Returns:
    
    Current total experience points
  - setTotalExperience
```
void setTotalExperience(int exp)
```
    Sets the players current experience level
    
    Parameters:
    
    exp - New experience level
  - getExhaustion
```
float getExhaustion()
```
    Gets the players current exhaustion level.
    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.
    
    Returns:
    
    Exhaustion level
  - setExhaustion
```
void setExhaustion(float value)
```
    Sets the players current exhaustion level
    
    Parameters:
    
    value - Exhaustion level
  - getSaturation
```
float getSaturation()
```
    Gets the players current saturation level.
    Saturation is a buffer for food level. Your food level will not drop if you are saturated > 0.
    
    Returns:
    
    Saturation level
  - setSaturation
```
void setSaturation(float value)
```
    Sets the players current saturation level
    
    Parameters:
    
    value - Saturation level
  - getFoodLevel
```
int getFoodLevel()
```
    Gets the players current food level
    
    Returns:
    
    Food level
  - setFoodLevel
```
void setFoodLevel(int value)
```
    Sets the players current food level
    
    Parameters:
    
    value - New food level
  - getBedSpawnLocation
```
Location getBedSpawnLocation()
```
    Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.
    
    Specified by:
    
    getBedSpawnLocation in interface OfflinePlayer
    
    Returns:
    
    Bed Spawn Location if bed exists, otherwise null.
  - setBedSpawnLocation
```
void setBedSpawnLocation(Location location)
```
    Sets the Location where the player will spawn at their bed.
    
    Parameters:
    
    location - where to set the respawn location
  - setBedSpawnLocation
```
void setBedSpawnLocation(Location location,
                         boolean force)
```
    Sets the Location where the player will spawn at their bed.
    
    Parameters:
    
    location - where to set the respawn location
    
    force - whether to forcefully set the respawn location even if a valid bed is not present
  - getAllowFlight
```
boolean getAllowFlight()
```
    Determines if the Player is allowed to fly via jump key double-tap like in creative mode.
    
    Returns:
    
    True if the player is allowed to fly.
  - setAllowFlight
```
void setAllowFlight(boolean flight)
```
    Sets if the Player is allowed to fly via jump key double-tap like in creative mode.
    
    Parameters:
    
    flight - If flight should be allowed.
  - hidePlayer
```
void hidePlayer(Player player)
```
    Hides a player from this player
    
    Parameters:
    
    player - Player to hide
  - showPlayer
```
void showPlayer(Player player)
```
    Allows this player to see a player that was previously hidden
    
    Parameters:
    
    player - Player to show
  - canSee
```
boolean canSee(Player player)
```
    Checks to see if a player has been hidden from this player
    
    Parameters:
    
    player - Player to check
    
    Returns:
    
    True if the provided player is not being hidden from this player
  - isOnGround
```
@Deprecated
boolean isOnGround()
```
    Deprecated. Inconsistent with Entity.isOnGround()
    
    Checks to see if this player is currently standing on a block. This information may not be reliable, as it is a state provided by the client, and may therefore not be accurate.
    
    Specified by:
    
    isOnGround in interface Entity
    
    Returns:
    
    True if the player standing on a solid block, else false.
  - isFlying
```
boolean isFlying()
```
    Checks to see if this player is currently flying or not.
    
    Returns:
    
    True if the player is flying, else false.
  - setFlying
```
void setFlying(boolean value)
```
    Makes this player start or stop flying.
    
    Parameters:
    
    value - True to fly.
  - setFlySpeed
```
void setFlySpeed(float value)
          throws IllegalArgumentException
```
    Sets the speed at which a client will fly. Negative values indicate reverse directions.
    
    Parameters:
    
    value - The new speed, from -1 to 1.
    
    Throws:
    
    IllegalArgumentException - If new speed is less than -1 or greater than 1
  - setWalkSpeed
```
void setWalkSpeed(float value)
           throws IllegalArgumentException
```
    Sets the speed at which a client will walk. Negative values indicate reverse directions.
    
    Parameters:
    
    value - The new speed, from -1 to 1.
    
    Throws:
    
    IllegalArgumentException - If new speed is less than -1 or greater than 1
  - getFlySpeed
```
float getFlySpeed()
```
    Gets the current allowed speed that a client can fly.
    
    Returns:
    
    The current allowed speed, from -1 to 1
  - getWalkSpeed
```
float getWalkSpeed()
```
    Gets the current allowed speed that a client can walk.
    
    Returns:
    
    The current allowed speed, from -1 to 1
  - setTexturePack
```
@Deprecated
void setTexturePack(String url)
```
    Deprecated. Minecraft no longer uses textures packs. Instead you should use setResourcePack(String).
    Request that the player's client download and switch texture packs.
    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.
    Notes:
    - Players can disable server textures on their client, in which case this method will have no affect on them.
    - There is no concept of resetting texture packs back to default within Minecraft, so players will have to relog to do so.
    Parameters:
    
    url - The URL from which the client will download the texture pack. The string must contain only US-ASCII characters and should be encoded as per RFC 1738.
    
    Throws:
    
    IllegalArgumentException - Thrown if the URL is null.
    
    IllegalArgumentException - Thrown if the URL is too long.
  - setResourcePack
```
void setResourcePack(String url)
```
    Request that the player's client download and switch resource packs.
    The player's client will download the new resource 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 resource pack in the past, it will perform a quick timestamp check over the network to determine if the resource 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.
    Notes:
    - Players can disable server resources on their client, in which case this method will have no affect on them.
    - There is no concept of resetting resource packs back to default within Minecraft, so players will have to relog to do so.
    Parameters:
    
    url - The URL from which the client will download the resource pack. The string must contain only US-ASCII characters and should be encoded as per RFC 1738.
    
    Throws:
    
    IllegalArgumentException - Thrown if the URL is null.
    
    IllegalArgumentException - Thrown if the URL is too long. The length restriction is an implementation specific arbitrary value.
  - getScoreboard
```
Scoreboard getScoreboard()
```
    Gets the Scoreboard displayed to this player
    
    Returns:
    
    The current scoreboard seen by this player
  - setScoreboard
```
void setScoreboard(Scoreboard scoreboard)
            throws IllegalArgumentException,
                   IllegalStateException
```
    Sets the player's visible Scoreboard.
    
    Parameters:
    
    scoreboard - New Scoreboard for the player
    
    Throws:
    
    IllegalArgumentException - if scoreboard is null
    
    IllegalArgumentException - if scoreboard was not created by the scoreboard manager
    
    IllegalStateException - if this is a player that is not logged yet or has logged out
  - isHealthScaled
```
boolean isHealthScaled()
```
    Gets if the client is displayed a 'scaled' health, that is, health on a scale from 0-getHealthScale().
    
    Returns:
    
    if client health display is scaled
    
    See Also:
    
    setHealthScaled(boolean)
  - setHealthScaled
```
void setHealthScaled(boolean scale)
```
    Sets if the client is displayed a 'scaled' health, that is, health on a scale from 0-getHealthScale().
    Displayed health follows a simple formula displayedHealth = getHealth() / getMaxHealth() * getHealthScale().
    
    Parameters:
    
    scale - if the client health display is scaled
  - setHealthScale
```
void setHealthScale(double scale)
             throws IllegalArgumentException
```
    Sets the number to scale health to for the client; this will also setHealthScaled(true).
    Displayed health follows a simple formula displayedHealth = getHealth() / getMaxHealth() * getHealthScale().
    
    Parameters:
    
    scale - the number to scale health to
    
    Throws:
    
    IllegalArgumentException - if scale is <0
    
    IllegalArgumentException - if scale is Double.NaN
    
    IllegalArgumentException - if scale is too high
  - getHealthScale
```
double getHealthScale()
```
    Gets the number that health is scaled to for the client.
    
    Returns:
    
    the number that health would be scaled to for the client if HealthScaling is set to true
    
    See Also:
    
    setHealthScale(double), setHealthScaled(boolean)
  - spigot
```
Player.Spigot spigot()
```
    Specified by:
    
    spigot in interface Entity

Interface Player

Nested Class Summary

Method Summary

Methods inherited from interface org.bukkit.entity.HumanEntity

Methods inherited from interface org.bukkit.entity.LivingEntity

Methods inherited from interface org.bukkit.entity.Damageable

Methods inherited from interface org.bukkit.entity.Entity

Methods inherited from interface org.bukkit.metadata.Metadatable

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

Methods inherited from interface org.bukkit.conversations.Conversable

Methods inherited from interface org.bukkit.command.CommandSender

Methods inherited from interface org.bukkit.permissions.Permissible

Methods inherited from interface org.bukkit.permissions.ServerOperator

Methods inherited from interface org.bukkit.OfflinePlayer

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient

Method Detail

getDisplayName

setDisplayName

getPlayerListName

setPlayerListName

setCompassTarget

getCompassTarget

getAddress

sendRawMessage

kickPlayer

chat

performCommand

isSneaking

setSneaking

isSprinting

setSprinting

saveData

loadData

setSleepingIgnored

isSleepingIgnored

playNote

playNote

playSound

playSound

playEffect

playEffect

sendBlockChange

sendChunkChange

sendBlockChange

sendSignChange

sendMap

updateInventory

awardAchievement

removeAchievement

hasAchievement

incrementStatistic

decrementStatistic

incrementStatistic

decrementStatistic

setStatistic

getStatistic

incrementStatistic

decrementStatistic

getStatistic

incrementStatistic

decrementStatistic

setStatistic

incrementStatistic

decrementStatistic

getStatistic

incrementStatistic

decrementStatistic

setStatistic

setPlayerTime

getPlayerTime

getPlayerTimeOffset

isPlayerTimeRelative

resetPlayerTime

setPlayerWeather

getPlayerWeather

resetPlayerWeather

giveExp

giveExpLevels

getExp