Player (Paper-API 1.14.4-R0.1-SNAPSHOT API)

All Superinterfaces:

AnimalTamer, Attributable, CommandSender, ConfigurationSerializable, Conversable, Damageable, Entity, HumanEntity, InventoryHolder, LivingEntity, Metadatable, Nameable, NetworkClient, OfflinePlayer, Permissible, PersistentDataHolder, PluginMessageRecipient, ProjectileSource, ServerOperator
```
public interface Player
extends HumanEntity, Conversable, OfflinePlayer, PluginMessageRecipient, NetworkClient
```
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 Default Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`applyMending(int amount)` Applies the mending effect to any items just as picking up an orb would.
`void`	`awardAchievement(Achievement achievement)` Deprecated. future versions of Minecraft do not have achievements
`default BanEntry`	`banPlayerFull(String reason)` Permanently Bans the Profile and IP address currently used by the player.
`default BanEntry`	`banPlayerFull(String reason, Date expires)` Bans the Profile and IP address currently used by the player.
`default BanEntry`	`banPlayerFull(String reason, Date expires, String source)` Bans the Profile and IP address currently used by the player.
`default BanEntry`	`banPlayerFull(String reason, String source)` Permanently Bans the Profile and IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason)` Permanently Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, boolean kickPlayer)` Permanently Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, Date expires)` Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, Date expires, boolean kickPlayer)` Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, Date expires, String source)` Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, Date expires, String source, boolean kickPlayer)` Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, String source)` Permanently Bans the IP address currently used by the player.
`default BanEntry`	`banPlayerIP(String reason, String source, boolean kickPlayer)` Permanently Bans the IP address currently used by the player.
`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
`AdvancementProgress`	`getAdvancementProgress(Advancement advancement)` Return the player's progression on the specified advancement.
`boolean`	`getAffectsSpawning()` Get whether the player can affect mob spawning
`boolean`	`getAllowFlight()` Determines if the Player is allowed to fly via jump key double-tap like in creative mode.
`int`	`getClientViewDistance()` Get the player's current client side view distance.
`Location`	`getCompassTarget()` Get the previously set compass target.
`float`	`getCooldownPeriod()` Returns the amount of ticks the current cooldown lasts
`float`	`getCooledAttackStrength(float adjustTicks)` Returns the percentage of attack power available based on the cooldown (zero to one).
`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`	`getLocale()` Gets the player's current locale.
`String`	`getPlayerListFooter()` Gets the currently displayed player list footer for this player.
`String`	`getPlayerListHeader()` Gets the currently displayed player list header for this player.
`String`	`getPlayerListName()` Gets the name that is shown on the player list.
`PlayerProfile`	`getPlayerProfile()` Gets a copy of this players profile
`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.
`String`	`getResourcePackHash()` Deprecated. This is no longer sent from the client and will always be null
`PlayerResourcePackStatusEvent.Status`	`getResourcePackStatus()`
`float`	`getSaturation()` Gets the players current saturation level.
`Scoreboard`	`getScoreboard()` Gets the Scoreboard displayed to this player
`Entity`	`getSpectatorTarget()` Gets the entity which is followed by the camera when in `GameMode.SPECTATOR`.
`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.
`int`	`getViewDistance()` Gets the view distance for this player
`float`	`getWalkSpeed()` Gets the current allowed speed that a client can walk.
`default void`	`giveExp(int amount)` Gives the player the amount of experience specified.
`void`	`giveExp(int amount, boolean applyMending)` 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)` Deprecated. future versions of Minecraft do not have achievements
`boolean`	`hasResourcePack()`
`void`	`hidePlayer(Player player)` Deprecated. see `hidePlayer(Plugin, Player)`
`void`	`hidePlayer(Plugin plugin, Player player)` Hides a player from this player
`void`	`hideTitle()` Hide any title that is currently visible to the 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`	`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.
`void`	`openBook(ItemStack book)` Open a `Material.WRITTEN_BOOK` for a Player
`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, Sound sound, SoundCategory category, float volume, float pitch)` Play a sound for a player at the location.
`void`	`playSound(Location location, String sound, float volume, float pitch)` Play a sound for a player at the location.
`void`	`playSound(Location location, String sound, SoundCategory category, float volume, float pitch)` Play a sound for a player at the location.
`void`	`removeAchievement(Achievement achievement)` Deprecated. future versions of Minecraft do not have achievements
`void`	`resetCooldown()` Reset the cooldown counter to 0, effectively starting the cooldown period.
`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`	`resetTitle()` Resets the title displayed to the player.
`void`	`saveData()` Saves the players current location, health, inventory, motion, and other information into the username.dat file, in the world/player folder
`void`	`sendActionBar(char alternateChar, String message)` Sends an Action Bar message to the client.
`void`	`sendActionBar(String message)` Sends an Action Bar message to the client.
`void`	`sendBlockChange(Location loc, BlockData block)` Send a block change.
`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.
`default void`	`sendMessage(net.md_5.bungee.api.chat.BaseComponent... components)` Sends an array of components as a single message to the player
`default void`	`sendMessage(net.md_5.bungee.api.chat.BaseComponent component)` Sends the component to the player
`default void`	`sendMessage(net.md_5.bungee.api.ChatMessageType position, net.md_5.bungee.api.chat.BaseComponent... components)` Deprecated. This is unlikely the API you want to use. See `sendActionBar(String)` for a more proper Action Bar API. This deprecated API may send unsafe items to the client.
`void`	`sendRawMessage(String message)` Sends this sender a message raw
`void`	`sendSignChange(Location loc, String[] lines)` Send a sign change.
`void`	`sendSignChange(Location loc, String[] lines, DyeColor dyeColor)` Send a sign change.
`void`	`sendTitle(String title, String subtitle)` Deprecated. API behavior subject to change
`void`	`sendTitle(String title, String subtitle, int fadeIn, int stay, int fadeOut)` Sends a title and a subtitle message to the player.
`void`	`sendTitle(Title title)` Show the title to the player, overriding any previously displayed title.
`void`	`setAffectsSpawning(boolean affects)` Set whether the player can affect mob spawning
`void`	`setAllowFlight(boolean flight)` Sets if the Player is allowed to fly via jump key double-tap like in creative mode.
`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`	`setPlayerListFooter(String footer)` Sets the currently displayed player list footer for this player.
`void`	`setPlayerListHeader(String header)` Sets the currently displayed player list header for this player.
`void`	`setPlayerListHeaderFooter(net.md_5.bungee.api.chat.BaseComponent[] header, net.md_5.bungee.api.chat.BaseComponent[] footer)` Set the text displayed in the player list header and footer for this player
`void`	`setPlayerListHeaderFooter(net.md_5.bungee.api.chat.BaseComponent header, net.md_5.bungee.api.chat.BaseComponent footer)` Set the text displayed in the player list header and footer for this player
`void`	`setPlayerListHeaderFooter(String header, String footer)` Sets the currently displayed player list header and footer for this player.
`void`	`setPlayerListName(String name)` Sets the name that is shown on the in-game player list.
`void`	`setPlayerProfile(PlayerProfile profile)` Changes the PlayerProfile for this player.
`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)` Deprecated. use `setResourcePack(String, String)`
`void`	`setResourcePack(String url, byte[] hash)` Request that the player's client download and switch resource packs.
`void`	`setResourcePack(String url, String hash)` 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`	`setSpectatorTarget(Entity entity)` Sets the entity which is followed by the camera when in `GameMode.SPECTATOR`.
`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`	`setSubtitle(net.md_5.bungee.api.chat.BaseComponent subtitle)` Deprecated. Use `updateTitle(Title)`
`void`	`setSubtitle(net.md_5.bungee.api.chat.BaseComponent[] subtitle)` Deprecated. Use `updateTitle(Title)`
`void`	`setTexturePack(String url)` Deprecated. Minecraft no longer uses textures packs. Instead you should use `setResourcePack(String)`.
`void`	`setTitleTimes(int fadeInTicks, int stayTicks, int fadeOutTicks)` Deprecated. Use `updateTitle(Title)`
`void`	`setTotalExperience(int exp)` Sets the players current experience points.
`void`	`setViewDistance(int viewDistance)` Sets the view distance for this player
`void`	`setWalkSpeed(float value)` Sets the speed at which a client will walk.
`void`	`showPlayer(Player player)` Deprecated. see `showPlayer(Plugin, Player)`
`void`	`showPlayer(Plugin plugin, Player player)` Allows this player to see a player that was previously hidden.
`void`	`showTitle(net.md_5.bungee.api.chat.BaseComponent title)` Deprecated. Use `sendTitle(Title)` or `updateTitle(Title)`
`void`	`showTitle(net.md_5.bungee.api.chat.BaseComponent[] title)` Deprecated. Use `sendTitle(Title)` or `updateTitle(Title)`
`void`	`showTitle(net.md_5.bungee.api.chat.BaseComponent[] title, net.md_5.bungee.api.chat.BaseComponent[] subtitle, int fadeInTicks, int stayTicks, int fadeOutTicks)` Deprecated. Use `sendTitle(Title)` or `updateTitle(Title)`
`void`	`showTitle(net.md_5.bungee.api.chat.BaseComponent title, net.md_5.bungee.api.chat.BaseComponent subtitle, int fadeInTicks, int stayTicks, int fadeOutTicks)` Deprecated. Use `sendTitle(Title)` or `updateTitle(Title)`
`void`	`spawnParticle(Particle particle, double x, double y, double z, int count)` Spawns the particle (the number of times specified by count) at the target location.
`void`	`spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ)` Spawns the particle (the number of times specified by count) at the target location.
`void`	`spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra)` Spawns the particle (the number of times specified by count) at the target location.
`<T> void`	`spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)` Spawns the particle (the number of times specified by count) at the target location.
`<T> void`	`spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, T data)` Spawns the particle (the number of times specified by count) at the target location.
`<T> void`	`spawnParticle(Particle particle, double x, double y, double z, int count, T data)` Spawns the particle (the number of times specified by count) at the target location.
`void`	`spawnParticle(Particle particle, Location location, int count)` Spawns the particle (the number of times specified by count) at the target location.
`void`	`spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ)` Spawns the particle (the number of times specified by count) at the target location.
`void`	`spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra)` Spawns the particle (the number of times specified by count) at the target location.
`<T> void`	`spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)` Spawns the particle (the number of times specified by count) at the target location.
`<T> void`	`spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, T data)` Spawns the particle (the number of times specified by count) at the target location.
`<T> void`	`spawnParticle(Particle particle, Location location, int count, T data)` Spawns the particle (the number of times specified by count) at the target location.
`Player.Spigot`	`spigot()`
`void`	`stopSound(Sound sound)` Stop the specified sound from playing.
`void`	`stopSound(Sound sound, SoundCategory category)` Stop the specified sound from playing.
`void`	`stopSound(String sound)` Stop the specified sound from playing.
`void`	`stopSound(String sound, SoundCategory category)` Stop the specified sound from playing.
`void`	`updateCommands()` Update the list of commands sent to the client.
`void`	`updateInventory()` Forces an update of the player's entire inventory.
`void`	`updateTitle(Title title)` Show the title to the player, overriding any previously displayed title.

Methods inherited from interface org.bukkit.entity.LivingEntity
addPotionEffect, addPotionEffect, addPotionEffects, getActiveItem, getActivePotionEffects, getArrowsStuck, getCanPickupItems, getEquipment, getEyeHeight, getEyeHeight, getEyeLocation, getHandRaisedTime, getItemUseRemainingTime, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getShieldBlockingDelay, getTargetBlock, getTargetBlock, getTargetBlock, getTargetBlockExact, getTargetBlockExact, getTargetBlockFace, getTargetBlockFace, getTargetBlockInfo, getTargetBlockInfo, getTargetEntity, getTargetEntity, getTargetEntityInfo, getTargetEntityInfo, hasAI, hasLineOfSight, hasPotionEffect, isCollidable, isGliding, isLeashed, isRiptiding, isSleeping, isSwimming, rayTraceBlocks, rayTraceBlocks, removePotionEffect, setAI, setArrowsStuck, setCanPickupItems, setCollidable, setGliding, setKiller, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setShieldBlockingDelay, setSwimming

Methods inherited from interface org.bukkit.attribute.Attributable
getAttribute

Methods inherited from interface org.bukkit.entity.Damageable
damage, damage, getAbsorptionAmount, getHealth, getMaxHealth, resetMaxHealth, setAbsorptionAmount, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity
addPassenger, addScoreboardTag, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInsideVehicle, isInvulnerable, isOnGround, isPersistent, isSilent, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

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

Methods inherited from interface org.bukkit.command.CommandSender
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.Nameable
getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder
getPersistentDataContainer

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.OfflinePlayer
banPlayer, banPlayer, banPlayer, banPlayer, banPlayer, getBedSpawnLocation, getFirstPlayed, getLastLogin, getLastPlayed, getLastSeen, getName, getPlayer, getUniqueId, hasPlayedBefore, isBanned, isOnline, isWhitelisted, setWhitelisted

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

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

Methods inherited from interface com.destroystokyo.paper.network.NetworkClient
getProtocolVersion, getVirtualHost

- Method Detail
  - getDisplayName
```
@NotNull
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(@Nullable
                    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
```
@NotNull
String getPlayerListName()
```
    Gets the name that is shown on the player list.
    
    Returns:
    
    the player list name
  - setPlayerListName
```
void setPlayerListName(@Nullable
                       String name)
```
    Sets the name that is shown on the in-game player list.
    If the value is null, the name will be identical to HumanEntity.getName().
    
    Parameters:
    
    name - new player list name
  - getPlayerListHeader
```
@Nullable
String getPlayerListHeader()
```
    Gets the currently displayed player list header for this player.
    
    Returns:
    
    player list header or null
  - getPlayerListFooter
```
@Nullable
String getPlayerListFooter()
```
    Gets the currently displayed player list footer for this player.
    
    Returns:
    
    player list header or null
  - setPlayerListHeader
```
void setPlayerListHeader(@Nullable
                         String header)
```
    Sets the currently displayed player list header for this player.
    
    Parameters:
    
    header - player list header, null for empty
  - setPlayerListFooter
```
void setPlayerListFooter(@Nullable
                         String footer)
```
    Sets the currently displayed player list footer for this player.
    
    Parameters:
    
    footer - player list footer, null for empty
  - setPlayerListHeaderFooter
```
void setPlayerListHeaderFooter(@Nullable
                               String header,
                               @Nullable
                               String footer)
```
    Sets the currently displayed player list header and footer for this player.
    
    Parameters:
    
    header - player list header, null for empty
    
    footer - player list footer, null for empty
  - setCompassTarget
```
void setCompassTarget(@NotNull
                      Location loc)
```
    Set the target of the player's compass.
    
    Parameters:
    
    loc - Location to point to
  - getCompassTarget
```
@NotNull
Location getCompassTarget()
```
    Get the previously set compass target.
    
    Returns:
    
    location of the target
  - getAddress
```
@Nullable
InetSocketAddress getAddress()
```
    Gets the socket address of this player
    
    Specified by:
    
    getAddress in interface NetworkClient
    
    Returns:
    
    the player's address
  - sendRawMessage
```
void sendRawMessage(@NotNull
                    String message)
```
    Sends this sender a message raw
    
    Specified by:
    
    sendRawMessage in interface Conversable
    
    Parameters:
    
    message - Message to be displayed
  - kickPlayer
```
void kickPlayer(@Nullable
                String message)
```
    Kicks player with custom kick message.
    
    Parameters:
    
    message - kick message
  - chat
```
void chat(@NotNull
          String msg)
```
    Says a message (or runs a command).
    
    Parameters:
    
    msg - message to print
  - performCommand
```
boolean performCommand(@NotNull
                       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(@NotNull
                          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(@NotNull
              Location loc,
              @NotNull
              Instrument instrument,
              @NotNull
              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(@NotNull
               Location location,
               @NotNull
               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
```
void playSound(@NotNull
               Location location,
               @NotNull
               String 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. 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
  - playSound
```
void playSound(@NotNull
               Location location,
               @NotNull
               Sound sound,
               @NotNull
               SoundCategory category,
               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
    
    category - The category of the sound
    
    volume - The volume of the sound
    
    pitch - The pitch of the sound
  - playSound
```
void playSound(@NotNull
               Location location,
               @NotNull
               String sound,
               @NotNull
               SoundCategory category,
               float volume,
               float pitch)
```
    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
    
    category - The category of the sound
    
    volume - the volume of the sound
    
    pitch - the pitch of the sound
  - stopSound
```
void stopSound(@NotNull
               Sound sound)
```
    Stop the specified sound from playing.
    
    Parameters:
    
    sound - the sound to stop
  - stopSound
```
void stopSound(@NotNull
               String sound)
```
    Stop the specified sound from playing.
    
    Parameters:
    
    sound - the sound to stop
  - stopSound
```
void stopSound(@NotNull
               Sound sound,
               @Nullable
               SoundCategory category)
```
    Stop the specified sound from playing.
    
    Parameters:
    
    sound - the sound to stop
    
    category - the category of the sound
  - stopSound
```
void stopSound(@NotNull
               String sound,
               @Nullable
               SoundCategory category)
```
    Stop the specified sound from playing.
    
    Parameters:
    
    sound - the sound to stop
    
    category - the category of the sound
  - playEffect
```
@Deprecated
void playEffect(@NotNull
                            Location loc,
                            @NotNull
                            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(@NotNull
                    Location loc,
                    @NotNull
                    Effect effect,
                    @Nullable
                    T data)
```
    Plays an effect to just this player.
    
    Type Parameters:
    
    T - the data based based on the type of the effect
    
    Parameters:
    
    loc - the location to play the effect at
    
    effect - the Effect
    
    data - a data bit needed for some effects
  - sendBlockChange
```
@Deprecated
void sendBlockChange(@NotNull
                                 Location loc,
                                 @NotNull
                                 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
  - sendBlockChange
```
void sendBlockChange(@NotNull
                     Location loc,
                     @NotNull
                     BlockData block)
```
    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
    
    block - The new block
  - sendChunkChange
```
@Deprecated
boolean sendChunkChange(@NotNull
                                    Location loc,
                                    int sx,
                                    int sy,
                                    int sz,
                                    @NotNull
                                    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
  - sendSignChange
```
void sendSignChange(@NotNull
                    Location loc,
                    @Nullable
                    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, 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
  - sendSignChange
```
void sendSignChange(@NotNull
                    Location loc,
                    @Nullable
                    String[] lines,
                    @NotNull
                    DyeColor dyeColor)
             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, 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
    
    dyeColor - the color of the sign
    
    Throws:
    
    IllegalArgumentException - if location is null
    
    IllegalArgumentException - if dyeColor is null
    
    IllegalArgumentException - if lines is non-null and has a length less than 4
  - sendMap
```
void sendMap(@NotNull
             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
  - banPlayerFull
```
@Nullable
default BanEntry banPlayerFull(@Nullable
                                         String reason)
```
    Permanently Bans the Profile and IP address currently used by the player.
    
    Parameters:
    
    reason - Reason for ban
    
    Returns:
    
    Ban Entry
  - banPlayerFull
```
@Nullable
default BanEntry banPlayerFull(@Nullable
                                         String reason,
                                         @Nullable
                                         String source)
```
    Permanently Bans the Profile and IP address currently used by the player.
    
    Parameters:
    
    reason - Reason for ban
    
    source - Source of ban, or null for default
    
    Returns:
    
    Ban Entry
  - banPlayerFull
```
@Nullable
default BanEntry banPlayerFull(@Nullable
                                         String reason,
                                         @Nullable
                                         Date expires)
```
    Bans the Profile and IP address currently used by the player.
    
    Parameters:
    
    reason - Reason for Ban
    
    expires - When to expire the ban
    
    Returns:
    
    Ban Entry
  - banPlayerFull
```
@Nullable
default BanEntry banPlayerFull(@Nullable
                                         String reason,
                                         @Nullable
                                         Date expires,
                                         @Nullable
                                         String source)
```
    Bans the Profile and IP address currently used by the player.
    
    Parameters:
    
    reason - Reason for Ban
    
    expires - When to expire the ban
    
    source - Source of the ban, or null for default
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       boolean kickPlayer)
```
    Permanently Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for ban
    
    kickPlayer - Whether or not to kick the player afterwards
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       @Nullable
                                       String source,
                                       boolean kickPlayer)
```
    Permanently Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for ban
    
    source - Source of ban, or null for default
    
    kickPlayer - Whether or not to kick the player afterwards
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       @Nullable
                                       Date expires,
                                       boolean kickPlayer)
```
    Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for Ban
    
    expires - When to expire the ban
    
    kickPlayer - Whether or not to kick the player afterwards
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason)
```
    Permanently Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for ban
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       @Nullable
                                       String source)
```
    Permanently Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for ban
    
    source - Source of ban, or null for default
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       @Nullable
                                       Date expires)
```
    Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for Ban
    
    expires - When to expire the ban
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       @Nullable
                                       Date expires,
                                       @Nullable
                                       String source)
```
    Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for Ban
    
    expires - When to expire the ban
    
    source - Source of the banm or null for default
    
    Returns:
    
    Ban Entry
  - banPlayerIP
```
@Nullable
default BanEntry banPlayerIP(@Nullable
                                       String reason,
                                       @Nullable
                                       Date expires,
                                       @Nullable
                                       String source,
                                       boolean kickPlayer)
```
    Bans the IP address currently used by the player. Does not ban the Profile, use banPlayerFull(String, Date, String)
    
    Parameters:
    
    reason - Reason for Ban
    
    expires - When to expire the ban
    
    source - Source of the banm or null for default
    
    kickPlayer - if the targeted player should be kicked
    
    Returns:
    
    Ban Entry
  - sendActionBar
```
void sendActionBar(@NotNull
                   String message)
```
    Sends an Action Bar message to the client. Use Section symbols for legacy color codes to send formatting.
    
    Parameters:
    
    message - The message to send
  - sendActionBar
```
void sendActionBar(char alternateChar,
                   @NotNull
                   String message)
```
    Sends an Action Bar message to the client. Use supplied alternative character to the section symbol to represent legacy color codes.
    
    Parameters:
    
    alternateChar - Alternate symbol such as '&'
    
    message - The message to send
  - sendMessage
```
default void sendMessage(@NotNull
                         net.md_5.bungee.api.chat.BaseComponent component)
```
    Sends the component to the player
    
    Specified by:
    
    sendMessage in interface CommandSender
    
    Parameters:
    
    component - the components to send
  - sendMessage
```
default void sendMessage(@NotNull
                         net.md_5.bungee.api.chat.BaseComponent... components)
```
    Sends an array of components as a single message to the player
    
    Specified by:
    
    sendMessage in interface CommandSender
    
    Parameters:
    
    components - the components to send
  - sendMessage
```
@Deprecated
default void sendMessage(net.md_5.bungee.api.ChatMessageType position,
                                     net.md_5.bungee.api.chat.BaseComponent... components)
```
    Deprecated. This is unlikely the API you want to use. See sendActionBar(String) for a more proper Action Bar API. This deprecated API may send unsafe items to the client.
    
    Sends an array of components as a single message to the specified screen position of this player
    
    Parameters:
    
    position - the screen position
    
    components - the components to send
  - setPlayerListHeaderFooter
```
void setPlayerListHeaderFooter(@Nullable
                               net.md_5.bungee.api.chat.BaseComponent[] header,
                               @Nullable
                               net.md_5.bungee.api.chat.BaseComponent[] footer)
```
    Set the text displayed in the player list header and footer for this player
    
    Parameters:
    
    header - content for the top of the player list
    
    footer - content for the bottom of the player list
  - setPlayerListHeaderFooter
```
void setPlayerListHeaderFooter(@Nullable
                               net.md_5.bungee.api.chat.BaseComponent header,
                               @Nullable
                               net.md_5.bungee.api.chat.BaseComponent footer)
```
    Set the text displayed in the player list header and footer for this player
    
    Parameters:
    
    header - content for the top of the player list
    
    footer - content for the bottom of the player list
  - setTitleTimes
```
@Deprecated
void setTitleTimes(int fadeInTicks,
                               int stayTicks,
                               int fadeOutTicks)
```
    Deprecated. Use updateTitle(Title)
    
    Update the times for titles displayed to the player
    
    Parameters:
    
    fadeInTicks - ticks to fade-in
    
    stayTicks - ticks to stay visible
    
    fadeOutTicks - ticks to fade-out
  - setSubtitle
```
@Deprecated
void setSubtitle(net.md_5.bungee.api.chat.BaseComponent[] subtitle)
```
    Deprecated. Use updateTitle(Title)
    
    Update the subtitle of titles displayed to the player
    
    Parameters:
    
    subtitle - Subtitle to set
  - setSubtitle
```
@Deprecated
void setSubtitle(net.md_5.bungee.api.chat.BaseComponent subtitle)
```
    Deprecated. Use updateTitle(Title)
    
    Update the subtitle of titles displayed to the player
    
    Parameters:
    
    subtitle - Subtitle to set
  - showTitle
```
@Deprecated
void showTitle(@Nullable
                           net.md_5.bungee.api.chat.BaseComponent[] title)
```
    Deprecated. Use sendTitle(Title) or updateTitle(Title)
    
    Show the given title to the player, along with the last subtitle set, using the last set times
    
    Parameters:
    
    title - Title to set
  - showTitle
```
@Deprecated
void showTitle(@Nullable
                           net.md_5.bungee.api.chat.BaseComponent title)
```
    Deprecated. Use sendTitle(Title) or updateTitle(Title)
    
    Show the given title to the player, along with the last subtitle set, using the last set times
    
    Parameters:
    
    title - Title to set
  - showTitle
```
@Deprecated
void showTitle(@Nullable
                           net.md_5.bungee.api.chat.BaseComponent[] title,
                           @Nullable
                           net.md_5.bungee.api.chat.BaseComponent[] subtitle,
                           int fadeInTicks,
                           int stayTicks,
                           int fadeOutTicks)
```
    Deprecated. Use sendTitle(Title) or updateTitle(Title)
    
    Show the given title and subtitle to the player using the given times
    
    Parameters:
    
    title - big text
    
    subtitle - little text under it
    
    fadeInTicks - ticks to fade-in
    
    stayTicks - ticks to stay visible
    
    fadeOutTicks - ticks to fade-out
  - showTitle
```
@Deprecated
void showTitle(@Nullable
                           net.md_5.bungee.api.chat.BaseComponent title,
                           @Nullable
                           net.md_5.bungee.api.chat.BaseComponent subtitle,
                           int fadeInTicks,
                           int stayTicks,
                           int fadeOutTicks)
```
    Deprecated. Use sendTitle(Title) or updateTitle(Title)
    
    Show the given title and subtitle to the player using the given times
    
    Parameters:
    
    title - big text
    
    subtitle - little text under it
    
    fadeInTicks - ticks to fade-in
    
    stayTicks - ticks to stay visible
    
    fadeOutTicks - ticks to fade-out
  - sendTitle
```
void sendTitle(@NotNull
               Title title)
```
    Show the title to the player, overriding any previously displayed title.
    This method overrides any previous title, use updateTitle(Title) to change the existing one.
    
    Parameters:
    
    title - the title to send
    
    Throws:
    
    NullPointerException - if the title is null
  - updateTitle
```
void updateTitle(@NotNull
                 Title title)
```
    Show the title to the player, overriding any previously displayed title.
    This method doesn't override previous titles, but changes their values.
    
    Parameters:
    
    title - the title to send
    
    Throws:
    
    NullPointerException - if title is null
  - hideTitle
```
void hideTitle()
```
    Hide any title that is currently visible to the player
  - updateInventory
```
void updateInventory()
```
    Forces an update of the player's entire inventory.
  - awardAchievement
```
@Deprecated
void awardAchievement(@NotNull
                                  Achievement achievement)
```
    Deprecated. future versions of Minecraft do not have achievements
    
    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
```
@Deprecated
void removeAchievement(@NotNull
                                   Achievement achievement)
```
    Deprecated. future versions of Minecraft do not have achievements
    
    Removes the given achievement and any children achievements that the player has.
    
    Parameters:
    
    achievement - Achievement to remove
    
    Throws:
    
    IllegalArgumentException - if achievement is null
  - hasAchievement
```
@Deprecated
boolean hasAchievement(@NotNull
                                   Achievement achievement)
```
    Deprecated. future versions of Minecraft do not have achievements
    
    Gets whether this player has the given achievement.
    
    Parameters:
    
    achievement - the achievement to check
    
    Returns:
    
    whether the player has the achievement
    
    Throws:
    
    IllegalArgumentException - if achievement is null
  - incrementStatistic
```
void incrementStatistic(@NotNull
                        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(@NotNull
                        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(@NotNull
                        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(@NotNull
                        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(@NotNull
                  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(@NotNull
                 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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                 Statistic statistic,
                 @NotNull
                 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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                  Statistic statistic,
                  @NotNull
                  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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                 Statistic statistic,
                 @NotNull
                 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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                        Statistic statistic,
                        @NotNull
                        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(@NotNull
                  Statistic statistic,
                  @NotNull
                  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(@NotNull
                      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
```
@Nullable
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
```
default void giveExp(int amount)
```
    Gives the player the amount of experience specified.
    
    Parameters:
    
    amount - Exp amount to give
  - giveExp
```
void giveExp(int amount,
             boolean applyMending)
```
    Gives the player the amount of experience specified.
    
    Parameters:
    
    amount - Exp amount to give
    
    applyMending - Mend players items with mending, with same behavior as picking up orbs. calls applyMending(int)
  - applyMending
```
int applyMending(int amount)
```
    Applies the mending effect to any items just as picking up an orb would. Can also be called with giveExp(int, boolean) by passing true to applyMending
    
    Parameters:
    
    amount - Exp to apply
    
    Returns:
    
    the remaining experience
  - 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.
    This refers to the total amount of experience the player has collected over time and is only displayed as the player's "score" upon dying.
    
    Returns:
    
    Current total experience points
  - setTotalExperience
```
void setTotalExperience(int exp)
```
    Sets the players current experience points.
    This refers to the total amount of experience the player has collected over time and is only displayed as the player's "score" upon dying.
    
    Parameters:
    
    exp - New total experience points
  - 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
  - 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
```
@Deprecated
void hidePlayer(@NotNull
                            Player player)
```
    Deprecated. see hidePlayer(Plugin, Player)
    
    Hides a player from this player
    
    Parameters:
    
    player - Player to hide
  - hidePlayer
```
void hidePlayer(@NotNull
                Plugin plugin,
                @NotNull
                Player player)
```
    Hides a player from this player
    
    Parameters:
    
    plugin - Plugin that wants to hide the player
    
    player - Player to hide
  - showPlayer
```
@Deprecated
void showPlayer(@NotNull
                            Player player)
```
    Deprecated. see showPlayer(Plugin, Player)
    
    Allows this player to see a player that was previously hidden
    
    Parameters:
    
    player - Player to show
  - showPlayer
```
void showPlayer(@NotNull
                Plugin plugin,
                @NotNull
                Player player)
```
    Allows this player to see a player that was previously hidden. If another another plugin had hidden the player too, then the player will remain hidden until the other plugin calls this method too.
    
    Parameters:
    
    plugin - Plugin that wants to show the player
    
    player - Player to show
  - canSee
```
boolean canSee(@NotNull
               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
  - 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(@NotNull
                                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 file size check against the response content 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. Use the PlayerResourcePackStatusEvent to figure out whether or not the player loaded the pack!
    - There is no concept of resetting texture packs back to default within Minecraft, so players will have to relog to do so or you have to send an empty pack.
    - The request is send with "null" as the hash. This might result in newer versions not loading the pack correctly.
    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
```
@Deprecated
void setResourcePack(@NotNull
                                 String url)
```
    Deprecated. use setResourcePack(String, String)
    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 file size check against the response content 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. Use the PlayerResourcePackStatusEvent to figure out whether or not the player loaded the pack!
    - There is no concept of resetting resource packs back to default within Minecraft, so players will have to relog to do so or you have to send an empty pack.
    - The request is send with "null" as the hash. This might result in newer versions not loading the pack correctly.
    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.
  - setResourcePack
```
void setResourcePack(@NotNull
                     String url,
                     @NotNull
                     byte[] hash)
```
    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 a resource pack with the same hash in the past it will not download but directly apply the cached pack. 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. Use the PlayerResourcePackStatusEvent to figure out whether or not the player loaded the pack!
    - There is no concept of resetting resource packs back to default within Minecraft, so players will have to relog to do so or you have to send an empty pack.
    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.
    
    hash - The sha1 hash sum of the resource pack file which is used to apply a cached version of the pack directly without downloading if it is available. Hast to be 20 bytes long!
    
    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.
    
    IllegalArgumentException - Thrown if the hash is null.
    
    IllegalArgumentException - Thrown if the hash is not 20 bytes long.
  - getScoreboard
```
@NotNull
Scoreboard getScoreboard()
```
    Gets the Scoreboard displayed to this player
    
    Returns:
    
    The current scoreboard seen by this player
  - setScoreboard
```
void setScoreboard(@NotNull
                   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)
  - getSpectatorTarget
```
@Nullable
Entity getSpectatorTarget()
```
    Gets the entity which is followed by the camera when in GameMode.SPECTATOR.
    
    Returns:
    
    the followed entity, or null if not in spectator mode or not following a specific entity.
  - setSpectatorTarget
```
void setSpectatorTarget(@Nullable
                        Entity entity)
```
    Sets the entity which is followed by the camera when in GameMode.SPECTATOR.
    
    Parameters:
    
    entity - the entity to follow or null to reset
    
    Throws:
    
    IllegalStateException - if the player is not in GameMode.SPECTATOR
  - sendTitle
```
@Deprecated
void sendTitle(@Nullable
                           String title,
                           @Nullable
                           String subtitle)
```
    Deprecated. API behavior subject to change
    
    Sends a title and a subtitle message to the player. If either of these values are null, they will not be sent and the display will remain unchanged. If they are empty strings, the display will be updated as such. If the strings contain a new line, only the first line will be sent. The titles will be displayed with the client's default timings.
    
    Parameters:
    
    title - Title text
    
    subtitle - Subtitle text
  - sendTitle
```
void sendTitle(@Nullable
               String title,
               @Nullable
               String subtitle,
               int fadeIn,
               int stay,
               int fadeOut)
```
    Sends a title and a subtitle message to the player. If either of these values are null, they will not be sent and the display will remain unchanged. If they are empty strings, the display will be updated as such. If the strings contain a new line, only the first line will be sent. All timings values may take a value of -1 to indicate that they will use the last value sent (or the defaults if no title has been displayed).
    
    Parameters:
    
    title - Title text
    
    subtitle - Subtitle text
    
    fadeIn - time in ticks for titles to fade in. Defaults to 10.
    
    stay - time in ticks for titles to stay. Defaults to 70.
    
    fadeOut - time in ticks for titles to fade out. Defaults to 20.
  - resetTitle
```
void resetTitle()
```
    Resets the title displayed to the player. This will clear the displayed title / subtitle and reset timings to their default values.
  - spawnParticle
```
void spawnParticle(@NotNull
                   Particle particle,
                   @NotNull
                   Location location,
                   int count)
```
    Spawns the particle (the number of times specified by count) at the target location.
    
    Parameters:
    
    particle - the particle to spawn
    
    location - the location to spawn at
    
    count - the number of particles
  - spawnParticle
```
void spawnParticle(@NotNull
                   Particle particle,
                   double x,
                   double y,
                   double z,
                   int count)
```
    Spawns the particle (the number of times specified by count) at the target location.
    
    Parameters:
    
    particle - the particle to spawn
    
    x - the position on the x axis to spawn at
    
    y - the position on the y axis to spawn at
    
    z - the position on the z axis to spawn at
    
    count - the number of particles
  - spawnParticle
```
<T> void spawnParticle(@NotNull
                       Particle particle,
                       @NotNull
                       Location location,
                       int count,
                       @Nullable
                       T data)
```
    Spawns the particle (the number of times specified by count) at the target location.
    
    Type Parameters:
    
    T - type of particle data (see Particle.getDataType()
    
    T - Type
    
    Parameters:
    
    particle - the particle to spawn
    
    location - the location to spawn at
    
    count - the number of particles
    
    data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  - spawnParticle
```
<T> void spawnParticle(@NotNull
                       Particle particle,
                       double x,
                       double y,
                       double z,
                       int count,
                       @Nullable
                       T data)
```
    Spawns the particle (the number of times specified by count) at the target location.
    
    Type Parameters:
    
    T - type of particle data (see Particle.getDataType()
    
    T - Type
    
    Parameters:
    
    particle - the particle to spawn
    
    x - the position on the x axis to spawn at
    
    y - the position on the y axis to spawn at
    
    z - the position on the z axis to spawn at
    
    count - the number of particles
    
    data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  - spawnParticle
```
void spawnParticle(@NotNull
                   Particle particle,
                   @NotNull
                   Location location,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Parameters:
    
    particle - the particle to spawn
    
    location - the location to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
  - spawnParticle
```
void spawnParticle(@NotNull
                   Particle particle,
                   double x,
                   double y,
                   double z,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Parameters:
    
    particle - the particle to spawn
    
    x - the position on the x axis to spawn at
    
    y - the position on the y axis to spawn at
    
    z - the position on the z axis to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
  - spawnParticle
```
<T> void spawnParticle(@NotNull
                       Particle particle,
                       @NotNull
                       Location location,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       @Nullable
                       T data)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Type Parameters:
    
    T - type of particle data (see Particle.getDataType()
    
    T - Type
    
    Parameters:
    
    particle - the particle to spawn
    
    location - the location to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
    
    data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  - spawnParticle
```
<T> void spawnParticle(@NotNull
                       Particle particle,
                       double x,
                       double y,
                       double z,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       @Nullable
                       T data)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Type Parameters:
    
    T - type of particle data (see Particle.getDataType()
    
    T - Type
    
    Parameters:
    
    particle - the particle to spawn
    
    x - the position on the x axis to spawn at
    
    y - the position on the y axis to spawn at
    
    z - the position on the z axis to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
    
    data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  - spawnParticle
```
void spawnParticle(@NotNull
                   Particle particle,
                   @NotNull
                   Location location,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ,
                   double extra)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Parameters:
    
    particle - the particle to spawn
    
    location - the location to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
    
    extra - the extra data for this particle, depends on the particle used (normally speed)
  - spawnParticle
```
void spawnParticle(@NotNull
                   Particle particle,
                   double x,
                   double y,
                   double z,
                   int count,
                   double offsetX,
                   double offsetY,
                   double offsetZ,
                   double extra)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Parameters:
    
    particle - the particle to spawn
    
    x - the position on the x axis to spawn at
    
    y - the position on the y axis to spawn at
    
    z - the position on the z axis to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
    
    extra - the extra data for this particle, depends on the particle used (normally speed)
  - spawnParticle
```
<T> void spawnParticle(@NotNull
                       Particle particle,
                       @NotNull
                       Location location,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       double extra,
                       @Nullable
                       T data)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Type Parameters:
    
    T - type of particle data (see Particle.getDataType()
    
    T - Type
    
    Parameters:
    
    particle - the particle to spawn
    
    location - the location to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
    
    extra - the extra data for this particle, depends on the particle used (normally speed)
    
    data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  - spawnParticle
```
<T> void spawnParticle(@NotNull
                       Particle particle,
                       double x,
                       double y,
                       double z,
                       int count,
                       double offsetX,
                       double offsetY,
                       double offsetZ,
                       double extra,
                       @Nullable
                       T data)
```
    Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
    
    Type Parameters:
    
    T - type of particle data (see Particle.getDataType()
    
    T - Type
    
    Parameters:
    
    particle - the particle to spawn
    
    x - the position on the x axis to spawn at
    
    y - the position on the y axis to spawn at
    
    z - the position on the z axis to spawn at
    
    count - the number of particles
    
    offsetX - the maximum random offset on the X axis
    
    offsetY - the maximum random offset on the Y axis
    
    offsetZ - the maximum random offset on the Z axis
    
    extra - the extra data for this particle, depends on the particle used (normally speed)
    
    data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  - getAdvancementProgress
```
@NotNull
AdvancementProgress getAdvancementProgress(@NotNull
                                                    Advancement advancement)
```
    Return the player's progression on the specified advancement.
    
    Parameters:
    
    advancement - advancement
    
    Returns:
    
    object detailing the player's progress
  - getClientViewDistance
```
int getClientViewDistance()
```
    Get the player's current client side view distance.
    Will default to the server view distance if the client has not yet communicated this information,
    
    Returns:
    
    client view distance as above
  - getLocale
```
@NotNull
String getLocale()
```
    Gets the player's current locale. The value of the locale String is not defined properly.
    The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
    
    Returns:
    
    the player's locale
  - getAffectsSpawning
```
boolean getAffectsSpawning()
```
    Get whether the player can affect mob spawning
    
    Returns:
    
    if the player can affect mob spawning
  - setAffectsSpawning
```
void setAffectsSpawning(boolean affects)
```
    Set whether the player can affect mob spawning
    
    Parameters:
    
    affects - Whether the player can affect mob spawning
  - getViewDistance
```
int getViewDistance()
```
    Gets the view distance for this player
    
    Returns:
    
    the player's view distance
  - setViewDistance
```
void setViewDistance(int viewDistance)
```
    Sets the view distance for this player
    
    Parameters:
    
    viewDistance - the player's view distance
  - updateCommands
```
void updateCommands()
```
    Update the list of commands sent to the client.
    Generally useful to ensure the client has a complete list of commands after permission changes are done.
  - openBook
```
void openBook(@NotNull
              ItemStack book)
```
    Open a Material.WRITTEN_BOOK for a Player
    
    Parameters:
    
    book - The book to open for this player
  - setResourcePack
```
void setResourcePack(@NotNull
                     String url,
                     @NotNull
                     String hash)
```
    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.
    
    hash - A 40 character hexadecimal and lowercase SHA-1 digest of the resource pack file.
    
    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.
  - getResourcePackStatus
```
@Nullable
PlayerResourcePackStatusEvent.Status getResourcePackStatus()
```
    Returns:
    
    the most recent resource pack status received from the player, or null if no status has ever been received from this player.
  - getResourcePackHash
```
@Nullable
 @Deprecated
String getResourcePackHash()
```
    Deprecated. This is no longer sent from the client and will always be null
    
    Returns:
    
    the most recent resource pack hash received from the player, or null if no hash has ever been received from this player.
  - hasResourcePack
```
boolean hasResourcePack()
```
    Returns:
    
    true if the last resource pack status received from this player was PlayerResourcePackStatusEvent.Status.SUCCESSFULLY_LOADED
  - getPlayerProfile
```
@NotNull
PlayerProfile getPlayerProfile()
```
    Gets a copy of this players profile
    
    Returns:
    
    The players profile object
  - setPlayerProfile
```
void setPlayerProfile(@NotNull
                      PlayerProfile profile)
```
    Changes the PlayerProfile for this player. This will cause this player to be reregistered to all clients that can currently see this player
    
    Parameters:
    
    profile - The new profile to use
  - getCooldownPeriod
```
float getCooldownPeriod()
```
    Returns the amount of ticks the current cooldown lasts
    
    Returns:
    
    Amount of ticks cooldown will last
  - getCooledAttackStrength
```
float getCooledAttackStrength(float adjustTicks)
```
    Returns the percentage of attack power available based on the cooldown (zero to one).
    
    Parameters:
    
    adjustTicks - Amount of ticks to add to cooldown counter for this calculation
    
    Returns:
    
    Percentage of attack power available
  - resetCooldown
```
void resetCooldown()
```
    Reset the cooldown counter to 0, effectively starting the cooldown period.
  - spigot
```
@NotNull
Player.Spigot spigot()
```
    Specified by:
    
    spigot in interface CommandSender
    
    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.attribute.Attributable

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.command.CommandSender

Methods inherited from interface org.bukkit.permissions.Permissible

Methods inherited from interface org.bukkit.permissions.ServerOperator

Methods inherited from interface org.bukkit.Nameable

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

Methods inherited from interface org.bukkit.conversations.Conversable

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

Methods inherited from interface com.destroystokyo.paper.network.NetworkClient

Method Detail

getDisplayName

setDisplayName

getPlayerListName

setPlayerListName

getPlayerListHeader

getPlayerListFooter

setPlayerListHeader

setPlayerListFooter

setPlayerListHeaderFooter

setCompassTarget

getCompassTarget

getAddress

sendRawMessage

kickPlayer

chat

performCommand

isSneaking

setSneaking

isSprinting

setSprinting

saveData

loadData

setSleepingIgnored

isSleepingIgnored

playNote

playNote

playSound

playSound

playSound

playSound

stopSound

stopSound

stopSound

stopSound

playEffect

playEffect

sendBlockChange

sendBlockChange

sendChunkChange

sendSignChange

sendSignChange

sendMap

banPlayerFull

banPlayerFull

banPlayerFull

banPlayerFull

banPlayerIP

banPlayerIP

banPlayerIP

banPlayerIP

banPlayerIP

banPlayerIP

banPlayerIP

banPlayerIP

sendActionBar

sendActionBar

sendMessage

sendMessage

sendMessage