PocketMine-MP 4.11.1 git-95263795a8174d443d6b42d9f338cb24df3686fb
pocketmine\player\Player Class Reference
+ Inheritance diagram for pocketmine\player\Player:
+ Collaboration diagram for pocketmine\player\Player:

Public Member Functions

 __construct (Server $server, NetworkSession $session, PlayerInfo $playerInfo, bool $authenticated, Location $spawnLocation, ?CompoundTag $namedtag)
 
 __debugInfo ()
 
 __toString ()
 
 addAttachment (Plugin $plugin, ?string $name=null, ?bool $value=null)
 
 addMotion (float $x, float $y, float $z)
 
 applyDamageModifiers (EntityDamageEvent $source)
 
 attack (EntityDamageEvent $source)
 
 attackBlock (Vector3 $pos, int $face)
 
 attackEntity (Entity $entity)
 
 breakBlock (Vector3 $pos)
 
 broadcastAnimation (Animation $animation, ?array $targets=null)
 
 broadcastSound (Sound $sound, ?array $targets=null)
 
 canBeCollidedWith ()
 
 canBeMovedByCurrents ()
 
 canBreathe ()
 
 canClimb ()
 
 canClimbWalls ()
 
 canCollideWith (Entity $entity)
 
 canInteract (Vector3 $pos, float $maxDistance, float $maxDiff=M_SQRT3/2)
 
 canSaveWithChunk ()
 
 canSee (Player $player)
 
 changeSkin (Skin $skin, string $newSkinName, string $oldSkinName)
 
 chat (string $message)
 
 close ()
 
 consumeHeldItem ()
 
 consumeObject (Consumable $consumable)
 
 continueBreakBlock (Vector3 $pos, int $face)
 
 damageArmor (float $damage)
 
 despawnFrom (Player $player, bool $send=true)
 
 despawnFromAll ()
 
 disconnect (string $reason, Translatable|string|null $quitMessage=null)
 
 doChunkRequests ()
 
 doFirstSpawn ()
 
 dropItem (Item $item)
 
 emote (string $emoteId)
 
 extinguish ()
 
 flagForDespawn ()
 
 getAbsorption ()
 
 getAirSupplyTicks ()
 
 getAllowFlight ()
 
 getArmorInventory ()
 
 getArmorPoints ()
 
 getAttributeMap ()
 
 getBoundingBox ()
 
 getCraftingGrid ()
 
 getCurrentWindow ()
 
 getCursorInventory ()
 
 getDirectionPlane ()
 
 getDirectionVector ()
 
 getDisplayName ()
 
 getDrops ()
 
 getEffectivePermissions ()
 
 getEffects ()
 
 getEnderInventory ()
 
 getEyeHeight ()
 
 getEyePos ()
 
 getFallDistance ()
 
 getFireTicks ()
 
 getFirstPlayed ()
 
 getGamemode ()
 
 getHealth ()
 
 getHighestArmorEnchantmentLevel (Enchantment $enchantment)
 
 getHorizontalFacing ()
 
 getHungerManager ()
 
 getId ()
 
 getInAirTicks ()
 
 getInventory ()
 
 getItemCooldownExpiry (Item $item)
 
 getItemUseDuration ()
 
 getJumpVelocity ()
 
 getLanguage ()
 
 getLastDamageCause ()
 
 getLastPlayed ()
 
 getLeaveMessage ()
 
 getLineOfSight (int $maxDistance, int $maxLength=0, array $transparent=[])
 
 getLocale ()
 
 getLocation ()
 
 getMaxAirSupplyTicks ()
 
 getMaxHealth ()
 
 getMotion ()
 
 getMovementSpeed ()
 
 getName ()
 
 getNameTag ()
 
 getNetworkProperties ()
 
 getNetworkSession ()
 
 getOffHandInventory ()
 
 getOffsetPosition (Vector3 $vector3)
 
 getOwningEntity ()
 
 getOwningEntityId ()
 
 getPermissionRecalculationCallbacks ()
 
 getPlayerInfo ()
 
 getPosition ()
 
 getSaveData ()
 
 getScale ()
 
 getScoreTag ()
 
 getScreenLineHeight ()
 
 getServer ()
 
 getSize ()
 
 getSkin ()
 
 getSpawn ()
 
 getTargetBlock (int $maxDistance, array $transparent=[])
 
 getTargetEntity ()
 
 getTargetEntityId ()
 
 getUniqueId ()
 
 getUsedChunks ()
 
 getUsedChunkStatus (int $chunkX, int $chunkZ)
 
 getViewDistance ()
 
 getViewers ()
 
 getWorld ()
 
 getXpDropAmount ()
 
 getXpManager ()
 
 getXuid ()
 
 handleMovement (Vector3 $newPos)
 
 hasAutoJump ()
 
 hasBlockCollision ()
 
 hasFiniteResources ()
 
 hasGravity ()
 
 hasItemCooldown (Item $item)
 
 hasLineOfSight (Entity $entity)
 
 hasMovementUpdate ()
 
 hasPermission ($name)
 
 hasPlayedBefore ()
 
 hasReceivedChunk (int $chunkX, int $chunkZ)
 
 hasValidCustomSpawn ()
 
 heal (EntityRegainHealthEvent $source)
 
 hidePlayer (Player $player)
 
 interactBlock (Vector3 $pos, int $face, Vector3 $clickOffset)
 
 interactEntity (Entity $entity, Vector3 $clickPos)
 
 isAdventure (bool $literal=false)
 
 isAlive ()
 
 isAuthenticated ()
 
 isBreathing ()
 
 isClosed ()
 
 isConnected ()
 
 isCreative (bool $literal=false)
 
 isFireProof ()
 
 isFlaggedForDespawn ()
 
 isFlying ()
 
 isGliding ()
 
 isImmobile ()
 
 isInsideOfSolid ()
 
 isInvisible ()
 
 isNameTagAlwaysVisible ()
 
 isNameTagVisible ()
 
 isOnFire ()
 
 isOnGround ()
 
 isOnline ()
 
 isPermissionSet ($name)
 
 isSilent ()
 
 isSleeping ()
 
 isSneaking ()
 
 isSpectator ()
 
 isSprinting ()
 
 isSurvival (bool $literal=false)
 
 isSwimming ()
 
 isUnderwater ()
 
 isUsingChunk (int $chunkX, int $chunkZ)
 
 isUsingItem ()
 
 jump ()
 
 kick (string $reason="", Translatable|string|null $quitMessage=null)
 
 kill ()
 
 knockBack (float $x, float $z, float $force=0.4, ?float $verticalLimit=0.4)
 
 lookAt (Vector3 $target)
 
 onAirExpired ()
 
 onBlockChanged (Vector3 $block)
 
onChunkUnloaded as onChunkChanged (int $chunkX, int $chunkZ, Chunk $chunk)
 
 onChunkLoaded (int $chunkX, int $chunkZ, Chunk $chunk)
 
 onChunkPopulated (int $chunkX, int $chunkZ, Chunk $chunk)
 
 onChunkUnloaded (int $chunkX, int $chunkZ, Chunk $chunk)
 
 onCollideWithPlayer (Player $player)
 
 onFormSubmit (int $formId, $responseData)
 
 onInteract (Player $player, Vector3 $clickPos)
 
 onNearbyBlockChange ()
 
 onPostDisconnect (string $reason, Translatable|string|null $quitMessage)
 
 onRandomUpdate ()
 
 onUpdate (int $currentTick)
 
 pickBlock (Vector3 $pos, bool $addTileNBT)
 
 recalculatePermissions ()
 
 releaseHeldItem ()
 
 removeAttachment (PermissionAttachment $attachment)
 
 removeCurrentWindow ()
 
 removeTitles ()
 
 resetFallDistance ()
 
 resetItemCooldown (Item $item, ?int $ticks=null)
 
 resetTitles ()
 
 respawn ()
 
 respawnToAll ()
 
 save ()
 
 saveNBT ()
 
 scheduleUpdate ()
 
 selectHotbarSlot (int $hotbarSlot)
 
 sendActionBarMessage (string $message)
 
 sendData (?array $targets, ?array $data=null)
 
 sendForm (Form $form)
 
 sendJukeboxPopup (string $key, array $args)
 
 sendMessage (Translatable|string $message)
 
 sendPopup (string $message)
 
 sendSkin (?array $targets=null)
 
 sendSubTitle (string $subtitle)
 
 sendTip (string $message)
 
 sendTitle (string $title, string $subtitle="", int $fadeIn=-1, int $stay=-1, int $fadeOut=-1)
 
 sendToastNotification (string $title, string $body)
 
 sendTranslation (string $message, array $parameters=[])
 
 setAbsorption (float $absorption)
 
 setAirSupplyTicks (int $ticks)
 
 setAllowFlight (bool $value)
 
 setAutoJump (bool $value)
 
 setBasePermission ($name, bool $grant)
 
 setBreathing (bool $value=true)
 
 setCanClimb (bool $value=true)
 
 setCanClimbWalls (bool $value=true)
 
 setCanSaveWithChunk (bool $value)
 
 setCurrentWindow (Inventory $inventory)
 
 setDisplayName (string $name)
 
 setFallDistance (float $fallDistance)
 
 setFireTicks (int $fireTicks)
 
 setFlying (bool $value)
 
 setForceMovementUpdate (bool $value=true)
 
 setGamemode (GameMode $gm)
 
 setGliding (bool $value=true)
 
 setHasBlockCollision (bool $value)
 
 setHasGravity (bool $v=true)
 
 setHealth (float $amount)
 
 setImmobile (bool $value=true)
 
 setInvisible (bool $value=true)
 
 setLastDamageCause (EntityDamageEvent $type)
 
 setMaxAirSupplyTicks (int $ticks)
 
 setMaxHealth (int $amount)
 
 setMotion (Vector3 $motion)
 
 setMovementSpeed (float $v, bool $fit=false)
 
 setNameTag (string $name)
 
 setNameTagAlwaysVisible (bool $value=true)
 
 setNameTagVisible (bool $value=true)
 
 setOnFire (int $seconds)
 
 setOwningEntity (?Entity $owner)
 
 setRotation (float $yaw, float $pitch)
 
 setScale (float $value)
 
 setScoreTag (string $score)
 
 setScreenLineHeight (?int $height)
 
 setSilent (bool $value=true)
 
 setSkin (Skin $skin)
 
 setSneaking (bool $value=true)
 
 setSpawn (?Vector3 $pos)
 
 setSprinting (bool $value=true)
 
 setSwimming (bool $value=true)
 
 setTargetEntity (?Entity $target)
 
 setTitleDuration (int $fadeIn, int $stay, int $fadeOut)
 
 setUsingItem (bool $value)
 
 setViewDistance (int $distance)
 
 showPlayer (Player $player)
 
 sleepOn (Vector3 $pos)
 
 spawnTo (Player $player)
 
 spawnToAll ()
 
 stopBreakBlock (Vector3 $pos)
 
 stopSleep ()
 
 teleport (Vector3 $pos, ?float $yaw=null, ?float $pitch=null)
 
 toggleFlight (bool $fly)
 
 toggleGlide (bool $glide)
 
 toggleSneak (bool $sneak)
 
 toggleSprint (bool $sprint)
 
 toggleSwim (bool $swim)
 
 transfer (string $address, int $port=19132, string $message="transfer")
 
 unsetBasePermission ($name)
 
 useHeldItem ()
 

Static Public Member Functions

static getNetworkTypeId ()
 
static isValidUserName (?string $name)
 
static nextRuntimeId ()
 
static parseSkinNBT (CompoundTag $nbt)
 

Public Attributes

 $boundingBox
 
 $canCollide = true
 
 $deadTicks = 0
 
 $fallDistance = 0.0
 
 $isCollided = false
 
 $isCollidedHorizontally = false
 
 $isCollidedVertically = false
 
 $keepMovement = false
 
 $lastUpdate
 
 $noDamageTicks = 0
 
 $onGround = false
 
 $size
 
bool $spawned = false
 
 $ticksLived = 0
 
const MOTION_THRESHOLD = 0.00001
 

Protected Member Functions

 actuallyRespawn ()
 
 addAttributes ()
 
 addDefaultWindows ()
 
 addPermanentInventories (Inventory ... $inventories)
 
 applyConsumptionResults (Consumable $consumable)
 
 applyDragBeforeGravity ()
 
 applyPostDamageEffects (EntityDamageEvent $source)
 
 broadcastMotion ()
 
 broadcastMovement (bool $teleport=false)
 
 calculateFallDamage (float $fallDistance)
 
 checkBlockIntersections ()
 
 checkGroundState (float $wantedX, float $wantedY, float $wantedZ, float $dx, float $dy, float $dz)
 
 checkItemCooldowns ()
 
 checkNearEntities ()
 
 checkObstruction (float $x, float $y, float $z)
 
 dealFireDamage ()
 
 destroyCycles ()
 
 doAirSupplyTick (int $tickDiff)
 
 doHitAnimation ()
 
 doOnFireTick (int $tickDiff=1)
 
 endDeathAnimation ()
 
 entityBaseTick (int $tickDiff=1)
 
 getAllNetworkData ()
 
 getBlocksAroundWithEntityInsideActions ()
 
 getBlocksIntersected (float $inset)
 
 getDirtyNetworkData ()
 
 getInitialSizeInfo ()
 
 initEntity (CompoundTag $nbt)
 
 initHumanData (CompoundTag $nbt)
 
 internalSetGameMode (GameMode $gameMode)
 
 move (float $dx, float $dy, float $dz)
 
 onDeath ()
 
 onDeathUpdate (int $tickDiff)
 
 onDispose ()
 
 onFirstUpdate (int $currentTick)
 
 onHitGround ()
 
 orderChunks ()
 
 processMostRecentMovements ()
 
 recalculateBoundingBox ()
 
 removePermanentInventories ()
 
 requestChunks ()
 
 resetLastMovements ()
 
 revertMovement (Location $from)
 
 sendPosition (Vector3 $pos, ?float $yaw=null, ?float $pitch=null, int $mode=MovePlayerPacket::MODE_NORMAL)
 
 sendSpawnPacket (Player $player)
 
 setPosition (Vector3 $pos)
 
 setPositionAndRotation (Vector3 $pos, float $yaw, float $pitch)
 
 setSize (EntitySizeInfo $size)
 
 spawnEntitiesOnAllChunks ()
 
 spawnEntitiesOnChunk (int $chunkX, int $chunkZ)
 
 startDeathAnimation ()
 
 syncNetworkData (EntityMetadataCollection $properties)
 
 tryChangeMovement ()
 
 unloadChunk (int $x, int $z, ?World $world=null)
 
 updateFallState (float $distanceThisTick, bool $onGround)
 
 updateMovement (bool $teleport=false)
 

Protected Attributes

 $absorptionAttr
 
bool $allowFlight = false
 
 $alwaysShowNameTag = false
 
 $armorInventory
 
 $attackTime = 0
 
 $attributeMap
 
bool $authenticated
 
bool $autoJump = true
 
SurvivalBlockBreakHandler $blockBreakHandler = null
 
bool $blockCollision = true
 
 $blocksAround
 
 $breathing = true
 
 $breathTicks = self::DEFAULT_BREATH_TICKS
 
 $canClimb = false
 
 $canClimbWalls = false
 
PlayerChunkLoader $chunkLoader
 
ChunkSelector $chunkSelector
 
int $chunksPerTick
 
 $closed = false
 
PlayerCraftingInventory $craftingGrid
 
Inventory $currentWindow = null
 
PlayerCursorInventory $cursorInventory
 
string $displayName
 
 $drag = 0.02
 
 $effectManager
 
 $enderInventory
 
 $fireTicks = 0
 
int $firstPlayed
 
bool $flying = false
 
 $forceMovementUpdate = false
 
int $formIdCounter = 0
 
array $forms = []
 
GameMode $gamemode
 
 $gliding = false
 
 $gravity = 0.08
 
 $gravityEnabled = true
 
 $hasSpawned = []
 
 $healthAttr
 
array $hiddenPlayers = []
 
 $hungerManager
 
 $id
 
 $immobile = false
 
int $inAirTicks = 0
 
 $inventory
 
 $invisible = false
 
 $isStatic = false
 
 $jumpVelocity = 0.42
 
 $justCreated = true
 
 $knockbackResistanceAttr
 
 $lastDamageCause = null
 
 $lastLocation
 
 $lastMotion
 
float $lastMovementProcess = null
 
int $lastPlayed
 
int $lineHeight = null
 
array $loadQueue = []
 
string $locale = "en_US"
 
 $location
 
Logger $logger
 
 $maxBreathTicks = self::DEFAULT_BREATH_TICKS
 
 $maxDeadTicks = 25
 
int $messageCounter = 2
 
 $motion
 
float $moveRateLimit = 10 * self::MOVES_PER_TICK
 
 $moveSpeedAttr
 
 $nameTag = ""
 
 $nameTagVisible = true
 
bool $networkPropertiesDirty = false
 
NetworkSession $networkSession
 
int $nextChunkOrderRun = 5
 
 $offHandInventory
 
 $ownerId = null
 
array $permanentWindows = []
 
PlayerInfo $playerInfo
 
 $scale = 1.0
 
 $scoreTag = ""
 
 $server
 
 $silent = false
 
 $skin
 
Vector3 $sleeping = null
 
 $sneaking = false
 
int $spawnChunkLoadCount = 0
 
int $spawnThreshold
 
 $sprinting = false
 
int $startAction = -1
 
 $stepHeight = 0.6
 
 $swimming = false
 
 $targetId = null
 
 $timings
 
array $usedChunks = []
 
array $usedItemsCooldown = []
 
string $username
 
 $uuid
 
int $viewDistance = -1
 
 $xpManager
 
 $xpSeed
 
string $xuid = ""
 
 $ySize = 0.0
 
const DEFAULT_BREATH_TICKS = 300
 
const STEP_CLIP_MULTIPLIER = 0.4
 

Detailed Description

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

Definition at line 160 of file Player.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\player\Player::__construct ( Server  $server,
NetworkSession  $session,
PlayerInfo  $playerInfo,
bool  $authenticated,
Location  $spawnLocation,
?CompoundTag  $namedtag 
)

Definition at line 276 of file Player.php.

◆ __destruct()

pocketmine\player\Player::__destruct ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 2201 of file Player.php.

Member Function Documentation

◆ __debugInfo()

pocketmine\player\Player::__debugInfo ( )
Returns
mixed[]

Definition at line 2197 of file Player.php.

◆ __toString()

pocketmine\entity\Entity::__toString ( )
inherited

Definition at line 1682 of file Entity.php.

◆ actuallyRespawn()

pocketmine\player\Player::actuallyRespawn ( )
protected

Definition at line 2300 of file Player.php.

◆ addAttachment()

pocketmine\permission\Permissible::addAttachment ( Plugin  $plugin,
?string  $name = null,
?bool  $value = null 
)
inherited

◆ addAttributes()

pocketmine\entity\Living::addAttributes ( )
protectedinherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 178 of file Living.php.

◆ addDefaultWindows()

pocketmine\player\Player::addDefaultWindows ( )
protected

Definition at line 2447 of file Player.php.

◆ addMotion()

pocketmine\entity\Entity::addMotion ( float  $x,
float  $y,
float  $z 
)
inherited

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

Definition at line 1400 of file Entity.php.

Referenced by pocketmine\entity\effect\LevitationEffect\applyEffect().

+ Here is the caller graph for this function:

◆ addPermanentInventories()

pocketmine\player\Player::addPermanentInventories ( Inventory ...  $inventories)
protected

Definition at line 2551 of file Player.php.

◆ applyConsumptionResults()

pocketmine\entity\Human::applyConsumptionResults ( Consumable  $consumable)
protectedinherited

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

Reimplemented from pocketmine\entity\Living.

Definition at line 188 of file Human.php.

◆ applyDamageModifiers()

pocketmine\entity\Human::applyDamageModifiers ( EntityDamageEvent  $source)
inherited

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

Reimplemented from pocketmine\entity\Living.

Definition at line 351 of file Human.php.

◆ applyDragBeforeGravity()

pocketmine\entity\Entity::applyDragBeforeGravity ( )
protectedinherited

Definition at line 805 of file Entity.php.

◆ applyPostDamageEffects()

pocketmine\player\Player::applyPostDamageEffects ( EntityDamageEvent  $source)
protected

Called after EntityDamageEvent execution to apply post-hurt effects, such as reducing absorption or modifying armour durability. This will not be called by damage sources causing death.

Reimplemented from pocketmine\entity\Human.

Definition at line 2354 of file Player.php.

◆ attack()

pocketmine\player\Player::attack ( EntityDamageEvent  $source)

Reimplemented from pocketmine\entity\Living.

Definition at line 2360 of file Player.php.

◆ attackBlock()

pocketmine\player\Player::attackBlock ( Vector3  $pos,
int  $face 
)

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

Returns
bool if an action took place successfully

Definition at line 1626 of file Player.php.

◆ attackEntity()

pocketmine\player\Player::attackEntity ( Entity  $entity)

Attacks the given entity with the currently-held item. TODO: move this up the class hierarchy

Returns
bool if the entity was dealt damage

Definition at line 1736 of file Player.php.

◆ breakBlock()

pocketmine\player\Player::breakBlock ( Vector3  $pos)

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

Returns
bool if the block was successfully broken, false if a rollback needs to take place.

Definition at line 1677 of file Player.php.

References pocketmine\item\Durable\isBroken().

+ Here is the call graph for this function:

◆ broadcastAnimation()

pocketmine\player\Player::broadcastAnimation ( Animation  $animation,
?array  $targets = null 
)
Parameters
Player[] | null$targets

Reimplemented from pocketmine\entity\Entity.

Definition at line 2394 of file Player.php.

◆ broadcastMotion()

pocketmine\entity\Entity::broadcastMotion ( )
protectedinherited

Definition at line 793 of file Entity.php.

◆ broadcastMovement()

pocketmine\entity\Entity::broadcastMovement ( bool  $teleport = false)
protectedinherited

Definition at line 767 of file Entity.php.

◆ broadcastSound()

pocketmine\player\Player::broadcastSound ( Sound  $sound,
?array  $targets = null 
)

Broadcasts a sound caused by the entity. If the entity is considered "silent", the sound will be dropped.

Parameters
Player[] | null$targets

Reimplemented from pocketmine\entity\Entity.

Definition at line 2402 of file Player.php.

◆ calculateFallDamage()

pocketmine\player\Player::calculateFallDamage ( float  $fallDistance)
protected

Reimplemented from pocketmine\entity\Living.

Definition at line 1308 of file Player.php.

◆ canBeCollidedWith()

pocketmine\player\Player::canBeCollidedWith ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 540 of file Player.php.

◆ canBeMovedByCurrents()

pocketmine\player\Player::canBeMovedByCurrents ( )

Returns whether this entity can be moved by currents in liquids.

Reimplemented from pocketmine\entity\Entity.

Definition at line 1176 of file Player.php.

◆ canBreathe()

pocketmine\player\Player::canBreathe ( )

Returns whether the entity can currently breathe.

Reimplemented from pocketmine\entity\Living.

Definition at line 1386 of file Player.php.

◆ canClimb()

pocketmine\entity\Entity::canClimb ( )
inherited

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

Definition at line 364 of file Entity.php.

◆ canClimbWalls()

pocketmine\entity\Entity::canClimbWalls ( )
inherited

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.

Definition at line 379 of file Entity.php.

◆ canCollideWith()

pocketmine\player\Player::canCollideWith ( Entity  $entity)

Reimplemented from pocketmine\entity\Entity.

Definition at line 536 of file Player.php.

◆ canInteract()

pocketmine\player\Player::canInteract ( Vector3  $pos,
float  $maxDistance,
float  $maxDiff = M_SQRT3 / 2 
)

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

Parameters
float$maxDiffdefaults to half of the 3D diagonal width of a block

Definition at line 1395 of file Player.php.

◆ canSaveWithChunk()

pocketmine\player\Player::canSaveWithChunk ( )

Returns whether this entity will be saved when its chunk is unloaded.

Reimplemented from pocketmine\entity\Entity.

Definition at line 2206 of file Player.php.

◆ canSee()

pocketmine\player\Player::canSee ( Player  $player)

Definition at line 514 of file Player.php.

◆ changeSkin()

pocketmine\player\Player::changeSkin ( Skin  $skin,
string  $newSkinName,
string  $oldSkinName 
)

Called when a player changes their skin. Plugin developers should not use this, use setSkin() and sendSkin() instead.

Definition at line 623 of file Player.php.

◆ chat()

pocketmine\player\Player::chat ( string  $message)

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

Definition at line 1411 of file Player.php.

◆ checkBlockIntersections()

pocketmine\entity\Entity::checkBlockIntersections ( )
protectedinherited

Definition at line 1288 of file Entity.php.

◆ checkGroundState()

pocketmine\player\Player::checkGroundState ( float  $wantedX,
float  $wantedY,
float  $wantedZ,
float  $dx,
float  $dy,
float  $dz 
)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 1160 of file Player.php.

◆ checkItemCooldowns()

pocketmine\player\Player::checkItemCooldowns ( )
protected

Definition at line 692 of file Player.php.

◆ checkNearEntities()

pocketmine\player\Player::checkNearEntities ( )
protected

Definition at line 1180 of file Player.php.

◆ checkObstruction()

pocketmine\entity\Entity::checkObstruction ( float  $x,
float  $y,
float  $z 
)
protectedinherited

Definition at line 833 of file Entity.php.

◆ close()

pocketmine\entity\Entity::close ( )
finalinherited

Closes the entity and frees attached references.

WARNING: Entities are unusable after this has been executed!

Definition at line 1562 of file Entity.php.

◆ consumeHeldItem()

pocketmine\player\Player::consumeHeldItem ( )

Consumes the currently-held item.

Returns
bool if the consumption succeeded.

Definition at line 1520 of file Player.php.

◆ consumeObject()

pocketmine\entity\Human::consumeObject ( Consumable  $consumable)
inherited

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

Reimplemented from pocketmine\entity\Living.

Definition at line 180 of file Human.php.

◆ continueBreakBlock()

pocketmine\player\Player::continueBreakBlock ( Vector3  $pos,
int  $face 
)

Definition at line 1660 of file Player.php.

◆ damageArmor()

pocketmine\entity\Living::damageArmor ( float  $damage)
inherited

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.

Definition at line 478 of file Living.php.

◆ dealFireDamage()

pocketmine\entity\Entity::dealFireDamage ( )
protectedinherited

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

Definition at line 724 of file Entity.php.

◆ despawnFrom()

pocketmine\entity\Entity::despawnFrom ( Player  $player,
bool  $send = true 
)
inherited
Deprecated:
WARNING: This function DOES NOT permanently hide the entity from the player. As soon as the entity or player moves, the player will once again be able to see the entity.

Definition at line 1518 of file Entity.php.

◆ despawnFromAll()

pocketmine\entity\Entity::despawnFromAll ( )
inherited
Deprecated:
WARNING: This function DOES NOT permanently hide the entity from viewers. As soon as the entity or player moves, viewers will once again be able to see the entity.

Definition at line 1532 of file Entity.php.

◆ destroyCycles()

pocketmine\player\Player::destroyCycles ( )
protected

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.

It is expected that the object is unusable after this is called.

Reimplemented from pocketmine\entity\Human.

Definition at line 2185 of file Player.php.

◆ disconnect()

pocketmine\player\Player::disconnect ( string  $reason,
Translatable|string|null  $quitMessage = null 
)

Removes the player from the server. This cannot be cancelled. This is used for remote disconnects and for uninterruptible disconnects (for example, when the server shuts down).

Note for plugin developers: Prefer kick() instead of this method. That way other plugins can have a say in whether the player is removed or not.

Note for internals developers: Do not call this from network sessions. It will cause a feedback loop.

Parameters
string$reasonShown to the player, usually this will appear on their disconnect screen.
Translatable | string | null$quitMessageMessage to broadcast to online players (null will use default)

Definition at line 2111 of file Player.php.

◆ doAirSupplyTick()

pocketmine\entity\Living::doAirSupplyTick ( int  $tickDiff)
protectedinherited

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

Definition at line 646 of file Living.php.

◆ doChunkRequests()

pocketmine\player\Player::doChunkRequests ( )

Ticks the chunk-requesting mechanism.

Definition at line 949 of file Player.php.

◆ doFirstSpawn()

pocketmine\player\Player::doFirstSpawn ( )

Called by the network system when the pre-spawn sequence is completed (e.g. after sending spawn chunks). This fires join events and broadcasts join messages to other online players.

Definition at line 846 of file Player.php.

◆ doHitAnimation()

pocketmine\entity\Living::doHitAnimation ( )
protectedinherited

Definition at line 553 of file Living.php.

◆ doOnFireTick()

pocketmine\entity\Entity::doOnFireTick ( int  $tickDiff = 1)
protectedinherited

Definition at line 701 of file Entity.php.

◆ dropItem()

pocketmine\player\Player::dropItem ( Item  $item)

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

Definition at line 1911 of file Player.php.

◆ emote()

pocketmine\player\Player::emote ( string  $emoteId)

Reimplemented from pocketmine\entity\Human.

Definition at line 1895 of file Player.php.

◆ endDeathAnimation()

pocketmine\entity\Living::endDeathAnimation ( )
protectedinherited

Definition at line 609 of file Living.php.

◆ entityBaseTick()

pocketmine\entity\Human::entityBaseTick ( int  $tickDiff = 1)
protectedinherited

Reimplemented from pocketmine\entity\Living.

Definition at line 338 of file Human.php.

◆ extinguish()

pocketmine\entity\Entity::extinguish ( )
inherited

Definition at line 692 of file Entity.php.

◆ flagForDespawn()

pocketmine\entity\Entity::flagForDespawn ( )
inherited

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

Definition at line 1541 of file Entity.php.

◆ getAbsorption()

pocketmine\entity\Living::getAbsorption ( )
inherited

Definition at line 204 of file Living.php.

◆ getAirSupplyTicks()

pocketmine\entity\Living::getAirSupplyTicks ( )
inherited

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.

Definition at line 705 of file Living.php.

◆ getAllNetworkData()

pocketmine\entity\Entity::getAllNetworkData ( )
finalprotectedinherited
Returns
MetadataProperty[] @phpstan-return array<int, MetadataProperty>

Definition at line 1630 of file Entity.php.

◆ getAllowFlight()

pocketmine\player\Player::getAllowFlight ( )

Returns whether the player is allowed to toggle its flight state.

If false, the player is locked in its current flight mode (flying/not flying), and attempts by the player to enter or exit flight mode will be prevented.

Definition at line 443 of file Player.php.

◆ getArmorInventory()

pocketmine\entity\Living::getArmorInventory ( )
inherited

Definition at line 404 of file Living.php.

◆ getArmorPoints()

pocketmine\entity\Living::getArmorPoints ( )
inherited

Returns how many armour points this mob has. Armour points provide a percentage reduction to damage. For mobs which can wear armour, this should return the sum total of the armour points provided by their equipment.

Definition at line 383 of file Living.php.

◆ getAttributeMap()

pocketmine\entity\Entity::getAttributeMap ( )
inherited

Definition at line 615 of file Entity.php.

◆ getBlocksAroundWithEntityInsideActions()

pocketmine\entity\Entity::getBlocksAroundWithEntityInsideActions ( )
protectedinherited
Returns
Block[]

Definition at line 1266 of file Entity.php.

◆ getBlocksIntersected()

pocketmine\entity\Entity::getBlocksIntersected ( float  $inset)
protectedinherited

Yields all the blocks whose full-cube areas are intersected by the entity's AABB.

@phpstan-return \Generator<int, Block, void, void>

Definition at line 1244 of file Entity.php.

◆ getBoundingBox()

pocketmine\entity\Entity::getBoundingBox ( )
inherited

Definition at line 307 of file Entity.php.

◆ getCraftingGrid()

pocketmine\player\Player::getCraftingGrid ( )

Definition at line 2460 of file Player.php.

◆ getCurrentWindow()

pocketmine\player\Player::getCurrentWindow ( )

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

Definition at line 2508 of file Player.php.

◆ getCursorInventory()

pocketmine\player\Player::getCursorInventory ( )

Definition at line 2456 of file Player.php.

◆ getDirectionPlane()

pocketmine\entity\Entity::getDirectionPlane ( )
inherited

Definition at line 935 of file Entity.php.

◆ getDirectionVector()

pocketmine\entity\Entity::getDirectionVector ( )
inherited

Definition at line 926 of file Entity.php.

◆ getDirtyNetworkData()

pocketmine\entity\Entity::getDirtyNetworkData ( )
finalprotectedinherited
Returns
MetadataProperty[] @phpstan-return array<int, MetadataProperty>

Definition at line 1618 of file Entity.php.

◆ getDisplayName()

pocketmine\player\Player::getDisplayName ( )

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

Definition at line 597 of file Player.php.

Referenced by pocketmine\event\player\PlayerDeathEvent\__construct().

+ Here is the caller graph for this function:

◆ getDrops()

pocketmine\player\Player::getDrops ( )
Returns
Item[]

Reimplemented from pocketmine\entity\Human.

Definition at line 1144 of file Player.php.

◆ getEffectivePermissions()

pocketmine\permission\Permissible::getEffectivePermissions ( )
inherited
Returns
PermissionAttachmentInfo[]

Implemented in pocketmine\permission\PermissibleInternal.

◆ getEffects()

pocketmine\entity\Living::getEffects ( )
inherited

Definition at line 306 of file Living.php.

◆ getEnderInventory()

pocketmine\entity\Human::getEnderInventory ( )
inherited

Definition at line 216 of file Human.php.

◆ getEyeHeight()

pocketmine\entity\Entity::getEyeHeight ( )
inherited

Definition at line 1082 of file Entity.php.

◆ getEyePos()

pocketmine\entity\Entity::getEyePos ( )
inherited

Definition at line 1086 of file Entity.php.

◆ getFallDistance()

pocketmine\entity\Entity::getFallDistance ( )
inherited

Definition at line 1047 of file Entity.php.

◆ getFireTicks()

pocketmine\entity\Entity::getFireTicks ( )
inherited

Definition at line 677 of file Entity.php.

◆ getFirstPlayed()

pocketmine\player\Player::getFirstPlayed ( )

TODO: not sure this should be nullable

Implements pocketmine\player\IPlayer.

Definition at line 406 of file Player.php.

◆ getGamemode()

pocketmine\player\Player::getGamemode ( )

Definition at line 1044 of file Player.php.

◆ getHealth()

pocketmine\entity\Entity::getHealth ( )
inherited

Definition at line 572 of file Entity.php.

◆ getHighestArmorEnchantmentLevel()

pocketmine\entity\Living::getHighestArmorEnchantmentLevel ( Enchantment  $enchantment)
inherited

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

Definition at line 395 of file Living.php.

◆ getHorizontalFacing()

pocketmine\entity\Entity::getHorizontalFacing ( )
inherited

Definition at line 907 of file Entity.php.

◆ getHungerManager()

pocketmine\entity\Human::getHungerManager ( )
inherited

Definition at line 176 of file Human.php.

◆ getId()

pocketmine\entity\Entity::getId ( )
inherited

Definition at line 1450 of file Entity.php.

◆ getInAirTicks()

pocketmine\player\Player::getInAirTicks ( )

Definition at line 1192 of file Player.php.

◆ getInitialSizeInfo()

pocketmine\entity\Human::getInitialSizeInfo ( )
protectedinherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 110 of file Human.php.

◆ getInventory()

pocketmine\entity\Human::getInventory ( )
inherited
Returns
PlayerInventory

Implements pocketmine\inventory\InventoryHolder.

Definition at line 210 of file Human.php.

Referenced by pocketmine\item\Armor\onClickAir(), pocketmine\item\Bucket\onInteractBlock(), and pocketmine\item\Bow\onReleaseUsing().

+ Here is the caller graph for this function:

◆ getItemCooldownExpiry()

pocketmine\player\Player::getItemCooldownExpiry ( Item  $item)

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

Definition at line 669 of file Player.php.

◆ getItemUseDuration()

pocketmine\player\Player::getItemUseDuration ( )

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

Definition at line 662 of file Player.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ getJumpVelocity()

pocketmine\entity\Living::getJumpVelocity ( )
inherited

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

Definition at line 337 of file Living.php.

◆ getLanguage()

pocketmine\player\Player::getLanguage ( )

Implements pocketmine\command\CommandSender.

Definition at line 615 of file Player.php.

◆ getLastDamageCause()

pocketmine\entity\Entity::getLastDamageCause ( )
inherited

Definition at line 611 of file Entity.php.

◆ getLastPlayed()

pocketmine\player\Player::getLastPlayed ( )

TODO: not sure this should be nullable

Implements pocketmine\player\IPlayer.

Definition at line 413 of file Player.php.

◆ getLeaveMessage()

pocketmine\player\Player::getLeaveMessage ( )

Definition at line 366 of file Player.php.

◆ getLineOfSight()

pocketmine\entity\Living::getLineOfSight ( int  $maxDistance,
int  $maxLength = 0,
array  $transparent = [] 
)
inherited
Parameters
true[]$transparent@phpstan-param array<int, true> $transparent
Returns
Block[]

Definition at line 761 of file Living.php.

◆ getLocale()

pocketmine\player\Player::getLocale ( )

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

Definition at line 611 of file Player.php.

◆ getLocation()

pocketmine\entity\Entity::getLocation ( )
inherited

Definition at line 1311 of file Entity.php.

◆ getMaxAirSupplyTicks()

pocketmine\entity\Living::getMaxAirSupplyTicks ( )
inherited

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

Definition at line 720 of file Living.php.

◆ getMaxHealth()

pocketmine\entity\Living::getMaxHealth ( )
inherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 196 of file Living.php.

◆ getMotion()

pocketmine\entity\Entity::getMotion ( )
inherited

Definition at line 1374 of file Entity.php.

◆ getMovementSpeed()

pocketmine\entity\Living::getMovementSpeed ( )
inherited

Definition at line 265 of file Living.php.

◆ getName()

pocketmine\player\Player::getName ( )

Gets the username

Implements pocketmine\command\CommandSender.

Definition at line 590 of file Player.php.

Referenced by pocketmine\command\defaults\ListCommand\execute().

+ Here is the caller graph for this function:

◆ getNameTag()

pocketmine\entity\Entity::getNameTag ( )
inherited

Definition at line 259 of file Entity.php.

◆ getNetworkProperties()

pocketmine\entity\Entity::getNetworkProperties ( )
inherited

Definition at line 619 of file Entity.php.

◆ getNetworkSession()

pocketmine\player\Player::getNetworkSession ( )

Definition at line 580 of file Player.php.

◆ getNetworkTypeId()

static pocketmine\entity\Human::getNetworkTypeId ( )
staticinherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 80 of file Human.php.

◆ getOffHandInventory()

pocketmine\entity\Human::getOffHandInventory ( )
inherited

Definition at line 214 of file Human.php.

◆ getOffsetPosition()

pocketmine\entity\Human::getOffsetPosition ( Vector3  $vector3)
inherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 514 of file Human.php.

◆ getOwningEntity()

pocketmine\entity\Entity::getOwningEntity ( )
inherited

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

Definition at line 401 of file Entity.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ getOwningEntityId()

pocketmine\entity\Entity::getOwningEntityId ( )
inherited

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

Definition at line 394 of file Entity.php.

◆ getPermissionRecalculationCallbacks()

pocketmine\permission\Permissible::getPermissionRecalculationCallbacks ( )
inherited
Returns
ObjectSet|\Closure[] @phpstan-return ObjectSet<\Closure(array<string, bool> $changedPermissionsOldValues) : void>

Implemented in pocketmine\permission\PermissibleInternal.

◆ getPlayerInfo()

pocketmine\player\Player::getPlayerInfo ( )

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

Definition at line 382 of file Player.php.

◆ getPosition()

pocketmine\entity\Entity::getPosition ( )
inherited

Definition at line 1307 of file Entity.php.

◆ getSaveData()

pocketmine\player\Player::getSaveData ( )

Definition at line 2214 of file Player.php.

◆ getScale()

pocketmine\entity\Entity::getScale ( )
inherited

Definition at line 295 of file Entity.php.

◆ getScoreTag()

pocketmine\entity\Entity::getScoreTag ( )
inherited

Definition at line 286 of file Entity.php.

◆ getScreenLineHeight()

pocketmine\player\Player::getScreenLineHeight ( )

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

Implements pocketmine\command\CommandSender.

Definition at line 503 of file Player.php.

◆ getServer()

pocketmine\player\Player::getServer ( )

Implements pocketmine\command\CommandSender.

Definition at line 499 of file Player.php.

◆ getSize()

pocketmine\entity\Entity::getSize ( )
inherited

Definition at line 324 of file Entity.php.

◆ getSkin()

pocketmine\entity\Human::getSkin ( )
inherited

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

Definition at line 137 of file Human.php.

◆ getSpawn()

pocketmine\player\Player::getSpawn ( )
Returns
Position

Definition at line 963 of file Player.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ getTargetBlock()

pocketmine\entity\Living::getTargetBlock ( int  $maxDistance,
array  $transparent = [] 
)
inherited
Parameters
true[]$transparent@phpstan-param array<int, true> $transparent

Definition at line 802 of file Living.php.

◆ getTargetEntity()

pocketmine\entity\Entity::getTargetEntity ( )
inherited

Returns the entity's target entity, or null if not found. This is used for things like hostile mobs attacking entities, and for fishing rods reeling hit entities in.

Definition at line 432 of file Entity.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ getTargetEntityId()

pocketmine\entity\Entity::getTargetEntityId ( )
inherited

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

Definition at line 424 of file Entity.php.

◆ getUniqueId()

pocketmine\player\Player::getUniqueId ( )

Returns the player's UUID. This should be the preferred method to identify a player. It does not change if the player changes their username.

All players will have a UUID, regardless of whether they are logged into Xbox Live or not. However, note that non-XBL players can fake their UUIDs.

Reimplemented from pocketmine\entity\Human.

Definition at line 399 of file Player.php.

◆ getUsedChunks()

pocketmine\player\Player::getUsedChunks ( )
Returns
UsedChunkStatus[] chunkHash => status @phpstan-return array<int, UsedChunkStatus>

Definition at line 927 of file Player.php.

◆ getUsedChunkStatus()

pocketmine\player\Player::getUsedChunkStatus ( int  $chunkX,
int  $chunkZ 
)

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

Definition at line 934 of file Player.php.

◆ getViewDistance()

pocketmine\player\Player::getViewDistance ( )

Definition at line 549 of file Player.php.

◆ getViewers()

pocketmine\entity\Entity::getViewers ( )
inherited
Returns
Player[]

Definition at line 1457 of file Entity.php.

◆ getWorld()

pocketmine\entity\Entity::getWorld ( )
inherited

Definition at line 1315 of file Entity.php.

◆ getXpDropAmount()

pocketmine\player\Player::getXpDropAmount ( )

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

Reimplemented from pocketmine\entity\Human.

Definition at line 1152 of file Player.php.

◆ getXpManager()

pocketmine\entity\Human::getXpManager ( )
inherited

Definition at line 197 of file Human.php.

◆ getXuid()

pocketmine\player\Player::getXuid ( )

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.

Definition at line 388 of file Player.php.

◆ handleMovement()

pocketmine\player\Player::handleMovement ( Vector3  $newPos)

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.

This is used for processing movements sent by the player over network.

Parameters
Vector3$newPosCoordinates of the player's feet, centered horizontally at the base of their bounding box.

Definition at line 1204 of file Player.php.

◆ hasAutoJump()

pocketmine\player\Player::hasAutoJump ( )

Definition at line 489 of file Player.php.

◆ hasBlockCollision()

pocketmine\player\Player::hasBlockCollision ( )

Returns whether blocks may obstruct the player's movement. If false, the player can move through any block unobstructed.

Definition at line 466 of file Player.php.

◆ hasFiniteResources()

pocketmine\player\Player::hasFiniteResources ( )

TODO: make this a dynamic ability instead of being hardcoded

Definition at line 1136 of file Player.php.

Referenced by pocketmine\entity\object\Painting\onDeath(), and pocketmine\item\Bucket\onInteractBlock().

+ Here is the caller graph for this function:

◆ hasGravity()

pocketmine\entity\Entity::hasGravity ( )
inherited

Definition at line 797 of file Entity.php.

◆ hasItemCooldown()

pocketmine\player\Player::hasItemCooldown ( Item  $item)

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

Definition at line 677 of file Player.php.

◆ hasLineOfSight()

pocketmine\entity\Living::hasLineOfSight ( Entity  $entity)
inherited
Deprecated:
This function always returns true, no matter whether the target is in the line of sight or not.
See also
VoxelRayTrace::inDirection() for a more generalized method of ray-tracing to a target.

Definition at line 300 of file Living.php.

◆ hasMovementUpdate()

pocketmine\entity\Entity::hasMovementUpdate ( )
inherited

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

Reimplemented in pocketmine\entity\object\Painting, and pocketmine\entity\projectile\Projectile.

Definition at line 1037 of file Entity.php.

◆ hasPermission()

pocketmine\permission\Permissible::hasPermission (   $name)
inherited

Returns the permission value if overridden, or the default value if not

Parameters
string | Permission$name

Implemented in pocketmine\permission\PermissibleInternal.

◆ hasPlayedBefore()

pocketmine\player\Player::hasPlayedBefore ( )

Implements pocketmine\player\IPlayer.

Definition at line 417 of file Player.php.

◆ hasReceivedChunk()

pocketmine\player\Player::hasReceivedChunk ( int  $chunkX,
int  $chunkZ 
)

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

Definition at line 941 of file Player.php.

◆ hasValidCustomSpawn()

pocketmine\player\Player::hasValidCustomSpawn ( )

Definition at line 973 of file Player.php.

◆ heal()

pocketmine\entity\Entity::heal ( EntityRegainHealthEvent  $source)
inherited

Definition at line 537 of file Entity.php.

◆ hidePlayer()

pocketmine\player\Player::hidePlayer ( Player  $player)

Definition at line 518 of file Player.php.

◆ initEntity()

pocketmine\player\Player::initEntity ( CompoundTag  $nbt)
protected

Reimplemented from pocketmine\entity\Human.

Definition at line 328 of file Player.php.

◆ initHumanData()

pocketmine\player\Player::initHumanData ( CompoundTag  $nbt)
protected

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

Reimplemented from pocketmine\entity\Human.

Definition at line 314 of file Player.php.

◆ interactBlock()

pocketmine\player\Player::interactBlock ( Vector3  $pos,
int  $face,
Vector3  $clickOffset 
)

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

Returns
bool if it did something

Definition at line 1707 of file Player.php.

References pocketmine\item\Durable\isBroken().

+ Here is the call graph for this function:

◆ interactEntity()

pocketmine\player\Player::interactEntity ( Entity  $entity,
Vector3  $clickPos 
)

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

Definition at line 1811 of file Player.php.

◆ internalSetGameMode()

pocketmine\player\Player::internalSetGameMode ( GameMode  $gameMode)
protected

Definition at line 1048 of file Player.php.

◆ isAdventure()

pocketmine\player\Player::isAdventure ( bool  $literal = false)

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.

Parameters
bool$literalwhether a literal check should be performed

Definition at line 1125 of file Player.php.

◆ isAlive()

pocketmine\entity\Entity::isAlive ( )
inherited

Definition at line 568 of file Entity.php.

◆ isAuthenticated()

pocketmine\player\Player::isAuthenticated ( )

Definition at line 374 of file Player.php.

◆ isBreathing()

pocketmine\entity\Living::isBreathing ( )
inherited

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

Definition at line 688 of file Living.php.

◆ isClosed()

pocketmine\entity\Entity::isClosed ( )
inherited

Returns whether the entity has been "closed".

Definition at line 1553 of file Entity.php.

◆ isConnected()

pocketmine\player\Player::isConnected ( )

Definition at line 576 of file Player.php.

◆ isCreative()

pocketmine\player\Player::isCreative ( bool  $literal = false)

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.

Parameters
bool$literalwhether a literal check should be performed

Definition at line 1115 of file Player.php.

◆ isFireProof()

pocketmine\player\Player::isFireProof ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 1140 of file Player.php.

◆ isFlaggedForDespawn()

pocketmine\entity\Entity::isFlaggedForDespawn ( )
inherited

Definition at line 1546 of file Entity.php.

◆ isFlying()

pocketmine\player\Player::isFlying ( )

Definition at line 478 of file Player.php.

◆ isGliding()

pocketmine\entity\Living::isGliding ( )
inherited

Definition at line 235 of file Living.php.

◆ isImmobile()

pocketmine\entity\Entity::isImmobile ( )
inherited

Definition at line 334 of file Entity.php.

◆ isInsideOfSolid()

pocketmine\entity\Entity::isInsideOfSolid ( )
inherited

Definition at line 1112 of file Entity.php.

◆ isInvisible()

pocketmine\entity\Entity::isInvisible ( )
inherited

Definition at line 343 of file Entity.php.

◆ isNameTagAlwaysVisible()

pocketmine\entity\Entity::isNameTagAlwaysVisible ( )
inherited

Definition at line 267 of file Entity.php.

◆ isNameTagVisible()

pocketmine\entity\Entity::isNameTagVisible ( )
inherited

Definition at line 263 of file Entity.php.

◆ isOnFire()

pocketmine\entity\Entity::isOnFire ( )
inherited

Definition at line 665 of file Entity.php.

◆ isOnGround()

pocketmine\entity\Entity::isOnGround ( )
inherited

Definition at line 1407 of file Entity.php.

◆ isOnline()

pocketmine\player\Player::isOnline ( )

Definition at line 572 of file Player.php.

◆ isPermissionSet()

pocketmine\permission\Permissible::isPermissionSet (   $name)
inherited

Checks if this instance has a permission overridden

Parameters
string | Permission$name

Implemented in pocketmine\permission\PermissibleInternal.

◆ isSilent()

pocketmine\entity\Entity::isSilent ( )
inherited

Definition at line 352 of file Entity.php.

◆ isSleeping()

pocketmine\player\Player::isSleeping ( )

Definition at line 997 of file Player.php.

◆ isSneaking()

pocketmine\entity\Living::isSneaking ( )
inherited

Definition at line 212 of file Living.php.

◆ isSpectator()

pocketmine\player\Player::isSpectator ( )

Definition at line 1129 of file Player.php.

◆ isSprinting()

pocketmine\entity\Living::isSprinting ( )
inherited

Definition at line 221 of file Living.php.

◆ isSurvival()

pocketmine\player\Player::isSurvival ( bool  $literal = false)

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.

Parameters
bool$literalwhether a literal check should be performed

Definition at line 1105 of file Player.php.

◆ isSwimming()

pocketmine\entity\Living::isSwimming ( )
inherited

Definition at line 245 of file Living.php.

◆ isUnderwater()

pocketmine\entity\Entity::isUnderwater ( )
inherited

Definition at line 1101 of file Entity.php.

◆ isUsingChunk()

pocketmine\player\Player::isUsingChunk ( int  $chunkX,
int  $chunkZ 
)

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

Definition at line 919 of file Player.php.

◆ isUsingItem()

pocketmine\player\Player::isUsingItem ( )

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

Definition at line 649 of file Player.php.

◆ isValidUserName()

static pocketmine\player\Player::isValidUserName ( ?string  $name)
static

Validates the given username.

Definition at line 181 of file Player.php.

Referenced by pocketmine\command\defaults\DeopCommand\execute(), pocketmine\command\defaults\OpCommand\execute(), and pocketmine\command\defaults\WhitelistCommand\execute().

+ Here is the caller graph for this function:

◆ jump()

pocketmine\player\Player::jump ( )

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

Reimplemented from pocketmine\entity\Human.

Definition at line 1312 of file Player.php.

◆ kick()

pocketmine\player\Player::kick ( string  $reason = "",
Translatable|string|null  $quitMessage = null 
)

Kicks a player from the server

Definition at line 2083 of file Player.php.

◆ kill()

pocketmine\entity\Entity::kill ( )
inherited

Definition at line 546 of file Entity.php.

◆ knockBack()

pocketmine\entity\Living::knockBack ( float  $x,
float  $z,
float  $force = 0.4,
?float  $verticalLimit = 0.4 
)
inherited

Definition at line 557 of file Living.php.

◆ lookAt()

pocketmine\entity\Living::lookAt ( Vector3  $target)
inherited

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.

Definition at line 815 of file Living.php.

◆ move()

pocketmine\entity\Entity::move ( float  $dx,
float  $dy,
float  $dz 
)
protectedinherited

Definition at line 1118 of file Entity.php.

◆ nextRuntimeId()

static pocketmine\entity\Entity::nextRuntimeId ( )
staticinherited

Returns a new runtime entity ID for a new entity.

Definition at line 89 of file Entity.php.

Referenced by pocketmine\world\particle\FloatingTextParticle\encode().

+ Here is the caller graph for this function:

◆ onAirExpired()

pocketmine\entity\Living::onAirExpired ( )
inherited

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.

Reimplemented in pocketmine\entity\WaterAnimal.

Definition at line 736 of file Living.php.

◆ onBlockChanged()

pocketmine\world\ChunkListener::onBlockChanged ( Vector3  $block)
inherited

This method will be called when a block changes in a registered chunk

Implemented in pocketmine\network\mcpe\cache\ChunkCache.

◆ onChunkChanged()

onChunkUnloaded as pocketmine\player\Player::onChunkChanged ( int  $chunkX,
int  $chunkZ,
Chunk  $chunk 
)

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

Implements pocketmine\world\ChunkListener.

Definition at line 2570 of file Player.php.

◆ onChunkLoaded()

pocketmine\world\ChunkListener::onChunkLoaded ( int  $chunkX,
int  $chunkZ,
Chunk  $chunk 
)
inherited

This method will be called when a registered chunk is loaded

◆ onChunkPopulated()

pocketmine\world\ChunkListener::onChunkPopulated ( int  $chunkX,
int  $chunkZ,
Chunk  $chunk 
)
inherited

This method will be called when a registered chunk is populated Usually it'll be sent with another call to onChunkChanged()

◆ onChunkUnloaded()

pocketmine\player\Player::onChunkUnloaded ( int  $chunkX,
int  $chunkZ,
Chunk  $chunk 
)

This method will be called when a registered chunk is unloaded

Implements pocketmine\world\ChunkListener.

Definition at line 2578 of file Player.php.

◆ onCollideWithPlayer()

pocketmine\entity\Entity::onCollideWithPlayer ( Player  $player)
inherited

Definition at line 1090 of file Entity.php.

◆ onDeath()

pocketmine\player\Player::onDeath ( )
protected

Override this to do actions on death.

Reimplemented from pocketmine\entity\Living.

Definition at line 2245 of file Player.php.

◆ onDeathUpdate()

pocketmine\player\Player::onDeathUpdate ( int  $tickDiff)
protected

Called to tick entities while dead. Returns whether the entity should be flagged for despawn yet.

Reimplemented from pocketmine\entity\Living.

Definition at line 2284 of file Player.php.

◆ onDispose()

pocketmine\player\Player::onDispose ( )
protected

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.

Reimplemented from pocketmine\entity\Human.

Definition at line 2178 of file Player.php.

◆ onFirstUpdate()

pocketmine\entity\Entity::onFirstUpdate ( int  $currentTick)
protectedinherited

Called from onUpdate() on the first tick of a new entity. This is called before any movement processing or main ticking logic. Use this to fire any events related to spawning the entity.

Reimplemented in pocketmine\entity\object\ItemEntity.

Definition at line 943 of file Entity.php.

◆ onFormSubmit()

pocketmine\player\Player::onFormSubmit ( int  $formId,
  $responseData 
)
Parameters
mixed$responseData

Definition at line 2042 of file Player.php.

◆ onHitGround()

pocketmine\entity\Living::onHitGround ( )
protectedinherited

Called when a falling entity hits the ground.

Reimplemented from pocketmine\entity\Entity.

Definition at line 354 of file Living.php.

◆ onInteract()

pocketmine\entity\Entity::onInteract ( Player  $player,
Vector3  $clickPos 
)
inherited

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

Definition at line 1097 of file Entity.php.

◆ onNearbyBlockChange()

pocketmine\entity\Entity::onNearbyBlockChange ( )
inherited

Definition at line 1011 of file Entity.php.

◆ onPostDisconnect()

pocketmine\player\Player::onPostDisconnect ( string  $reason,
Translatable|string|null  $quitMessage 
)

Definition at line 2127 of file Player.php.

◆ onRandomUpdate()

pocketmine\entity\Entity::onRandomUpdate ( )
inherited

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).

Reimplemented in pocketmine\entity\object\Painting.

Definition at line 1020 of file Entity.php.

◆ onUpdate()

pocketmine\player\Player::onUpdate ( int  $currentTick)

Reimplemented from pocketmine\entity\Entity.

Definition at line 1335 of file Player.php.

◆ orderChunks()

pocketmine\player\Player::orderChunks ( )
protected

Calculates which new chunks this player needs to use, and which currently-used chunks it needs to stop using. This is based on factors including the player's current render radius and current position.

Definition at line 880 of file Player.php.

◆ parseSkinNBT()

static pocketmine\entity\Human::parseSkinNBT ( CompoundTag  $nbt)
staticinherited
Exceptions
InvalidSkinException
SavedDataLoadingException

Definition at line 116 of file Human.php.

◆ pickBlock()

pocketmine\player\Player::pickBlock ( Vector3  $pos,
bool  $addTileNBT 
)

Definition at line 1582 of file Player.php.

◆ processMostRecentMovements()

pocketmine\player\Player::processMostRecentMovements ( )
protected

Fires movement events and synchronizes player movement, every tick.

Definition at line 1251 of file Player.php.

◆ recalculateBoundingBox()

pocketmine\entity\Entity::recalculateBoundingBox ( )
protectedinherited

Definition at line 311 of file Entity.php.

◆ recalculatePermissions()

pocketmine\permission\Permissible::recalculatePermissions ( )
inherited
Returns
bool[] changed permission name => old value @phpstan-return array<string, bool>

Implemented in pocketmine\permission\PermissibleInternal.

◆ releaseHeldItem()

pocketmine\player\Player::releaseHeldItem ( )

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

Returns
bool if it did something.

Definition at line 1555 of file Player.php.

◆ removeCurrentWindow()

pocketmine\player\Player::removeCurrentWindow ( )

Definition at line 2537 of file Player.php.

◆ removePermanentInventories()

pocketmine\player\Player::removePermanentInventories ( )
protected

Definition at line 2558 of file Player.php.

◆ removeTitles()

pocketmine\player\Player::removeTitles ( )

Removes the title from the client's screen.

Definition at line 1948 of file Player.php.

◆ requestChunks()

pocketmine\player\Player::requestChunks ( )
protected

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.

Definition at line 763 of file Player.php.

◆ resetFallDistance()

pocketmine\player\Player::resetFallDistance ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 544 of file Player.php.

◆ resetItemCooldown()

pocketmine\player\Player::resetItemCooldown ( Item  $item,
?int  $ticks = null 
)

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

Definition at line 685 of file Player.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ resetLastMovements()

pocketmine\entity\Entity::resetLastMovements ( )
protectedinherited

Definition at line 1369 of file Entity.php.

◆ resetTitles()

pocketmine\player\Player::resetTitles ( )

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

Definition at line 1955 of file Player.php.

◆ respawn()

pocketmine\player\Player::respawn ( )

Definition at line 2289 of file Player.php.

◆ respawnToAll()

pocketmine\entity\Entity::respawnToAll ( )
inherited

Definition at line 1507 of file Entity.php.

◆ revertMovement()

pocketmine\player\Player::revertMovement ( Location  $from)
protected

Definition at line 1303 of file Player.php.

◆ save()

pocketmine\player\Player::save ( )

Handles player data saving

Definition at line 2241 of file Player.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ saveNBT()

pocketmine\entity\Human::saveNBT ( )
inherited

Reimplemented from pocketmine\entity\Living.

Definition at line 397 of file Human.php.

◆ scheduleUpdate()

pocketmine\entity\Entity::scheduleUpdate ( )
finalinherited

Definition at line 1004 of file Entity.php.

◆ selectHotbarSlot()

pocketmine\player\Player::selectHotbarSlot ( int  $hotbarSlot)

Definition at line 1456 of file Player.php.

◆ sendActionBarMessage()

pocketmine\player\Player::sendActionBarMessage ( string  $message)

Adds small text to the user's screen.

Definition at line 1941 of file Player.php.

◆ sendData()

pocketmine\player\Player::sendData ( ?array  $targets,
?array  $data = null 
)
Parameters
Player[] | null$targets
MetadataProperty[]$dataProperly formatted entity data, defaults to everything

@phpstan-param array<int, MetadataProperty> $data

Reimplemented from pocketmine\entity\Entity.

Definition at line 2386 of file Player.php.

◆ sendForm()

pocketmine\player\Player::sendForm ( Form  $form)

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

Exceptions

InvalidArgumentException

Definition at line 2032 of file Player.php.

◆ sendJukeboxPopup()

pocketmine\player\Player::sendJukeboxPopup ( string  $key,
array  $args 
)
Parameters
string[]$args

Definition at line 2003 of file Player.php.

◆ sendMessage()

pocketmine\player\Player::sendMessage ( Translatable|string  $message)

Sends a direct chat message to a player

Implements pocketmine\command\CommandSender.

Definition at line 1975 of file Player.php.

◆ sendPopup()

pocketmine\player\Player::sendPopup ( string  $message)

Sends a popup message to the player

TODO: add translation type popups

Definition at line 2012 of file Player.php.

◆ sendPosition()

pocketmine\player\Player::sendPosition ( Vector3  $pos,
?float  $yaw = null,
?float  $pitch = null,
int  $mode = MovePlayerPacket::MODE_NORMAL 
)
protected

TODO: remove this

Definition at line 2413 of file Player.php.

◆ sendSkin()

pocketmine\player\Player::sendSkin ( ?array  $targets = null)

{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.

Parameters
Player[] | null$targets
}

If null is given, will additionally send the skin to the player itself as well as its viewers.

Reimplemented from pocketmine\entity\Human.

Definition at line 642 of file Player.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ sendSpawnPacket()

pocketmine\entity\Human::sendSpawnPacket ( Player  $player)
protectedinherited

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

Reimplemented from pocketmine\entity\Living.

Definition at line 471 of file Human.php.

◆ sendSubTitle()

pocketmine\player\Player::sendSubTitle ( string  $subtitle)

Sets the subtitle message, without sending a title.

Definition at line 1934 of file Player.php.

◆ sendTip()

pocketmine\player\Player::sendTip ( string  $message)

Definition at line 2016 of file Player.php.

◆ sendTitle()

pocketmine\player\Player::sendTitle ( string  $title,
string  $subtitle = "",
int  $fadeIn = -1,
int  $stay = -1,
int  $fadeOut = -1 
)

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

Parameters
int$fadeInDuration in ticks for fade-in. If -1 is given, client-sided defaults will be used.
int$stayDuration in ticks to stay on screen for
int$fadeOutDuration in ticks for fade-out.

Definition at line 1923 of file Player.php.

◆ sendToastNotification()

pocketmine\player\Player::sendToastNotification ( string  $title,
string  $body 
)

Sends a toast message to the player, or queue to send it if a toast message is already shown.

Definition at line 2023 of file Player.php.

◆ sendTranslation()

pocketmine\player\Player::sendTranslation ( string  $message,
array  $parameters = [] 
)
Parameters
string[] | Translatable[]$parameters

Definition at line 1987 of file Player.php.

References pocketmine\server().

+ Here is the call graph for this function:

◆ setAbsorption()

pocketmine\entity\Living::setAbsorption ( float  $absorption)
inherited

Definition at line 208 of file Living.php.

◆ setAirSupplyTicks()

pocketmine\entity\Living::setAirSupplyTicks ( int  $ticks)
inherited

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

Definition at line 712 of file Living.php.

◆ setAllowFlight()

pocketmine\player\Player::setAllowFlight ( bool  $value)

Sets whether the player is allowed to toggle flight mode.

If set to false, the player will be locked in its current flight mode (flying/not flying), and attempts by the player to enter or exit flight mode will be prevented.

Note: Setting this to false DOES NOT change whether the player is currently flying. Use Player::setFlying() for that purpose.

Definition at line 430 of file Player.php.

◆ setAutoJump()

pocketmine\player\Player::setAutoJump ( bool  $value)

Definition at line 482 of file Player.php.

◆ setBasePermission()

pocketmine\permission\Permissible::setBasePermission (   $name,
bool  $grant 
)
inherited

Assigns a baseline permission to the permissible. This is always calculated before anything else, which means that permissions set using addAttachment() will always override base permissions. You probably don't want to use this if you're not assigning (denying) operator permissions.

Implemented in pocketmine\permission\PermissibleInternal.

◆ setBreathing()

pocketmine\entity\Living::setBreathing ( bool  $value = true)
inherited

Sets whether the entity is currently breathing. If false, it will cause the entity's air supply to be used. For players, this also shows the oxygen bar.

Definition at line 696 of file Living.php.

◆ setCanClimb()

pocketmine\entity\Entity::setCanClimb ( bool  $value = true)
inherited

Sets whether the entity is able to climb climbable blocks.

Definition at line 371 of file Entity.php.

◆ setCanClimbWalls()

pocketmine\entity\Entity::setCanClimbWalls ( bool  $value = true)
inherited

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

Definition at line 386 of file Entity.php.

◆ setCanSaveWithChunk()

pocketmine\player\Player::setCanSaveWithChunk ( bool  $value)

Sets whether this entity will be saved when its chunk is unloaded. This can be used to prevent the entity being saved to disk.

Reimplemented from pocketmine\entity\Entity.

Definition at line 2210 of file Player.php.

◆ setCurrentWindow()

pocketmine\player\Player::setCurrentWindow ( Inventory  $inventory)

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

Definition at line 2515 of file Player.php.

◆ setDisplayName()

pocketmine\player\Player::setDisplayName ( string  $name)

Definition at line 601 of file Player.php.

◆ setFallDistance()

pocketmine\entity\Entity::setFallDistance ( float  $fallDistance)
inherited

Definition at line 1049 of file Entity.php.

◆ setFireTicks()

pocketmine\entity\Entity::setFireTicks ( int  $fireTicks)
inherited
Exceptions

InvalidArgumentException

Definition at line 684 of file Entity.php.

◆ setFlying()

pocketmine\player\Player::setFlying ( bool  $value)

Definition at line 470 of file Player.php.

◆ setForceMovementUpdate()

pocketmine\entity\Entity::setForceMovementUpdate ( bool  $value = true)
finalinherited

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.

Definition at line 1028 of file Entity.php.

◆ setGamemode()

pocketmine\player\Player::setGamemode ( GameMode  $gm)

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

Definition at line 1076 of file Player.php.

◆ setGliding()

pocketmine\entity\Living::setGliding ( bool  $value = true)
inherited

Definition at line 239 of file Living.php.

◆ setHasBlockCollision()

pocketmine\player\Player::setHasBlockCollision ( bool  $value)

Sets whether the player's movement may be obstructed by blocks with collision boxes. If set to false, the player can move through any block unobstructed.

Note: Enabling flight mode in conjunction with this is recommended. A non-flying player will simply fall through the ground into the void.

See also
Player::setFlying()

Definition at line 455 of file Player.php.

◆ setHasGravity()

pocketmine\entity\Entity::setHasGravity ( bool  $v = true)
inherited

Definition at line 801 of file Entity.php.

◆ setHealth()

pocketmine\entity\Living::setHealth ( float  $amount)
inherited

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

Reimplemented from pocketmine\entity\Entity.

Definition at line 187 of file Living.php.

Referenced by pocketmine\entity\effect\HealthBoostEffect\remove().

+ Here is the caller graph for this function:

◆ setImmobile()

pocketmine\entity\Entity::setImmobile ( bool  $value = true)
inherited

Definition at line 338 of file Entity.php.

◆ setInvisible()

pocketmine\entity\Entity::setInvisible ( bool  $value = true)
inherited

Definition at line 347 of file Entity.php.

◆ setLastDamageCause()

pocketmine\entity\Entity::setLastDamageCause ( EntityDamageEvent  $type)
inherited

Definition at line 607 of file Entity.php.

◆ setMaxAirSupplyTicks()

pocketmine\entity\Living::setMaxAirSupplyTicks ( int  $ticks)
inherited

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

Definition at line 727 of file Living.php.

◆ setMaxHealth()

pocketmine\entity\Living::setMaxHealth ( int  $amount)
inherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 200 of file Living.php.

◆ setMotion()

pocketmine\player\Player::setMotion ( Vector3  $motion)

Reimplemented from pocketmine\entity\Entity.

Definition at line 1317 of file Player.php.

◆ setMovementSpeed()

pocketmine\entity\Living::setMovementSpeed ( float  $v,
bool  $fit = false 
)
inherited

Definition at line 269 of file Living.php.

◆ setNameTag()

pocketmine\entity\Entity::setNameTag ( string  $name)
inherited

Definition at line 271 of file Entity.php.

◆ setNameTagAlwaysVisible()

pocketmine\entity\Entity::setNameTagAlwaysVisible ( bool  $value = true)
inherited

Definition at line 281 of file Entity.php.

◆ setNameTagVisible()

pocketmine\entity\Entity::setNameTagVisible ( bool  $value = true)
inherited

Definition at line 276 of file Entity.php.

◆ setOnFire()

pocketmine\entity\Living::setOnFire ( int  $seconds)
inherited

Reimplemented from pocketmine\entity\Entity.

Definition at line 408 of file Living.php.

◆ setOwningEntity()

pocketmine\entity\Entity::setOwningEntity ( ?Entity  $owner)
inherited

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

Exceptions

InvalidArgumentException if the supplied entity is not valid

Definition at line 410 of file Entity.php.

◆ setPosition()

pocketmine\player\Player::setPosition ( Vector3  $pos)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 701 of file Player.php.

◆ setPositionAndRotation()

pocketmine\entity\Entity::setPositionAndRotation ( Vector3  $pos,
float  $yaw,
float  $pitch 
)
protectedinherited

Definition at line 1359 of file Entity.php.

◆ setRotation()

pocketmine\entity\Entity::setRotation ( float  $yaw,
float  $pitch 
)
inherited

Definition at line 1351 of file Entity.php.

◆ setScale()

pocketmine\entity\Entity::setScale ( float  $value)
inherited

Definition at line 299 of file Entity.php.

◆ setScoreTag()

pocketmine\entity\Entity::setScoreTag ( string  $score)
inherited

Definition at line 290 of file Entity.php.

◆ setScreenLineHeight()

pocketmine\player\Player::setScreenLineHeight ( ?int  $height)

Sets the line height used for command output pagination for this command sender. null will reset it to default. @phpstan-param positive-int|null $height

Implements pocketmine\command\CommandSender.

Definition at line 507 of file Player.php.

◆ setSilent()

pocketmine\entity\Entity::setSilent ( bool  $value = true)
inherited

Definition at line 356 of file Entity.php.

◆ setSize()

pocketmine\entity\Entity::setSize ( EntitySizeInfo  $size)
protectedinherited

Definition at line 328 of file Entity.php.

◆ setSkin()

pocketmine\entity\Human::setSkin ( Skin  $skin)
inherited

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

Definition at line 145 of file Human.php.

◆ setSneaking()

pocketmine\entity\Living::setSneaking ( bool  $value = true)
inherited

Definition at line 216 of file Living.php.

◆ setSpawn()

pocketmine\player\Player::setSpawn ( ?Vector3  $pos)

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

Parameters
Vector3 | Position | null$pos

Definition at line 983 of file Player.php.

◆ setSprinting()

pocketmine\entity\Living::setSprinting ( bool  $value = true)
inherited

Definition at line 225 of file Living.php.

◆ setSwimming()

pocketmine\entity\Living::setSwimming ( bool  $value = true)
inherited

Definition at line 249 of file Living.php.

◆ setTargetEntity()

pocketmine\entity\Entity::setTargetEntity ( ?Entity  $target)
inherited

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

Exceptions

InvalidArgumentException if the target entity is not valid

Definition at line 441 of file Entity.php.

◆ setTitleDuration()

pocketmine\player\Player::setTitleDuration ( int  $fadeIn,
int  $stay,
int  $fadeOut 
)

Sets the title duration.

Parameters
int$fadeInTitle fade-in time in ticks.
int$stayTitle stay time in ticks.
int$fadeOutTitle fade-out time in ticks.

Definition at line 1966 of file Player.php.

◆ setUsingItem()

pocketmine\player\Player::setUsingItem ( bool  $value)

Definition at line 653 of file Player.php.

◆ setViewDistance()

pocketmine\player\Player::setViewDistance ( int  $distance)

Definition at line 553 of file Player.php.

◆ showPlayer()

pocketmine\player\Player::showPlayer ( Player  $player)

Definition at line 526 of file Player.php.

◆ sleepOn()

pocketmine\player\Player::sleepOn ( Vector3  $pos)

Definition at line 1001 of file Player.php.

◆ spawnEntitiesOnAllChunks()

pocketmine\player\Player::spawnEntitiesOnAllChunks ( )
protected

Definition at line 742 of file Player.php.

◆ spawnEntitiesOnChunk()

pocketmine\player\Player::spawnEntitiesOnChunk ( int  $chunkX,
int  $chunkZ 
)
protected

Definition at line 751 of file Player.php.

◆ spawnTo()

pocketmine\player\Player::spawnTo ( Player  $player)

Reimplemented from pocketmine\entity\Human.

Definition at line 493 of file Player.php.

◆ spawnToAll()

pocketmine\entity\Entity::spawnToAll ( )
inherited

Definition at line 1498 of file Entity.php.

◆ startDeathAnimation()

pocketmine\entity\Living::startDeathAnimation ( )
protectedinherited

Definition at line 605 of file Living.php.

◆ stopBreakBlock()

pocketmine\player\Player::stopBreakBlock ( Vector3  $pos)

Definition at line 1666 of file Player.php.

◆ stopSleep()

pocketmine\player\Player::stopSleep ( )

Definition at line 1026 of file Player.php.

◆ syncNetworkData()

pocketmine\player\Player::syncNetworkData ( EntityMetadataCollection  $properties)
protected

Reimplemented from pocketmine\entity\Living.

Definition at line 2376 of file Player.php.

◆ teleport()

pocketmine\player\Player::teleport ( Vector3  $pos,
?float  $yaw = null,
?float  $pitch = null 
)
Parameters
Vector3 | Position | Location$pos

Reimplemented from pocketmine\entity\Entity.

Definition at line 2419 of file Player.php.

◆ toggleFlight()

pocketmine\player\Player::toggleFlight ( bool  $fly)

Definition at line 1853 of file Player.php.

◆ toggleGlide()

pocketmine\player\Player::toggleGlide ( bool  $glide)

Definition at line 1869 of file Player.php.

◆ toggleSneak()

pocketmine\player\Player::toggleSneak ( bool  $sneak)

Definition at line 1840 of file Player.php.

◆ toggleSprint()

pocketmine\player\Player::toggleSprint ( bool  $sprint)

Definition at line 1827 of file Player.php.

◆ toggleSwim()

pocketmine\player\Player::toggleSwim ( bool  $swim)

Definition at line 1882 of file Player.php.

◆ transfer()

pocketmine\player\Player::transfer ( string  $address,
int  $port = 19132,
string  $message = "transfer" 
)

Transfers a player to another server.

Parameters
string$addressThe IP address or hostname of the destination server
int$portThe destination port, defaults to 19132
string$messageMessage to show in the console when closing the player
Returns
bool if transfer was successful.

Definition at line 2069 of file Player.php.

◆ tryChangeMovement()

pocketmine\player\Player::tryChangeMovement ( )
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 1331 of file Player.php.

◆ unloadChunk()

pocketmine\player\Player::unloadChunk ( int  $x,
int  $z,
?World  $world = null 
)
protected

Definition at line 724 of file Player.php.

◆ unsetBasePermission()

pocketmine\permission\Permissible::unsetBasePermission (   $name)
inherited

Unsets a baseline permission previously set. If it wasn't already set, this will have no effect. Note that this might have different results than setting the permission to false.

Implemented in pocketmine\permission\PermissibleInternal.

◆ updateFallState()

pocketmine\entity\Entity::updateFallState ( float  $distanceThisTick,
bool  $onGround 
)
protectedinherited

Definition at line 1057 of file Entity.php.

◆ updateMovement()

pocketmine\player\Player::updateMovement ( bool  $teleport = false)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 1327 of file Player.php.

◆ useHeldItem()

pocketmine\player\Player::useHeldItem ( )

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

Returns
bool if it did something

Definition at line 1481 of file Player.php.

Member Data Documentation

◆ $absorptionAttr

pocketmine\entity\Living::$absorptionAttr
protectedinherited

Definition at line 110 of file Living.php.

◆ $allowFlight

bool pocketmine\player\Player::$allowFlight = false
protected

Definition at line 254 of file Player.php.

◆ $alwaysShowNameTag

pocketmine\entity\Entity::$alwaysShowNameTag = false
protectedinherited

Definition at line 192 of file Entity.php.

◆ $armorInventory

pocketmine\entity\Living::$armorInventory
protectedinherited

Definition at line 98 of file Living.php.

◆ $attackTime

pocketmine\entity\Living::$attackTime = 0
protectedinherited

Definition at line 84 of file Living.php.

◆ $attributeMap

pocketmine\entity\Entity::$attributeMap
protectedinherited

Definition at line 165 of file Entity.php.

◆ $authenticated

bool pocketmine\player\Player::$authenticated
protected

Definition at line 198 of file Player.php.

◆ $autoJump

bool pocketmine\player\Player::$autoJump = true
protected

Definition at line 253 of file Player.php.

◆ $blockBreakHandler

SurvivalBlockBreakHandler pocketmine\player\Player::$blockBreakHandler = null
protected

Definition at line 274 of file Player.php.

◆ $blockCollision

bool pocketmine\player\Player::$blockCollision = true
protected

Definition at line 255 of file Player.php.

◆ $blocksAround

pocketmine\entity\Entity::$blocksAround
protectedinherited

Definition at line 105 of file Entity.php.

◆ $boundingBox

pocketmine\entity\Entity::$boundingBox
inherited

Definition at line 119 of file Entity.php.

◆ $breathing

pocketmine\entity\Living::$breathing = true
protectedinherited

Definition at line 101 of file Living.php.

◆ $breathTicks

pocketmine\entity\Living::$breathTicks = self::DEFAULT_BREATH_TICKS
protectedinherited

Definition at line 103 of file Living.php.

◆ $canClimb

pocketmine\entity\Entity::$canClimb = false
protectedinherited

Definition at line 199 of file Entity.php.

◆ $canClimbWalls

pocketmine\entity\Entity::$canClimbWalls = false
protectedinherited

Definition at line 201 of file Entity.php.

◆ $canCollide

pocketmine\entity\Entity::$canCollide = true
inherited

Definition at line 145 of file Entity.php.

◆ $chunkLoader

PlayerChunkLoader pocketmine\player\Player::$chunkLoader
protected

Definition at line 235 of file Player.php.

◆ $chunkSelector

ChunkSelector pocketmine\player\Player::$chunkSelector
protected

Definition at line 234 of file Player.php.

◆ $chunksPerTick

int pocketmine\player\Player::$chunksPerTick
protected

Definition at line 233 of file Player.php.

◆ $closed

pocketmine\entity\Entity::$closed = false
protectedinherited

Definition at line 178 of file Entity.php.

◆ $craftingGrid

PlayerCraftingInventory pocketmine\player\Player::$craftingGrid
protected

Definition at line 205 of file Player.php.

◆ $currentWindow

Inventory pocketmine\player\Player::$currentWindow = null
protected

Definition at line 201 of file Player.php.

◆ $cursorInventory

PlayerCursorInventory pocketmine\player\Player::$cursorInventory
protected

Definition at line 204 of file Player.php.

◆ $deadTicks

pocketmine\entity\Living::$deadTicks = 0
inherited

Definition at line 87 of file Living.php.

◆ $displayName

string pocketmine\player\Player::$displayName
protected

Definition at line 196 of file Player.php.

◆ $drag

pocketmine\entity\Living::$drag = 0.02
protectedinherited

Definition at line 81 of file Living.php.

◆ $effectManager

pocketmine\entity\Living::$effectManager
protectedinherited

Definition at line 95 of file Living.php.

◆ $enderInventory

pocketmine\entity\Human::$enderInventory
protectedinherited

Definition at line 89 of file Human.php.

◆ $fallDistance

pocketmine\entity\Entity::$fallDistance = 0.0
inherited

Definition at line 137 of file Entity.php.

◆ $fireTicks

pocketmine\entity\Entity::$fireTicks = 0
protectedinherited

Definition at line 143 of file Entity.php.

◆ $firstPlayed

int pocketmine\player\Player::$firstPlayed
protected

Definition at line 209 of file Player.php.

◆ $flying

bool pocketmine\player\Player::$flying = false
protected

Definition at line 256 of file Player.php.

◆ $forceMovementUpdate

pocketmine\entity\Entity::$forceMovementUpdate = false
protectedinherited

Definition at line 116 of file Entity.php.

◆ $formIdCounter

int pocketmine\player\Player::$formIdCounter = 0
protected

Definition at line 268 of file Player.php.

◆ $forms

array pocketmine\player\Player::$forms = []
protected

Definition at line 270 of file Player.php.

◆ $gamemode

GameMode pocketmine\player\Player::$gamemode
protected

Definition at line 211 of file Player.php.

◆ $gliding

pocketmine\entity\Living::$gliding = false
protectedinherited

Definition at line 121 of file Living.php.

◆ $gravity

pocketmine\entity\Living::$gravity = 0.08
protectedinherited

Definition at line 80 of file Living.php.

◆ $gravityEnabled

pocketmine\entity\Entity::$gravityEnabled = true
protectedinherited

Definition at line 172 of file Entity.php.

◆ $hasSpawned

pocketmine\entity\Entity::$hasSpawned = []
protectedinherited

Definition at line 94 of file Entity.php.

◆ $healthAttr

pocketmine\entity\Living::$healthAttr
protectedinherited

Definition at line 108 of file Living.php.

◆ $hiddenPlayers

array pocketmine\player\Player::$hiddenPlayers = []
protected

Definition at line 238 of file Player.php.

◆ $hungerManager

pocketmine\entity\Human::$hungerManager
protectedinherited

Definition at line 98 of file Human.php.

◆ $id

pocketmine\entity\Entity::$id
protectedinherited

Definition at line 97 of file Entity.php.

◆ $immobile

pocketmine\entity\Entity::$immobile = false
protectedinherited

Definition at line 203 of file Entity.php.

◆ $inAirTicks

int pocketmine\player\Player::$inAirTicks = 0
protected

Definition at line 243 of file Player.php.

◆ $inventory

pocketmine\entity\Human::$inventory
protectedinherited

Definition at line 83 of file Human.php.

◆ $invisible

pocketmine\entity\Entity::$invisible = false
protectedinherited

Definition at line 205 of file Entity.php.

◆ $isCollided

pocketmine\entity\Entity::$isCollided = false
inherited

Definition at line 153 of file Entity.php.

◆ $isCollidedHorizontally

pocketmine\entity\Entity::$isCollidedHorizontally = false
inherited

Definition at line 155 of file Entity.php.

◆ $isCollidedVertically

pocketmine\entity\Entity::$isCollidedVertically = false
inherited

Definition at line 157 of file Entity.php.

◆ $isStatic

pocketmine\entity\Entity::$isStatic = false
protectedinherited

Definition at line 148 of file Entity.php.

◆ $jumpVelocity

pocketmine\entity\Living::$jumpVelocity = 0.42
protectedinherited

Definition at line 92 of file Living.php.

◆ $justCreated

pocketmine\entity\Entity::$justCreated = true
protectedinherited

Definition at line 162 of file Entity.php.

◆ $keepMovement

pocketmine\entity\Entity::$keepMovement = false
inherited

Definition at line 134 of file Entity.php.

◆ $knockbackResistanceAttr

pocketmine\entity\Living::$knockbackResistanceAttr
protectedinherited

Definition at line 112 of file Living.php.

◆ $lastDamageCause

pocketmine\entity\Entity::$lastDamageCause = null
protectedinherited

Definition at line 102 of file Entity.php.

◆ $lastLocation

pocketmine\entity\Entity::$lastLocation
protectedinherited

Definition at line 110 of file Entity.php.

◆ $lastMotion

pocketmine\entity\Entity::$lastMotion
protectedinherited

Definition at line 114 of file Entity.php.

◆ $lastMovementProcess

float pocketmine\player\Player::$lastMovementProcess = null
protected

Definition at line 241 of file Player.php.

◆ $lastPlayed

int pocketmine\player\Player::$lastPlayed
protected

Definition at line 210 of file Player.php.

◆ $lastUpdate

pocketmine\entity\Entity::$lastUpdate
inherited

Definition at line 141 of file Entity.php.

◆ $lineHeight

int pocketmine\player\Player::$lineHeight = null
protected

@phpstan-var positive-int|null

Definition at line 259 of file Player.php.

◆ $loadQueue

array pocketmine\player\Player::$loadQueue = []
protected

Definition at line 227 of file Player.php.

◆ $locale

string pocketmine\player\Player::$locale = "en_US"
protected

Definition at line 260 of file Player.php.

◆ $location

pocketmine\entity\Entity::$location
protectedinherited

Definition at line 108 of file Entity.php.

◆ $logger

Logger pocketmine\player\Player::$logger
protected

Definition at line 272 of file Player.php.

◆ $maxBreathTicks

pocketmine\entity\Living::$maxBreathTicks = self::DEFAULT_BREATH_TICKS
protectedinherited

Definition at line 105 of file Living.php.

◆ $maxDeadTicks

pocketmine\entity\Living::$maxDeadTicks = 25
protectedinherited

Definition at line 89 of file Living.php.

◆ $messageCounter

int pocketmine\player\Player::$messageCounter = 2
protected

Definition at line 207 of file Player.php.

◆ $motion

pocketmine\entity\Entity::$motion
protectedinherited

Definition at line 112 of file Entity.php.

◆ $moveRateLimit

float pocketmine\player\Player::$moveRateLimit = 10 * self::MOVES_PER_TICK
protected

Definition at line 240 of file Player.php.

◆ $moveSpeedAttr

pocketmine\entity\Living::$moveSpeedAttr
protectedinherited

Definition at line 114 of file Living.php.

◆ $nameTag

pocketmine\entity\Entity::$nameTag = ""
protectedinherited

Definition at line 188 of file Entity.php.

◆ $nameTagVisible

pocketmine\entity\Entity::$nameTagVisible = true
protectedinherited

Definition at line 190 of file Entity.php.

◆ $networkPropertiesDirty

bool pocketmine\entity\Entity::$networkPropertiesDirty = false
protectedinherited

Definition at line 185 of file Entity.php.

◆ $networkSession

NetworkSession pocketmine\player\Player::$networkSession
protected

Definition at line 191 of file Player.php.

◆ $nextChunkOrderRun

int pocketmine\player\Player::$nextChunkOrderRun = 5
protected

Definition at line 228 of file Player.php.

◆ $noDamageTicks

pocketmine\entity\Entity::$noDamageTicks = 0
inherited

Definition at line 160 of file Entity.php.

◆ $offHandInventory

pocketmine\entity\Human::$offHandInventory
protectedinherited

Definition at line 86 of file Human.php.

◆ $onGround

pocketmine\entity\Entity::$onGround = false
inherited

Definition at line 121 of file Entity.php.

◆ $ownerId

pocketmine\entity\Entity::$ownerId = null
protectedinherited

Definition at line 210 of file Entity.php.

◆ $permanentWindows

array pocketmine\player\Player::$permanentWindows = []
protected

Definition at line 203 of file Player.php.

◆ $playerInfo

PlayerInfo pocketmine\player\Player::$playerInfo
protected

Definition at line 199 of file Player.php.

◆ $scale

pocketmine\entity\Entity::$scale = 1.0
protectedinherited

Definition at line 196 of file Entity.php.

◆ $scoreTag

pocketmine\entity\Entity::$scoreTag = ""
protectedinherited

Definition at line 194 of file Entity.php.

◆ $server

pocketmine\entity\Entity::$server
protectedinherited

Definition at line 175 of file Entity.php.

◆ $silent

pocketmine\entity\Entity::$silent = false
protectedinherited

Definition at line 207 of file Entity.php.

◆ $size

pocketmine\entity\Entity::$size
inherited

Definition at line 124 of file Entity.php.

◆ $skin

pocketmine\entity\Human::$skin
protectedinherited

Definition at line 95 of file Human.php.

◆ $sleeping

Vector3 pocketmine\player\Player::$sleeping = null
protected

Definition at line 247 of file Player.php.

◆ $sneaking

pocketmine\entity\Living::$sneaking = false
protectedinherited

Definition at line 119 of file Living.php.

◆ $spawnChunkLoadCount

int pocketmine\player\Player::$spawnChunkLoadCount = 0
protected

Definition at line 232 of file Player.php.

◆ $spawned

bool pocketmine\player\Player::$spawned = false

Definition at line 193 of file Player.php.

◆ $spawnThreshold

int pocketmine\player\Player::$spawnThreshold
protected

Definition at line 231 of file Player.php.

◆ $sprinting

pocketmine\entity\Living::$sprinting = false
protectedinherited

Definition at line 117 of file Living.php.

◆ $startAction

int pocketmine\player\Player::$startAction = -1
protected

Definition at line 262 of file Player.php.

◆ $stepHeight

pocketmine\player\Player::$stepHeight = 0.6
protected

Definition at line 245 of file Player.php.

◆ $swimming

pocketmine\entity\Living::$swimming = false
protectedinherited

Definition at line 123 of file Living.php.

◆ $targetId

pocketmine\entity\Entity::$targetId = null
protectedinherited

Definition at line 212 of file Entity.php.

◆ $ticksLived

pocketmine\entity\Entity::$ticksLived = 0
inherited

Definition at line 139 of file Entity.php.

◆ $timings

pocketmine\entity\Entity::$timings
protectedinherited

Definition at line 183 of file Entity.php.

◆ $usedChunks

array pocketmine\player\Player::$usedChunks = []
protected

Definition at line 217 of file Player.php.

◆ $usedItemsCooldown

array pocketmine\player\Player::$usedItemsCooldown = []
protected

Definition at line 264 of file Player.php.

◆ $username

string pocketmine\player\Player::$username
protected

Definition at line 195 of file Player.php.

◆ $uuid

pocketmine\entity\Human::$uuid
protectedinherited

Definition at line 92 of file Human.php.

◆ $viewDistance

int pocketmine\player\Player::$viewDistance = -1
protected

Definition at line 230 of file Player.php.

◆ $xpManager

pocketmine\entity\Human::$xpManager
protectedinherited

Definition at line 100 of file Human.php.

◆ $xpSeed

pocketmine\entity\Human::$xpSeed
protectedinherited

Definition at line 103 of file Human.php.

◆ $xuid

string pocketmine\player\Player::$xuid = ""
protected

Definition at line 197 of file Player.php.

◆ $ySize

pocketmine\entity\Entity::$ySize = 0.0
protectedinherited

Definition at line 130 of file Entity.php.

◆ DEFAULT_BREATH_TICKS

const pocketmine\entity\Living::DEFAULT_BREATH_TICKS = 300
protectedinherited

Definition at line 78 of file Living.php.

◆ MOTION_THRESHOLD

const pocketmine\entity\Entity::MOTION_THRESHOLD = 0.00001
inherited

Definition at line 81 of file Entity.php.

◆ STEP_CLIP_MULTIPLIER

const pocketmine\entity\Entity::STEP_CLIP_MULTIPLIER = 0.4
protectedinherited

Definition at line 82 of file Entity.php.


The documentation for this class was generated from the following file: