Documentation

Player extends Human

in package

• Application

implements CommandSender, ChunkListener, IPlayer Uses PermissibleDelegateTrait, ChunkListenerNoOpTrait

Main class that handles networking, recovery, and packet sending to the server part

Interfaces, Classes, Traits and Enums

CommandSender

ChunkListener

This interface allows you to listen for events occurring on or in specific chunks. This will receive events for any chunks which it is registered to listen to.

IPlayer

Table of Contents

MOTION_THRESHOLD  = 1.0E-5

DEFAULT_BREATH_TICKS  = 300

STEP_CLIP_MULTIPLIER  = 0.4

MOVE_BACKLOG_SIZE  = 100 * self::MOVES_PER_TICK

MOVES_PER_TICK  = 2

$boundingBox  : AxisAlignedBB

$canCollide  : bool

$deadTicks  : int

$fallDistance  : float

$isCollided  : bool

$isCollidedHorizontally  : bool

$isCollidedVertically  : bool

$keepMovement  : bool

$lastUpdate  : int

$noDamageTicks  : int

$onGround  : bool

$size  : EntitySizeInfo

$spawned  : bool

$ticksLived  : int

$absorptionAttr  : Attribute

$allowFlight  : bool

$alwaysShowNameTag  : bool

$armorInventory  : ArmorInventory

$attackTime  : int

$attributeMap  : AttributeMap

$authenticated  : bool

$autoJump  : bool

$blockBreakHandler  : SurvivalBlockBreakHandler|null

$blocksAround  : array<string|int, Block>|null

$breathing  : bool

$breathTicks  : int

$canClimb  : bool

$canClimbWalls  : bool

$chunkLoader  : PlayerChunkLoader

$chunkSelector  : ChunkSelector

$chunksPerTick  : int

$closed  : bool

$craftingGrid  : PlayerCraftingInventory

$currentWindow  : Inventory|null

$cursorInventory  : PlayerCursorInventory

$displayName  : string

$drag  : float

$effectManager  : EffectManager

$enderInventory  : PlayerEnderInventory

$fireTicks  : int

$firstPlayed  : int

$flying  : bool

$forceMovementUpdate  : bool

$formIdCounter  : int

$forms  : array<string|int, mixed>

$gamemode  : GameMode

$gravity  : float

$gravityEnabled  : bool

$hasSpawned  : array<string|int, Player>

$healthAttr  : Attribute

$hiddenPlayers  : array<string|int, mixed>

$hungerManager  : HungerManager

$id  : int

$immobile  : bool

$inAirTicks  : int

$inventory  : PlayerInventory

$invisible  : bool

$isStatic  : bool

$jumpVelocity  : float

$justCreated  : bool

$knockbackResistanceAttr  : Attribute

$lastDamageCause  : EntityDamageEvent|null

$lastLocation  : Location

$lastMotion  : Vector3

$lastMovementProcess  : float|null

$lastPlayed  : int

$lineHeight  : int|null

$loadQueue  : array<string|int, mixed>

$locale  : string

$location  : Location

$logger  : Logger

$maxBreathTicks  : int

$maxDeadTicks  : int

$messageCounter  : int

$motion  : Vector3

$moveRateLimit  : float

$moveSpeedAttr  : Attribute

$nameTag  : string

$nameTagVisible  : bool

$networkPropertiesDirty  : bool

$networkSession  : NetworkSession|null

$nextChunkOrderRun  : int

$offHandInventory  : PlayerOffHandInventory

$ownerId  : int|null

$permanentWindows  : array<string|int, mixed>

$playerInfo  : PlayerInfo

$scale  : float

$scoreTag  : string

$server  : Server

$silent  : bool

$skin  : Skin

$sleeping  : Vector3|null

$sneaking  : bool

$spawnChunkLoadCount  : int

$spawnThreshold  : int

$sprinting  : bool

$startAction  : int

$stepHeight  : float

$targetId  : int|null

$timings  : TimingsHandler

$usedChunks  : array<string|int, mixed>

$usedItemsCooldown  : array<string|int, mixed>

$username  : string

$uuid  : UuidInterface

$viewDistance  : int

$xpManager  : ExperienceManager

$xpSeed  : int

$xuid  : string

$ySize  : float

$activeChunkGenerationRequests  : array<string|int, mixed>

$closeInFlight  : bool

$entityCount  : int

$health  : float

$lastEmoteTick  : int

$maxHealth  : int

$needsDespawn  : bool

$networkProperties  : EntityMetadataCollection

$perm  : Permissible

$respawnLocked  : bool

$savedWithChunk  : bool

$spawnPosition  : Position|null

__construct()  : mixed

__debugInfo()  : array<string|int, mixed>

__destruct()  : mixed

__toString()  : mixed

addAttachment()  : PermissionAttachment

addMotion()  : void

Adds the given values to the entity's motion vector.

applyDamageModifiers()  : void

Called prior to EntityDamageEvent execution to apply modifications to the event's damage, such as reduction due to effects or armour.

attack()  : void

attackBlock()  : bool

Performs a left-click (attack) action on the block.

attackEntity()  : bool

Attacks the given entity with the currently-held item.

breakBlock()  : bool

Breaks the block at the given position using the currently-held item.

broadcastAnimation()  : void

broadcastSound()  : void

canBeCollidedWith()  : bool

canBeMovedByCurrents()  : bool

canBreathe()  : bool

canClimb()  : bool

Returns whether the entity is able to climb blocks such as ladders or vines.

canClimbWalls()  : bool

Returns whether this entity is climbing a block. By default this is only true if the entity is climbing a ladder or vine or similar block.

canCollideWith()  : bool

canInteract()  : bool

Returns whether the player can interact with the specified position. This checks distance and direction.

canSaveWithChunk()  : bool

canSee()  : bool

changeSkin()  : bool

Called when a player changes their skin.

chat()  : bool

Sends a chat message as this player. If the message begins with a / (forward-slash) it will be treated as a command.

close()  : void

Closes the entity and frees attached references.

consumeHeldItem()  : bool

Consumes the currently-held item.

consumeObject()  : bool

Causes the mob to consume the given Consumable object, applying applicable effects, health bonuses, food bonuses, etc.

continueBreakBlock()  : void

damageArmor()  : void

Damages the worn armour according to the amount of damage given. Each 4 points (rounded down) deals 1 damage point to each armour piece, but never less than 1 total.

despawnFrom()  : void

despawnFromAll()  : void

disconnect()  : void

Removes the player from the server. This cannot be cancelled.

doChunkRequests()  : void

Ticks the chunk-requesting mechanism.

doFirstSpawn()  : void

Called by the network system when the pre-spawn sequence is completed (e.g. after sending spawn chunks).

dropItem()  : void

Drops an item on the ground in front of the player.

emote()  : void

extinguish()  : void

flagForDespawn()  : void

Flags the entity to be removed from the world on the next tick.

getAbsorption()  : float

getAirSupplyTicks()  : int

Returns the number of ticks remaining in the entity's air supply. Note that the entity may survive longer than this amount of time without damage due to enchantments such as Respiration.

getAllowFlight()  : bool

getArmorInventory()  : ArmorInventory

getArmorPoints()  : int

Returns how many armour points this mob has. Armour points provide a percentage reduction to damage.

getAttributeMap()  : AttributeMap

getBoundingBox()  : AxisAlignedBB

getCraftingGrid()  : CraftingGrid

getCurrentWindow()  : Inventory|null

Returns the inventory the player is currently viewing. This might be a chest, furnace, or any other container.

getCursorInventory()  : PlayerCursorInventory

getDirectionPlane()  : Vector2

getDirectionVector()  : Vector3

getDisplayName()  : string

Returns the "friendly" display name of this player to use in the chat.

getDrops()  : array<string|int, Item>

getEffectivePermissions()  : array<string|int, PermissionAttachmentInfo>

getEffects()  : EffectManager

getEnderInventory()  : PlayerEnderInventory

getEyeHeight()  : float

getEyePos()  : Vector3

getFallDistance()  : float

getFireTicks()  : int

getFirstPlayed()  : int|null

TODO: not sure this should be nullable

getGamemode()  : GameMode

getHealth()  : float

getHighestArmorEnchantmentLevel()  : int

Returns the highest level of the specified enchantment on any armour piece that the entity is currently wearing.

getHorizontalFacing()  : int

getHungerManager()  : HungerManager

getId()  : int

getInAirTicks()  : int

getInventory()  : PlayerInventory

Get the object related inventory

getItemCooldownExpiry()  : int

Returns the server tick on which the player's cooldown period expires for the given item.

getItemUseDuration()  : int

Returns how long the player has been using their currently-held item for. Used for determining arrow shoot force for bows.

getJumpVelocity()  : float

Returns the initial upwards velocity of a jumping entity in blocks/tick, including additional velocity due to effects.

getLanguage()  : Language

getLastDamageCause()  : EntityDamageEvent|null

getLastPlayed()  : int|null

TODO: not sure this should be nullable

getLeaveMessage()  : Translatable|string

getLineOfSight()  : array<string|int, Block>

getLocale()  : string

Returns the player's locale, e.g. en_US.

getLocation()  : Location

getMaxAirSupplyTicks()  : int

Returns the maximum amount of air ticks the entity's air supply can contain.

getMaxHealth()  : int

getMotion()  : Vector3

getMovementSpeed()  : float

getName()  : string

Gets the username

getNameTag()  : string

getNetworkProperties()  : EntityMetadataCollection

getNetworkSession()  : NetworkSession

getNetworkTypeId()  : string

getOffHandInventory()  : PlayerOffHandInventory

getOffsetPosition()  : Vector3

getOwningEntity()  : Entity|null

Returns the owning entity, or null if the entity was not found.

getOwningEntityId()  : int|null

Returns the entity ID of the owning entity, or null if the entity doesn't have an owner.

getPermissionRecalculationCallbacks()  : ObjectSet|array<string|int, Closure>

getPlayerInfo()  : PlayerInfo

Returns an object containing information about the player, such as their username, skin, and misc extra client-specific data.

getPosition()  : Position

getSaveData()  : CompoundTag

getScale()  : float

getScoreTag()  : string|null

getScreenLineHeight()  : int

Returns the line height of the command-sender's screen. Used for determining sizes for command output pagination such as in the /help command.

getServer()  : Server

getSkin()  : Skin

Returns a Skin object containing information about this human's skin.

getSpawn()  : Position

getTargetBlock()  : Block|null

getTargetEntity()  : Entity|null

Returns the entity's target entity, or null if not found.

getTargetEntityId()  : int|null

Returns the entity ID of the entity's target, or null if it doesn't have a target.

getUniqueId()  : UuidInterface

Returns the player's UUID. This should be the preferred method to identify a player.

getUsedChunks()  : array<string|int, UsedChunkStatus>

getUsedChunkStatus()  : UsedChunkStatus|null

Returns a usage status of the given chunk, or null if the player is not using the given chunk.

getViewDistance()  : int

getViewers()  : array<string|int, Player>

getWorld()  : World

getXpDropAmount()  : int

Returns the amount of XP this mob will drop on death.

getXpManager()  : ExperienceManager

getXuid()  : string

If the player is logged into Xbox Live, returns their Xbox user ID (XUID) as a string. Returns an empty string if the player is not logged into Xbox Live.

handleMovement()  : void

Attempts to move the player to the given coordinates. Unless you have some particularly specialized logic, you probably want to use teleport() instead of this.

hasAutoJump()  : bool

hasFiniteResources()  : bool

TODO: make this a dynamic ability instead of being hardcoded

hasGravity()  : bool

hasItemCooldown()  : bool

Returns whether the player has a cooldown period left before it can use the given item again.

hasLineOfSight()  : bool

hasMovementUpdate()  : bool

Returns whether the entity needs a movement update on the next tick.

hasPermission()  : bool

hasPlayedBefore()  : bool

hasReceivedChunk()  : bool

Returns whether the target chunk has been sent to this player.

hasValidCustomSpawn()  : bool

heal()  : void

hidePlayer()  : void

interactBlock()  : bool

Touches the block at the given position with the currently-held item.

interactEntity()  : bool

Interacts with the given entity using the currently-held item.

isAdventure()  : bool

NOTE: Because Adventure and Spectator Mode share some similar behaviour, this method will also return true if the player is in Spectator Mode. Supply the $literal parameter as true to force a literal Adventure Mode check.

isAlive()  : bool

isAuthenticated()  : bool

isBreathing()  : bool

Returns whether the entity is currently breathing or not. If this is false, the entity's air supply will be used.

isClosed()  : bool

Returns whether the entity has been "closed".

isConnected()  : bool

isCreative()  : bool

NOTE: Because Creative and Spectator Mode share some similar behaviour, this method will also return true if the player is in Spectator Mode. Supply the $literal parameter as true to force a literal Creative Mode check.

isFireProof()  : bool

isFlaggedForDespawn()  : bool

isFlying()  : bool

isImmobile()  : bool

isInsideOfSolid()  : bool

isInvisible()  : bool

isNameTagAlwaysVisible()  : bool

isNameTagVisible()  : bool

isOnFire()  : bool

isOnGround()  : bool

isOnline()  : bool

isPermissionSet()  : bool

isSilent()  : bool

isSleeping()  : bool

isSneaking()  : bool

isSpectator()  : bool

isSprinting()  : bool

isSurvival()  : bool

NOTE: Because Survival and Adventure Mode share some similar behaviour, this method will also return true if the player is in Adventure Mode. Supply the $literal parameter as true to force a literal Survival Mode check.

isUnderwater()  : bool

isUsingChunk()  : bool

Returns whether the player is using the chunk with the given coordinates, irrespective of whether the chunk has been sent yet.

isUsingItem()  : bool

Returns whether the player is currently using an item (right-click and hold).

isValidUserName()  : bool

Validates the given username.

jump()  : void

Called when the entity jumps from the ground. This method adds upwards velocity to the entity.

kick()  : bool

Kicks a player from the server

kill()  : void

knockBack()  : void

lookAt()  : void

Changes the entity's yaw and pitch to make it look at the specified Vector3 position. For mobs, this will cause their heads to turn.

nextRuntimeId()  : int

Returns a new runtime entity ID for a new entity.

onAirExpired()  : void

Called when the entity's air supply ticks reaches -20 or lower. The entity will usually take damage at this point and then the supply is reset to 0, so this method will be called roughly every second.

onBlockChanged()  : void

onChunkChanged()  : void

This method will be called when a Chunk is replaced by a new one

onChunkLoaded()  : void

onChunkPopulated()  : void

onChunkUnloaded()  : void

This method will be called when a registered chunk is unloaded

onCollideWithPlayer()  : void

onFormSubmit()  : bool

onInteract()  : bool

Called when interacted or tapped by a Player. Returns whether something happened as a result of the interaction.

onNearbyBlockChange()  : void

onRandomUpdate()  : void

Called when a random update is performed on the chunk the entity is in. This happens when the chunk is within the ticking chunk range of a player (or chunk loader).

onUpdate()  : bool

parseSkinNBT()  : Skin

pickBlock()  : bool

recalculatePermissions()  : array<string|int, mixed>

releaseHeldItem()  : bool

Releases the held item, for example to fire a bow. This should be preceded by a call to useHeldItem().

removeAttachment()  : void

removeCurrentWindow()  : void

removeTitles()  : void

Removes the title from the client's screen.

resetFallDistance()  : void

resetItemCooldown()  : void

Resets the player's cooldown time for the given item back to the maximum.

resetTitles()  : void

Resets the title duration settings to defaults and removes any existing titles.

respawn()  : void

respawnToAll()  : void

save()  : void

Handles player data saving

saveNBT()  : CompoundTag

scheduleUpdate()  : void

selectHotbarSlot()  : bool

sendActionBarMessage()  : void

Adds small text to the user's screen.

sendData()  : void

sendForm()  : void

Sends a Form to the player, or queue to send it if a form is already open.

sendJukeboxPopup()  : void

sendMessage()  : void

Sends a direct chat message to a player

sendPopup()  : void

Sends a popup message to the player

sendSkin()  : void

Sends the human's skin to the specified list of players. If null is given for targets, the skin will be sent to all viewers.

sendSubTitle()  : void

Sets the subtitle message, without sending a title.

sendTip()  : void

sendTitle()  : void

Adds a title text to the user's screen, with an optional subtitle.

sendTranslation()  : void

setAbsorption()  : void

setAirSupplyTicks()  : void

Sets the number of air ticks left in the entity's air supply.

setAllowFlight()  : void

setAutoJump()  : void

setBasePermission()  : void

setBreathing()  : void

Sets whether the entity is currently breathing. If false, it will cause the entity's air supply to be used.

setCanClimb()  : void

Sets whether the entity is able to climb climbable blocks.

setCanClimbWalls()  : void

Sets whether the entity is climbing a block. If true, the entity can climb anything.

setCanSaveWithChunk()  : void

setCurrentWindow()  : bool

Opens an inventory window to the player. Returns if it was successful.

setDisplayName()  : void

setFallDistance()  : void

setFireTicks()  : void

setFlying()  : void

setForceMovementUpdate()  : void

Flags the entity as needing a movement update on the next tick. Setting this forces a movement update even if the entity's motion is zero. Used to trigger movement updates when blocks change near entities.

setGamemode()  : bool

Sets the gamemode, and if needed, kicks the Player.

setHasGravity()  : void

setHealth()  : void

Sets the health of the Entity. This won't send any update to the players

setImmobile()  : void

setInvisible()  : void

setLastDamageCause()  : void

setMaxAirSupplyTicks()  : void

Sets the maximum amount of air ticks the air supply can hold.

setMaxHealth()  : void

setMotion()  : bool

setMovementSpeed()  : void

setNameTag()  : void

setNameTagAlwaysVisible()  : void

setNameTagVisible()  : void

setOnFire()  : void

setOwningEntity()  : void

Sets the owner of the entity. Passing null will remove the current owner.

setRotation()  : void

setScale()  : void

setScoreTag()  : void

setScreenLineHeight()  : void

Sets the line height used for command output pagination for this command sender. `null` will reset it to default.

setSilent()  : void

setSkin()  : void

Sets the human's skin. This will not send any update to viewers, you need to do that manually using {@link sendSkin}.

setSneaking()  : void

setSpawn()  : void

Sets the spawnpoint of the player (and the compass direction) to a Vector3, or set it on another world with a Position object

setSprinting()  : void

setTargetEntity()  : void

Sets the entity's target entity. Passing null will remove the current target.

setTitleDuration()  : void

Sets the title duration.

setUsingItem()  : void

setViewDistance()  : void

showPlayer()  : void

sleepOn()  : bool

spawnTo()  : void

spawnToAll()  : void

stopBreakBlock()  : void

stopSleep()  : void

teleport()  : bool

{@inheritdoc}

toggleFlight()  : bool

toggleSneak()  : bool

toggleSprint()  : bool

transfer()  : bool

Transfers a player to another server.

unsetBasePermission()  : void

useHeldItem()  : bool

Activates the item in hand, for example throwing a projectile.

actuallyRespawn()  : void

addAttributes()  : void

addDefaultWindows()  : void

addPermanentInventories()  : void

applyConsumptionResults()  : void

Applies effects from consuming the object. This shouldn't do any can-consume checks (those are expected to be handled by the caller).

applyDragBeforeGravity()  : bool

applyPostDamageEffects()  : void

Called after EntityDamageEvent execution to apply post-hurt effects, such as reducing absorption or modifying armour durability.

broadcastMotion()  : void

broadcastMovement()  : void

calculateFallDamage()  : float

checkBlockIntersections()  : void

checkGroundState()  : void

checkItemCooldowns()  : void

checkNearEntities()  : void

checkObstruction()  : bool

dealFireDamage()  : void

Called to deal damage to entities when they are on fire.

destroyCycles()  : void

Called when the entity is disposed, after all events have been fired. This should be used to perform destructive circular object references and things which could impact memory usage.

doAirSupplyTick()  : bool

Ticks the entity's air supply, consuming it when underwater and regenerating it when out of water.

doHitAnimation()  : void

doOnFireTick()  : bool

endDeathAnimation()  : void

entityBaseTick()  : bool

getAllNetworkData()  : array<string|int, MetadataProperty>

getBlocksAroundWithEntityInsideActions()  : array<string|int, Block>

getDirtyNetworkData()  : array<string|int, MetadataProperty>

getInitialSizeInfo()  : EntitySizeInfo

initEntity()  : void

initHumanData()  : void

For Human entities which are not players, sets their properties such as nametag, skin and UUID from NBT.

internalSetGameMode()  : void

move()  : void

onDeath()  : void

onDeathUpdate()  : bool

onDispose()  : void

Called when the entity is disposed to clean up things like viewers. This SHOULD NOT destroy internal state, because it may be needed by descendent classes.

onHitGround()  : float|null

Called when a falling entity hits the ground.

orderChunks()  : void

Calculates which new chunks this player needs to use, and which currently-used chunks it needs to stop using.

processMostRecentMovements()  : void

Fires movement events and synchronizes player movement, every tick.

recalculateBoundingBox()  : void

removePermanentInventories()  : void

requestChunks()  : void

Requests chunks from the world to be sent, up to a set limit every tick. This operates on the results of the most recent chunk order.

resetLastMovements()  : void

revertMovement()  : void

sendPosition()  : void

TODO: remove this

sendSpawnPacket()  : void

Called by spawnTo() to send whatever packets needed to spawn the entity to the client.

setPosition()  : bool

setPositionAndRotation()  : bool

spawnEntitiesOnAllChunks()  : void

spawnEntitiesOnChunk()  : void

startDeathAnimation()  : void

syncNetworkData()  : void

tryChangeMovement()  : void

unloadChunk()  : void

updateFallState()  : float|null

updateMovement()  : void

damageItem()  : void

recheckBroadcastPermissions()  : void