Interface Player
- All Superinterfaces:
AnimalTamer
,Attributable
,CommandSender
,ConfigurationSerializable
,Conversable
,Damageable
,Entity
,HumanEntity
,InventoryHolder
,LivingEntity
,Metadatable
,Nameable
,OfflinePlayer
,Permissible
,PersistentDataHolder
,PluginMessageRecipient
,ProjectileSource
,ServerOperator
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCustomChatCompletions
(Collection<String> completions) Add custom chat completion suggestions shown to the player while typing a message.Adds this user to theProfileBanList
.Adds this user to theProfileBanList
.Adds this user to theProfileBanList
.Adds this user's current IP address to theIpBanList
.Adds this user's current IP address to theIpBanList
.Adds this user's current IP address to theIpBanList
.boolean
breakBlock
(Block block) Force this player to break a Block using the item in their main hand.boolean
Checks to see if an entity has been visually hidden from this player.boolean
Checks to see if a player has been hidden from this playervoid
Says a message (or runs a command).Gets the socket address of this playergetAdvancementProgress
(Advancement advancement) Return the player's progression on the specified advancement.boolean
Determines if the Player is allowed to fly via jump key double-tap like in creative mode.Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.int
Get the player's current client side view distance.Get the previously set compass target.Gets the "friendly" name to display of this player.float
getExp()
Gets the players current experience points towards the next level.int
Gets the player's cooldown between picking up experience orbs.float
Gets the current allowed speed that a client can fly.double
Gets the number that health is scaled to for the client.int
getLevel()
Gets the players current experience levelGets the player's current locale.getName()
Returns the name of this playerint
getPing()
Gets the player's estimated ping in milliseconds.Gets the currently displayed player list footer for this player.Gets the currently displayed player list header for this player.Gets the name that is shown on the player list.long
Returns the player's current timestamp.long
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 type of weather the player is currently experiencing.Gets this player's previousGameMode
Gets the Scoreboard displayed to this playerGets the entity which is followed by the camera when inGameMode.SPECTATOR
.int
Gets the players total experience points.float
Gets the current allowed speed that a client can walk.Gets theWorldBorder
visible to this Player, or null if viewing the world's world border.void
giveExp
(int amount) Gives the player the amount of experience specified.void
giveExpLevels
(int amount) Gives the player the amount of experience levels specified.void
hideEntity
(Plugin plugin, Entity entity) Visually hides an entity from this player.void
hidePlayer
(Player player) Deprecated.void
hidePlayer
(Plugin plugin, Player player) Hides a player from this playerboolean
Gets whether the player has the "Allow Server Listings" setting enabled.boolean
isFlying()
Checks to see if this player is currently flying or not.boolean
Gets if the client is displayed a 'scaled' health, that is, health on a scale from 0-getHealthScale()
.boolean
Deprecated.This value is controlled only by the client and is therefore unreliable and vulnerable to spoofing and/or desync depending on the context/time which it is accessedboolean
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
Returns whether the player is sleeping ignored.boolean
Returns if the player is in sneak modeboolean
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
Open aMaterial.WRITTEN_BOOK
for a Playervoid
Open a Sign for editing by the Player.void
Open a Sign for editing by the Player.boolean
performCommand
(String command) Makes the player perform the given commandvoid
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
Deprecated.Magic valuevoid
playNote
(Location loc, Instrument instrument, Note note) Play a note for the player at a location.void
Play a sound for a player at the location of the entity.void
playSound
(Entity entity, String sound, SoundCategory category, float volume, float pitch) Play a sound for a player at the location of the entity.void
playSound
(Entity entity, String sound, SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location of the entity.void
Play a sound for a player at the location of the entity.void
playSound
(Entity entity, Sound sound, SoundCategory category, float volume, float pitch) Play a sound for a player at the location of the entity.void
playSound
(Entity entity, Sound sound, SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location of the entity.void
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
playSound
(Location location, String sound, SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location.void
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, Sound sound, SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location.void
removeCustomChatCompletions
(Collection<String> completions) Remove custom chat completion suggestions shown to the player while typing a message.void
Restores the normal condition where the player's time is synchronized with the server time.void
Restores the normal condition where the player's weather is controlled by server conditions.void
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 foldervoid
sendBlockChange
(Location loc, BlockData block) Send a block change.void
sendBlockChange
(Location loc, Material material, byte data) Deprecated.Magic valuevoid
sendBlockChanges
(Collection<BlockState> blocks) Send a multi-block change.void
sendBlockChanges
(Collection<BlockState> blocks, boolean suppressLightUpdates) Deprecated.suppressLightUpdates is not functional in versions greater than 1.19.4void
sendBlockDamage
(Location loc, float progress) Send block damage.void
sendBlockDamage
(Location loc, float progress, int sourceId) Send block damage.void
sendBlockDamage
(Location loc, float progress, Entity source) Send block damage.void
sendBlockUpdate
(Location loc, TileState tileState) Send a TileState change.void
sendEquipmentChange
(LivingEntity entity, Map<EquipmentSlot, ItemStack> items) Send multiple equipment changes for the target entity.void
sendEquipmentChange
(LivingEntity entity, EquipmentSlot slot, ItemStack item) Send an equipment change for the target entity.void
sendExperienceChange
(float progress) Send an experience change.void
sendExperienceChange
(float progress, int level) Send an experience change.void
Send a health update to the player using its known server values.void
sendHealthUpdate
(double health, int foodLevel, float saturation) Send a health update to the player.void
sendHurtAnimation
(float yaw) Send a hurt animation.void
Render a map and send it to the player in its entirety.void
sendRawMessage
(String message) Sends this sender a message rawvoid
sendSignChange
(Location loc, String[] lines) Send a sign change.void
sendSignChange
(Location loc, String[] lines, DyeColor dyeColor) Send a sign change.void
sendSignChange
(Location loc, String[] lines, DyeColor dyeColor, boolean hasGlowingText) Send a sign change.void
Deprecated.API behavior subject to changevoid
Sends a title and a subtitle message to the player.void
setAllowFlight
(boolean flight) Sets if the Player is allowed to fly via jump key double-tap like in creative mode.void
setBedSpawnLocation
(Location location) Sets the Location where the player will spawn at their bed.void
setBedSpawnLocation
(Location location, boolean force) Sets the Location where the player will spawn at their bed.void
setCompassTarget
(Location loc) Set the target of the player's compass.void
setCustomChatCompletions
(Collection<String> completions) Set the list of chat completion suggestions shown to the player while typing a message.void
setDisplayName
(String name) Sets the "friendly" name to display of this player.void
setExp
(float exp) Sets the players current experience points towards the next levelvoid
setExpCooldown
(int ticks) Sets the player's cooldown between picking up experience orbs..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
setHealthScale
(double scale) Sets the number to scale health to for the client; this will alsosetHealthScaled(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 levelvoid
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
(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
setPlayerTime
(long time, boolean relative) Sets the current time on the player's client.void
setPlayerWeather
(WeatherType type) Sets the type of weather the player will see.void
setResourcePack
(String url) Request that the player's client download and switch resource packs.void
setResourcePack
(String url, byte[] hash) Request that the player's client download and switch resource packs.void
setResourcePack
(String url, byte[] hash, boolean force) Request that the player's client download and switch resource packs.void
setResourcePack
(String url, byte[] hash, String prompt) Request that the player's client download and switch resource packs.void
setResourcePack
(String url, byte[] hash, String prompt, boolean force) Request that the player's client download and switch resource packs.void
setResourcePack
(UUID id, String url, byte[] hash, String prompt, boolean force) Request that the player's client download and switch resource packs.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 playervoid
setSpectatorTarget
(Entity entity) Sets the entity which is followed by the camera when inGameMode.SPECTATOR
.void
setSprinting
(boolean sprinting) Sets whether the player is sprinting or not.void
setTexturePack
(String url) Deprecated.Minecraft no longer uses textures packs.void
setTotalExperience
(int exp) Sets the players current experience points.void
setWalkSpeed
(float value) Sets the speed at which a client will walk.void
setWorldBorder
(WorldBorder border) Sets theWorldBorder
visible to this Player.void
Shows the demo screen to the player, this screen is normally only seen in the demo version of the game.void
showEntity
(Plugin plugin, Entity entity) Allows this player to see an entity that was previously hidden.void
showPlayer
(Player player) Deprecated.void
showPlayer
(Plugin plugin, Player player) Allows this player to see a player that was previously hidden.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.spigot()
void
Stop all sounds from playing.void
Stop the specified sound from playing.void
stopSound
(String sound, SoundCategory category) Stop the specified sound from playing.void
Stop the specified sound from playing.void
stopSound
(SoundCategory category) Stop the specified sound category from playing.void
stopSound
(Sound sound, SoundCategory category) Stop the specified sound from playing.void
Update the list of commands sent to the client.void
Forces an update of the player's entire inventory.Methods inherited from interface org.bukkit.attribute.Attributable
getAttribute
Methods inherited from interface org.bukkit.command.CommandSender
sendMessage, sendMessage, sendMessage, sendMessage
Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable
serialize
Methods inherited from interface org.bukkit.conversations.Conversable
abandonConversation, abandonConversation, acceptConversationInput, beginConversation, isConversing, sendRawMessage
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, copy, copy, createSnapshot, eject, getBoundingBox, getEntityId, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isFrozen, isGlowing, isInsideVehicle, isInvulnerable, isInWater, isInWorld, isPersistent, isSilent, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, teleport, teleport, teleport, teleport
Methods inherited from interface org.bukkit.entity.HumanEntity
closeInventory, discoverRecipe, discoverRecipes, dropItem, fireworkBoost, getAttackCooldown, getBedLocation, getCooldown, getDiscoveredRecipes, getEnchantmentSeed, getEnderChest, getExhaustion, getExpToLevel, getFoodLevel, getGameMode, getInventory, getItemInHand, getItemInUse, getItemOnCursor, getLastDeathLocation, getMainHand, getOpenInventory, getSaturatedRegenRate, getSaturation, getShoulderEntityLeft, getShoulderEntityRight, getSleepTicks, getStarvationRate, getUnsaturatedRegenRate, hasCooldown, hasDiscoveredRecipe, isBlocking, isHandRaised, openEnchanting, openInventory, openInventory, openMerchant, openMerchant, openWorkbench, setCooldown, setEnchantmentSeed, setExhaustion, setFoodLevel, setGameMode, setItemInHand, setItemOnCursor, setLastDeathLocation, setSaturatedRegenRate, setSaturation, setShoulderEntityLeft, setShoulderEntityRight, setStarvationRate, setUnsaturatedRegenRate, setWindowProperty, sleep, undiscoverRecipe, undiscoverRecipes, wakeup
Methods inherited from interface org.bukkit.entity.LivingEntity
addPotionEffect, addPotionEffect, addPotionEffects, attack, canBreatheUnderwater, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getCanPickupItems, getCategory, getCollidableExemptions, getDeathSound, getDrinkingSound, getEatingSound, getEquipment, getEyeHeight, getEyeHeight, getEyeLocation, getFallDamageSound, getFallDamageSoundBig, getFallDamageSoundSmall, getHurtSound, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoActionTicks, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getTargetBlock, getTargetBlockExact, getTargetBlockExact, hasAI, hasLineOfSight, hasPotionEffect, isClimbing, isCollidable, isGliding, isInvisible, isLeashed, isRiptiding, isSleeping, isSwimming, playHurtAnimation, rayTraceBlocks, rayTraceBlocks, removePotionEffect, setAI, setArrowCooldown, setArrowsInBody, setCanPickupItems, setCollidable, setGliding, setInvisible, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoActionTicks, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setSwimming, swingMainHand, swingOffHand
Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata
Methods inherited from interface org.bukkit.Nameable
getCustomName, setCustomName
Methods inherited from interface org.bukkit.OfflinePlayer
ban, ban, ban, decrementStatistic, decrementStatistic, decrementStatistic, decrementStatistic, decrementStatistic, decrementStatistic, getFirstPlayed, getLastDeathLocation, getLastPlayed, getPlayer, getPlayerProfile, getStatistic, getStatistic, getStatistic, getUniqueId, hasPlayedBefore, incrementStatistic, incrementStatistic, incrementStatistic, incrementStatistic, incrementStatistic, incrementStatistic, isBanned, isOnline, isWhitelisted, setStatistic, setStatistic, setStatistic, setWhitelisted
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.persistence.PersistentDataHolder
getPersistentDataContainer
Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient
getListeningPluginChannels, sendPluginMessage
Methods inherited from interface org.bukkit.projectiles.ProjectileSource
launchProjectile, launchProjectile
Methods inherited from interface org.bukkit.permissions.ServerOperator
isOp, setOp
-
Method Details
-
getName
Returns the name of this player- Specified by:
getName
in interfaceAnimalTamer
- Specified by:
getName
in interfaceCommandSender
- Specified by:
getName
in interfaceHumanEntity
- Specified by:
getName
in interfaceOfflinePlayer
- Returns:
- Player name
-
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
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
Gets the name that is shown on the player list.- Returns:
- the player list name
-
setPlayerListName
Sets the name that is shown on the in-game player list.If the value is null, the name will be identical to
getName()
.- Parameters:
name
- new player list name
-
getPlayerListHeader
Gets the currently displayed player list header for this player.- Returns:
- player list header or null
-
setPlayerListHeader
Sets the currently displayed player list header for this player.- Parameters:
header
- player list header, null for empty
-
setCompassTarget
Set the target of the player's compass.- Parameters:
loc
- Location to point to
-
getCompassTarget
Get the previously set compass target.- Returns:
- location of the target
-
getAddress
Gets the socket address of this player- Returns:
- the player's address
-
sendRawMessage
Sends this sender a message raw- Specified by:
sendRawMessage
in interfaceConversable
- Parameters:
message
- Message to be displayed
-
kickPlayer
Kicks player with custom kick message.- Parameters:
message
- kick message
-
ban
@Nullable BanEntry<PlayerProfile> ban(@Nullable String reason, @Nullable Date expires, @Nullable String source, boolean kickPlayer) Adds this user to theProfileBanList
. If a previous ban exists, this will update the entry.- Parameters:
reason
- reason for the ban, null indicates implementation defaultexpires
- date for the ban's expiration (unban), or null to imply foreversource
- source of the ban, null indicates implementation defaultkickPlayer
- if the player need to be kick- Returns:
- the entry for the newly created ban, or the entry for the (updated) previous ban
-
ban
@Nullable BanEntry<PlayerProfile> ban(@Nullable String reason, @Nullable Instant expires, @Nullable String source, boolean kickPlayer) Adds this user to theProfileBanList
. If a previous ban exists, this will update the entry.- Parameters:
reason
- reason for the ban, null indicates implementation defaultexpires
- date for the ban's expiration (unban), or null to imply foreversource
- source of the ban, null indicates implementation defaultkickPlayer
- if the player need to be kick- Returns:
- the entry for the newly created ban, or the entry for the (updated) previous ban
-
ban
@Nullable BanEntry<PlayerProfile> ban(@Nullable String reason, @Nullable Duration duration, @Nullable String source, boolean kickPlayer) Adds this user to theProfileBanList
. If a previous ban exists, this will update the entry.- Parameters:
reason
- reason for the ban, null indicates implementation defaultduration
- the duration how long the ban lasts, or null to imply foreversource
- source of the ban, null indicates implementation defaultkickPlayer
- if the player need to be kick- Returns:
- the entry for the newly created ban, or the entry for the (updated) previous ban
-
banIp
@Nullable BanEntry<InetAddress> banIp(@Nullable String reason, @Nullable Date expires, @Nullable String source, boolean kickPlayer) Adds this user's current IP address to theIpBanList
. If a previous ban exists, this will update the entry. IfgetAddress()
is null this method will throw an exception.- Parameters:
reason
- reason for the ban, null indicates implementation defaultexpires
- date for the ban's expiration (unban), or null to imply foreversource
- source of the ban, null indicates implementation defaultkickPlayer
- if the player need to be kick- Returns:
- the entry for the newly created ban, or the entry for the (updated) previous ban
-
banIp
@Nullable BanEntry<InetAddress> banIp(@Nullable String reason, @Nullable Instant expires, @Nullable String source, boolean kickPlayer) Adds this user's current IP address to theIpBanList
. If a previous ban exists, this will update the entry. IfgetAddress()
is null this method will throw an exception.- Parameters:
reason
- reason for the ban, null indicates implementation defaultexpires
- date for the ban's expiration (unban), or null to imply foreversource
- source of the ban, null indicates implementation defaultkickPlayer
- if the player need to be kick- Returns:
- the entry for the newly created ban, or the entry for the (updated) previous ban
-
banIp
@Nullable BanEntry<InetAddress> banIp(@Nullable String reason, @Nullable Duration duration, @Nullable String source, boolean kickPlayer) Adds this user's current IP address to theIpBanList
. If a previous ban exists, this will update the entry. IfgetAddress()
is null this method will throw an exception.- Parameters:
reason
- reason for the ban, null indicates implementation defaultduration
- the duration how long the ban lasts, or null to imply foreversource
- source of the ban, null indicates implementation defaultkickPlayer
- if the player need to be kick- Returns:
- the entry for the newly created ban, or the entry for the (updated) previous ban
-
chat
Says a message (or runs a command).- Parameters:
msg
- message to print
-
performCommand
Makes the player perform the given command- Parameters:
command
- Command to perform- Returns:
- true if the command was successful, otherwise false
-
isOnGround
Deprecated.This value is controlled only by the client and is therefore unreliable and vulnerable to spoofing and/or desync depending on the context/time which it is accessedReturns true if the entity is supported by a block. This value is a state updated by the client after each movement.- Specified by:
isOnGround
in interfaceEntity
- Returns:
- True if entity is on ground.
- See Also:
-
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.
-
getBedSpawnLocation
Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.- Specified by:
getBedSpawnLocation
in interfaceOfflinePlayer
- Returns:
- Bed Spawn Location if bed exists, otherwise null.
-
setBedSpawnLocation
Sets the Location where the player will spawn at their bed.- Parameters:
location
- where to set the respawn location
-
setBedSpawnLocation
Sets the Location where the player will spawn at their bed.- Parameters:
location
- where to set the respawn locationforce
- whether to forcefully set the respawn location even if a valid bed is not present
-
playNote
Deprecated.Magic valuePlay a note for the player at a location.
This will work with cake.- Parameters:
loc
- The location to play the noteinstrument
- The instrument ID.note
- The note ID.
-
playNote
Play a note for the player at a location.
This will work with cake.This method will fail silently when called with
Instrument.CUSTOM_HEAD
.- Parameters:
loc
- The location to play the noteinstrument
- The instrumentnote
- The note
-
playSound
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 soundsound
- The sound to playvolume
- The volume of the soundpitch
- The pitch of the sound
-
playSound
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 soundsound
- The internal sound name to playvolume
- The volume of the soundpitch
- 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 soundsound
- The sound to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- 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 soundsound
- The internal sound name to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the sound
-
playSound
void playSound(@NotNull Location location, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location. For sounds with multiple variations passing the same seed will always play the same variation.This function will fail silently if Location or Sound are null.
- Parameters:
location
- The location to play the soundsound
- The sound to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the soundseed
- The seed for the sound
-
playSound
void playSound(@NotNull Location location, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location. For sounds with multiple variations passing the same seed will always play the same variation.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 soundsound
- The internal sound name to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the soundseed
- The seed for the sound
-
playSound
Play a sound for a player at the location of the entity.This function will fail silently if Entity or Sound are null.
- Parameters:
entity
- The entity to play the soundsound
- The sound to playvolume
- The volume of the soundpitch
- The pitch of the sound
-
playSound
Play a sound for a player at the location of the entity.This function will fail silently if Entity or Sound are null.
- Parameters:
entity
- The entity to play the soundsound
- The sound to playvolume
- The volume of the soundpitch
- The pitch of the sound
-
playSound
void playSound(@NotNull Entity entity, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch) Play a sound for a player at the location of the entity.This function will fail silently if Entity or Sound are null.
- Parameters:
entity
- The entity to play the soundsound
- The sound to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the sound
-
playSound
void playSound(@NotNull Entity entity, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch) Play a sound for a player at the location of the entity.This function will fail silently if Entity or Sound are null.
- Parameters:
entity
- The entity to play the soundsound
- The sound to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the sound
-
playSound
void playSound(@NotNull Entity entity, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location of the entity. For sounds with multiple variations passing the same seed will always play the same variation.This function will fail silently if Entity or Sound are null.
- Parameters:
entity
- The entity to play the soundsound
- The sound to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the soundseed
- The seed for the sound
-
playSound
void playSound(@NotNull Entity entity, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch, long seed) Play a sound for a player at the location of the entity. For sounds with multiple variations passing the same seed will always play the same variation.This function will fail silently if Entity or Sound are null.
- Parameters:
entity
- The entity to play the soundsound
- The sound to playcategory
- The category of the soundvolume
- The volume of the soundpitch
- The pitch of the soundseed
- The seed for the sound
-
stopSound
Stop the specified sound from playing.- Parameters:
sound
- the sound to stop
-
stopSound
Stop the specified sound from playing.- Parameters:
sound
- the sound to stop
-
stopSound
Stop the specified sound from playing.- Parameters:
sound
- the sound to stopcategory
- the category of the sound
-
stopSound
Stop the specified sound from playing.- Parameters:
sound
- the sound to stopcategory
- the category of the sound
-
stopSound
Stop the specified sound category from playing.- Parameters:
category
- the sound category to stop
-
stopAllSounds
void stopAllSounds()Stop all sounds from playing. -
playEffect
Deprecated.Magic valuePlays an effect to just this player.- Parameters:
loc
- the location to play the effect ateffect
- theEffect
data
- a data bit needed for some effects
-
playEffect
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 ateffect
- theEffect
data
- a data bit needed for some effects
-
breakBlock
Force this player to break a Block using the item in their main hand. This method will respect enchantments, handle item durability (if applicable) and drop experience and the correct items according to the tool/item in the player's hand.Note that this method will call a
BlockBreakEvent
, meaning that this method may not be successful in breaking the block if the event was cancelled by a third party plugin. Care should be taken if running this method in a BlockBreakEvent listener as recursion may be possible if it is invoked on the sameBlock
being broken in the event.Additionally, a
BlockDropItemEvent
is called for the items dropped by this method (if successful).The block must be in the same world as the player.
- Parameters:
block
- the block to break- Returns:
- true if the block was broken, false if the break failed
-
sendBlockChange
Deprecated.Magic valueSend 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 blockmaterial
- The new blockdata
- The block data
-
sendBlockChange
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 blockblock
- The new block
-
sendBlockChanges
Send a multi-block change. This fakes a block change packet for a user at multiple locations. This will not actually change the world in any way.This method may send multiple packets to the client depending on the blocks in the collection. A packet must be sent for each chunk section modified, meaning one packet for each 16x16x16 block area. Even if only one block is changed in two different chunk sections, two packets will be sent.
Additionally, this method cannot guarantee the functionality of changes being sent to the player in chunks not loaded by the client. It is the responsibility of the caller to ensure that the client is within range of the changed blocks or to handle any side effects caused as a result.
- Parameters:
blocks
- the block states to send to the player
-
sendBlockChanges
@Deprecated void sendBlockChanges(@NotNull Collection<BlockState> blocks, boolean suppressLightUpdates) Deprecated.suppressLightUpdates is not functional in versions greater than 1.19.4Send a multi-block change. This fakes a block change packet for a user at multiple locations. This will not actually change the world in any way.This method may send multiple packets to the client depending on the blocks in the collection. A packet must be sent for each chunk section modified, meaning one packet for each 16x16x16 block area. Even if only one block is changed in two different chunk sections, two packets will be sent.
Additionally, this method cannot guarantee the functionality of changes being sent to the player in chunks not loaded by the client. It is the responsibility of the caller to ensure that the client is within range of the changed blocks or to handle any side effects caused as a result.
- Parameters:
blocks
- the block states to send to the playersuppressLightUpdates
- whether or not light updates should be suppressed when updating the blocks on the client
-
sendBlockDamage
Send block damage. This fakes block break progress at a certain location sourced by this player. This will not actually change the block's break progress in any way.- Parameters:
loc
- the location of the damaged blockprogress
- the progress from 0.0 - 1.0 where 0 is no damage and 1.0 is the most damaged
-
sendBlockDamage
Send block damage. This fakes block break progress at a certain location sourced by the provided entity. This will not actually change the block's break progress in any way.At the same location for each unique damage source sent to the player, a separate damage overlay will be displayed with the given progress. This allows for block damage at different progress from multiple entities at once.
- Parameters:
loc
- the location of the damaged blockprogress
- the progress from 0.0 - 1.0 where 0 is no damage and 1.0 is the most damagedsource
- the entity to which the damage belongs
-
sendBlockDamage
Send block damage. This fakes block break progress at a certain location sourced by the provided entity id. This will not actually change the block's break progress in any way.At the same location for each unique damage source sent to the player, a separate damage overlay will be displayed with the given progress. This allows for block damage at different progress from multiple entities at once.
- Parameters:
loc
- the location of the damaged blockprogress
- the progress from 0.0 - 1.0 where 0 is no damage and 1.0 is the most damagedsourceId
- the entity id of the entity to which the damage belongs. Can be an id that does not associate directly with an existing or loaded entity.
-
sendEquipmentChange
void sendEquipmentChange(@NotNull LivingEntity entity, @NotNull EquipmentSlot slot, @Nullable ItemStack item) Send an equipment change for the target entity. This will not actually change the entity's equipment in any way.- Parameters:
entity
- the entity whose equipment to changeslot
- the slot to changeitem
- the item to which the slot should be changed, or null to set it to air
-
sendEquipmentChange
Send multiple equipment changes for the target entity. This will not actually change the entity's equipment in any way.- Parameters:
entity
- the entity whose equipment to changeitems
- the slots to change, where the values are the items to which the slot should be changed. null values will set the slot to air
-
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 viasendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)
.If the client does not have a sign at the given location it will display an error message to the user.
To change all attributes of a sign, including the back Side, use
sendBlockUpdate(org.bukkit.Location, org.bukkit.block.TileState)
.- Parameters:
loc
- the location of the signlines
- the new text on the sign or null to clear it- Throws:
IllegalArgumentException
- if location is nullIllegalArgumentException
- 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 viasendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)
.If the client does not have a sign at the given location it will display an error message to the user.
To change all attributes of a sign, including the back Side, use
sendBlockUpdate(org.bukkit.Location, org.bukkit.block.TileState)
.- Parameters:
loc
- the location of the signlines
- the new text on the sign or null to clear itdyeColor
- the color of the sign- Throws:
IllegalArgumentException
- if location is nullIllegalArgumentException
- if dyeColor is nullIllegalArgumentException
- if lines is non-null and has a length less than 4
-
sendSignChange
void sendSignChange(@NotNull Location loc, @Nullable String[] lines, @NotNull DyeColor dyeColor, boolean hasGlowingText) 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 viasendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)
.If the client does not have a sign at the given location it will display an error message to the user.
To change all attributes of a sign, including the back Side, use
sendBlockUpdate(org.bukkit.Location, org.bukkit.block.TileState)
.- Parameters:
loc
- the location of the signlines
- the new text on the sign or null to clear itdyeColor
- the color of the signhasGlowingText
- if the sign's text should be glowing- Throws:
IllegalArgumentException
- if location is nullIllegalArgumentException
- if dyeColor is nullIllegalArgumentException
- if lines is non-null and has a length less than 4
-
sendBlockUpdate
@Experimental void sendBlockUpdate(@NotNull Location loc, @NotNull TileState tileState) throws IllegalArgumentException Send a TileState change. This fakes a TileState change for a user at the given location. This will not actually change the world in any way. This method will use a TileState at the location's block or a faked TileState sent viasendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)
.If the client does not have an appropriate tile at the given location it may display an error message to the user.
BlockData.createBlockState()
can be used to create aBlockState
.- Parameters:
loc
- the location of the signtileState
- the tile state- Throws:
IllegalArgumentException
- if location is nullIllegalArgumentException
- if tileState is null
-
sendMap
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
-
sendHurtAnimation
void sendHurtAnimation(float yaw) Send a hurt animation. This fakes incoming damage towards the player from the given yaw relative to the player's direction.- Parameters:
yaw
- the yaw in degrees relative to the player's direction where 0 is in front of the player, 90 is to the right, 180 is behind, and 270 is to the left
-
addCustomChatCompletions
Add custom chat completion suggestions shown to the player while typing a message.- Parameters:
completions
- the completions to send
-
removeCustomChatCompletions
Remove custom chat completion suggestions shown to the player while typing a message. Online player names cannot be removed with this method. This will affect only custom completions added byaddCustomChatCompletions(Collection)
orsetCustomChatCompletions(Collection)
.- Parameters:
completions
- the completions to remove
-
setCustomChatCompletions
Set the list of chat completion suggestions shown to the player while typing a message.If completions were set previously, this method will remove them all and replace them with the provided completions.
- Parameters:
completions
- the completions to set
-
updateInventory
@Internal void updateInventory()Forces an update of the player's entire inventory.- API Note:
- It should not be necessary for plugins to use this method. If it is required for some reason, it is probably a bug.
-
getPreviousGameMode
Gets this player's previousGameMode
- Returns:
- Previous game mode or null
-
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
Sets the type of weather the player will see. When used, the weather status of the player is locked untilresetPlayerWeather()
is used.- Parameters:
type
- The WeatherType enum type the player should experience
-
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. -
getExpCooldown
int getExpCooldown()Gets the player's cooldown between picking up experience orbs.- Returns:
- The cooldown in ticks
-
setExpCooldown
void setExpCooldown(int ticks) Sets the player's cooldown between picking up experience orbs.. Note: Setting this to 0 allows the player to pick up instantly, but setting this to a negative value will cause the player to be unable to pick up xp-orbs. Calling this Method will result inPlayerExpCooldownChangeEvent
being called.- Parameters:
ticks
- The cooldown in ticks
-
giveExp
void giveExp(int amount) Gives the player the amount of experience specified.- Parameters:
amount
- Exp amount to give
-
giveExpLevels
void giveExpLevels(int amount) Gives the player the amount of experience levels specified. Levels can be taken by specifying a negative amount.- Parameters:
amount
- amount of experience levels to give or take
-
getExp
float getExp()Gets the players current experience points towards the next level.This is a percentage value. 0 is "no progress" and 1 is "next level".
- Returns:
- Current experience points
-
setExp
void setExp(float exp) Sets the players current experience points towards the next levelThis 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 not currently displayed to the client.- 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 not currently displayed to the client.- Parameters:
exp
- New total experience points
-
sendExperienceChange
void sendExperienceChange(float progress) Send an experience change. This fakes an experience change packet for a user. This will not actually change the experience points in any way.- Parameters:
progress
- Experience progress percentage (between 0.0 and 1.0)- See Also:
-
sendExperienceChange
void sendExperienceChange(float progress, int level) Send an experience change. This fakes an experience change packet for a user. This will not actually change the experience points in any way.- Parameters:
progress
- New experience progress percentage (between 0.0 and 1.0)level
- New experience level- See Also:
-
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.Hides a player from this player- Parameters:
player
- Player to hide
-
hidePlayer
Hides a player from this player- Parameters:
plugin
- Plugin that wants to hide the playerplayer
- Player to hide
-
showPlayer
Deprecated.Allows this player to see a player that was previously hidden- Parameters:
player
- Player to show
-
showPlayer
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 playerplayer
- Player to show
-
canSee
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
-
hideEntity
Visually hides an entity from this player.- Parameters:
plugin
- Plugin that wants to hide the entityentity
- Entity to hide- API Note:
- draft API
-
showEntity
Allows this player to see an entity that was previously hidden. If another another plugin had hidden the entity too, then the entity will remain hidden until the other plugin calls this method too.- Parameters:
plugin
- Plugin that wants to show the entityentity
- Entity to show- API Note:
- draft API
-
canSee
Checks to see if an entity has been visually hidden from this player.- Parameters:
entity
- Entity to check- Returns:
- True if the provided entity is not being hidden from this player
- API Note:
- draft API
-
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
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
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.Minecraft no longer uses textures packs. Instead you should usesetResourcePack(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.
- Players can disable server textures on their client, in which
case this method will have no affect on them. Use the
-
setResourcePack
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 empty string 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.
- Players can disable server resources on their client, in which
case this method will have no affect on them. Use the
-
setResourcePack
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. If the hash is null and 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 sent with empty string as the hash when the hash is not provided. 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.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 not 20 bytes long.
- Players can disable server resources on their client, in which
case this method will have no affect on them. Use the
-
setResourcePack
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. If the hash is null and 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 sent with empty string as the hash when the hash is not provided. 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.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!prompt
- The optional custom prompt message to be shown to client.- 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 not 20 bytes long.
- Players can disable server resources on their client, in which
case this method will have no affect on them. Use the
-
setResourcePack
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. If the hash is null and 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 sent with empty string as the hash when the hash is not provided. 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.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!force
- If true, the client will be disconnected from the server when it declines to use the resource pack.- 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 not 20 bytes long.
- Players can disable server resources on their client, in which
case this method will have no affect on them. Use the
-
setResourcePack
void setResourcePack(@NotNull String url, @Nullable byte[] hash, @Nullable String prompt, boolean force) 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. If the hash is null and 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 sent with empty string as the hash when the hash is not provided. 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.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!prompt
- The optional custom prompt message to be shown to client.force
- If true, the client will be disconnected from the server when it declines to use the resource pack.- 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 not 20 bytes long.
- Players can disable server resources on their client, in which
case this method will have no affect on them. Use the
-
setResourcePack
void setResourcePack(@NotNull UUID id, @NotNull String url, @Nullable byte[] hash, @Nullable String prompt, boolean force) 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. If the hash is null and 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 sent with empty string as the hash when the hash is not provided. This might result in newer versions not loading the pack correctly.
- Parameters:
id
- Unique resource pack ID.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!prompt
- The optional custom prompt message to be shown to client.force
- If true, the client will be disconnected from the server when it declines to use the resource pack.- 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 not 20 bytes long.
- Players can disable server resources on their client, in which
case this method will have no affect on them. Use the
-
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 nullIllegalArgumentException
- if scoreboard was not created by thescoreboard manager
IllegalStateException
- if this is a player that is not logged yet or has logged out
-
getWorldBorder
Gets theWorldBorder
visible to this Player, or null if viewing the world's world border.- Returns:
- the player's world border
-
setWorldBorder
Sets theWorldBorder
visible to this Player.- Parameters:
border
- the border to set, or null to set to the world border of the player's current world- Throws:
UnsupportedOperationException
- if setting the border to that of a world in which the player is not currently present.- See Also:
-
sendHealthUpdate
void sendHealthUpdate(double health, int foodLevel, float saturation) Send a health update to the player. This will adjust the health, food, and saturation on the client and will not affect the player's actual values on the server. As soon as any of these values change on the server, changes sent by this method will no longer be visible.- Parameters:
health
- the health. If 0.0, the client will believe it is deadfoodLevel
- the food levelsaturation
- the saturation
-
sendHealthUpdate
void sendHealthUpdate()Send a health update to the player using its known server values. This will synchronize the health, food, and saturation on the client and therefore may be useful when changing a player's maximum health attribute. -
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
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
Sets the number to scale health to for the client; this will alsosetHealthScaled(true)
.Displayed health follows a simple formula
displayedHealth = getHealth() / getMaxHealth() * getHealthScale()
.- Parameters:
scale
- the number to scale health to- Throws:
IllegalArgumentException
- if scale is <0IllegalArgumentException
- if scale isDouble.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:
-
getSpectatorTarget
Gets the entity which is followed by the camera when inGameMode.SPECTATOR
.- Returns:
- the followed entity, or null if not in spectator mode or not following a specific entity.
-
setSpectatorTarget
Sets the entity which is followed by the camera when inGameMode.SPECTATOR
.- Parameters:
entity
- the entity to follow or null to reset- Throws:
IllegalStateException
- if the player is not inGameMode.SPECTATOR
-
sendTitle
Deprecated.API behavior subject to changeSends 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 textsubtitle
- 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 textsubtitle
- Subtitle textfadeIn
- 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
Spawns the particle (the number of times specified by count) at the target location.- Parameters:
particle
- the particle to spawnlocation
- the location to spawn atcount
- the number of particles
-
spawnParticle
Spawns the particle (the number of times specified by count) at the target location.- Parameters:
particle
- the particle to spawnx
- the position on the x axis to spawn aty
- the position on the y axis to spawn atz
- the position on the z axis to spawn atcount
- 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 (seeParticle.getDataType()
- Parameters:
particle
- the particle to spawnlocation
- the location to spawn atcount
- the number of particlesdata
- the data to use for the particle or null, the type of this depends onParticle.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 (seeParticle.getDataType()
- Parameters:
particle
- the particle to spawnx
- the position on the x axis to spawn aty
- the position on the y axis to spawn atz
- the position on the z axis to spawn atcount
- the number of particlesdata
- the data to use for the particle or null, the type of this depends onParticle.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 spawnlocation
- the location to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- 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 spawnx
- the position on the x axis to spawn aty
- the position on the y axis to spawn atz
- the position on the z axis to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- 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 (seeParticle.getDataType()
- Parameters:
particle
- the particle to spawnlocation
- the location to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- the maximum random offset on the Z axisdata
- the data to use for the particle or null, the type of this depends onParticle.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 (seeParticle.getDataType()
- Parameters:
particle
- the particle to spawnx
- the position on the x axis to spawn aty
- the position on the y axis to spawn atz
- the position on the z axis to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- the maximum random offset on the Z axisdata
- the data to use for the particle or null, the type of this depends onParticle.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 spawnlocation
- the location to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- the maximum random offset on the Z axisextra
- 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 spawnx
- the position on the x axis to spawn aty
- the position on the y axis to spawn atz
- the position on the z axis to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- the maximum random offset on the Z axisextra
- 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 (seeParticle.getDataType()
- Parameters:
particle
- the particle to spawnlocation
- the location to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- the maximum random offset on the Z axisextra
- 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 onParticle.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 (seeParticle.getDataType()
- Parameters:
particle
- the particle to spawnx
- the position on the x axis to spawn aty
- the position on the y axis to spawn atz
- the position on the z axis to spawn atcount
- the number of particlesoffsetX
- the maximum random offset on the X axisoffsetY
- the maximum random offset on the Y axisoffsetZ
- the maximum random offset on the Z axisextra
- 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 onParticle.getDataType()
-
getAdvancementProgress
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
-
getPing
int getPing()Gets the player's estimated ping in milliseconds. In Vanilla this value represents a weighted average of the response time to application layer ping packets sent. This value does not represent the network round trip time and as such may have less granularity and be impacted by other sources. For these reasons it should not be used for anti-cheat purposes. Its recommended use is only as a qualitative indicator of connection quality (Vanilla uses it for this purpose in the tab list).- Returns:
- player ping
-
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
-
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
Open aMaterial.WRITTEN_BOOK
for a Player- Parameters:
book
- The book to open for this player
-
openSign
Open a Sign for editing by the Player. The Sign must be placed in the same world as the player.- Parameters:
sign
- The sign to edit
-
openSign
Open a Sign for editing by the Player. The Sign must be placed in the same world as the player.- Parameters:
sign
- The sign to editside
- The side to edit
-
showDemoScreen
void showDemoScreen()Shows the demo screen to the player, this screen is normally only seen in the demo version of the game.
Servers can modify the text on this screen using a resource pack. -
isAllowingServerListings
boolean isAllowingServerListings()Gets whether the player has the "Allow Server Listings" setting enabled.- Returns:
- whether the player allows server listings
-
spigot
- Specified by:
spigot
in interfaceCommandSender
- Specified by:
spigot
in interfaceEntity
-
hidePlayer(Plugin, Player)