PocketMine-MP 5.27.2 git-d86943fa8c6384be3e2c1901ebf94f584b27e784
Loading...
Searching...
No Matches
pocketmine\entity\object\FallingBlock Class Reference
+ Inheritance diagram for pocketmine\entity\object\FallingBlock:
+ Collaboration diagram for pocketmine\entity\object\FallingBlock:

Public Member Functions

 __construct (Location $location, Block $block, ?CompoundTag $nbt=null)
 
 __toString ()
 
 addMotion (float $x, float $y, float $z)
 
 attack (EntityDamageEvent $source)
 
 broadcastAnimation (Animation $animation, ?array $targets=null)
 
 broadcastSound (Sound $sound, ?array $targets=null)
 
 canBeCollidedWith ()
 
 canBeMovedByCurrents ()
 
 canBeRenamed ()
 
 canClimb ()
 
 canClimbWalls ()
 
 canCollideWith (Entity $entity)
 
 canSaveWithChunk ()
 
 close ()
 
 despawnFrom (Player $player, bool $send=true)
 
 despawnFromAll ()
 
 extinguish (int $cause=EntityExtinguishEvent::CAUSE_CUSTOM)
 
 flagForDespawn ()
 
 getAttributeMap ()
 
 getBlock ()
 
 getBoundingBox ()
 
 getDirectionPlane ()
 
 getDirectionVector ()
 
 getEyeHeight ()
 
 getEyePos ()
 
 getFallDistance ()
 
 getFireTicks ()
 
 getGravity ()
 
 getHealth ()
 
 getHorizontalFacing ()
 
 getId ()
 
 getLastDamageCause ()
 
 getLocation ()
 
 getMaxHealth ()
 
 getMotion ()
 
 getNameTag ()
 
 getNetworkProperties ()
 
 getNetworkTypeId ()
 
 getOffsetPosition (Vector3 $vector3)
 
 getOwningEntity ()
 
 getOwningEntityId ()
 
 getPickedItem ()
 
 getPosition ()
 
 getScale ()
 
 getScoreTag ()
 
 getSize ()
 
 getTargetEntity ()
 
 getTargetEntityId ()
 
 getViewers ()
 
 getWorld ()
 
 hasGravity ()
 
 hasMovementUpdate ()
 
 hasNoClientPredictions ()
 
 heal (EntityRegainHealthEvent $source)
 
 isAlive ()
 
 isClosed ()
 
 isFireProof ()
 
 isFlaggedForDespawn ()
 
 isInsideOfSolid ()
 
 isInvisible ()
 
 isNameTagAlwaysVisible ()
 
 isNameTagVisible ()
 
 isOnFire ()
 
 isOnGround ()
 
 isSilent ()
 
 isUnderwater ()
 
 kill ()
 
 onCollideWithPlayer (Player $player)
 
 onInteract (Player $player, Vector3 $clickPos)
 
 onNearbyBlockChange ()
 
 onRandomUpdate ()
 
 onUpdate (int $currentTick)
 
 resetFallDistance ()
 
 respawnToAll ()
 
 saveNBT ()
 
 scheduleUpdate ()
 
 sendData (?array $targets, ?array $data=null)
 
 setCanClimb (bool $value=true)
 
 setCanClimbWalls (bool $value=true)
 
 setCanSaveWithChunk (bool $value)
 
 setFallDistance (float $fallDistance)
 
 setFireTicks (int $fireTicks)
 
 setForceMovementUpdate (bool $value=true)
 
 setGravity (float $gravity)
 
 setHasGravity (bool $v=true)
 
 setHealth (float $amount)
 
 setInvisible (bool $value=true)
 
 setLastDamageCause (EntityDamageEvent $type)
 
 setMaxHealth (int $amount)
 
 setMotion (Vector3 $motion)
 
 setNameTag (string $name)
 
 setNameTagAlwaysVisible (bool $value=true)
 
 setNameTagVisible (bool $value=true)
 
 setNoClientPredictions (bool $value=true)
 
 setOnFire (int $seconds)
 
 setOwningEntity (?Entity $owner)
 
 setRotation (float $yaw, float $pitch)
 
 setScale (float $value)
 
 setScoreTag (string $score)
 
 setSilent (bool $value=true)
 
 setTargetEntity (?Entity $target)
 
 spawnTo (Player $player)
 
 spawnToAll ()
 
 teleport (Vector3 $pos, ?float $yaw=null, ?float $pitch=null)
 

Static Public Member Functions

static nextRuntimeId ()
 
static parseBlockNBT (RuntimeBlockStateRegistry $factory, CompoundTag $nbt)
 

Public Attributes

AxisAlignedBB $boundingBox
 
float $fallDistance = 0.0
 
bool $isCollided = false
 
bool $isCollidedHorizontally = false
 
bool $isCollidedVertically = false
 
bool $keepMovement = false
 
int $lastUpdate
 
int $noDamageTicks = 0
 
bool $onGround = false
 
EntitySizeInfo $size
 
int $ticksLived = 0
 
const MOTION_THRESHOLD = 0.00001
 
const TAG_MOTION = "Motion"
 
const TAG_POS = "Pos"
 
const TAG_ROTATION = "Rotation"
 

Protected Member Functions

 addAttributes ()
 
 applyDragBeforeGravity ()
 
 broadcastMotion ()
 
 broadcastMovement (bool $teleport=false)
 
 checkBlockIntersections ()
 
 checkGroundState (float $wantedX, float $wantedY, float $wantedZ, float $dx, float $dy, float $dz)
 
 checkObstruction (float $x, float $y, float $z)
 
 dealFireDamage ()
 
 destroyCycles ()
 
 doOnFireTick (int $tickDiff=1)
 
 entityBaseTick (int $tickDiff=1)
 
 getAllNetworkData ()
 
 getBlocksAroundWithEntityInsideActions ()
 
 getBlocksIntersected (float $inset)
 
 getDirtyNetworkData ()
 
 getInitialDragMultiplier ()
 
 getInitialGravity ()
 
 getInitialSizeInfo ()
 
 initEntity (CompoundTag $nbt)
 
 move (float $dx, float $dy, float $dz)
 
 onDeath ()
 
 onDeathUpdate (int $tickDiff)
 
 onDispose ()
 
 onFirstUpdate (int $currentTick)
 
 onHitGround ()
 
 recalculateBoundingBox ()
 
 resetLastMovements ()
 
 sendSpawnPacket (Player $player)
 
 setPosition (Vector3 $pos)
 
 setPositionAndRotation (Vector3 $pos, float $yaw, float $pitch)
 
 setSize (EntitySizeInfo $size)
 
 syncNetworkData (EntityMetadataCollection $properties)
 
 tryChangeMovement ()
 
 updateFallState (float $distanceThisTick, bool $onGround)
 
 updateMovement (bool $teleport=false)
 

Protected Attributes

bool $alwaysShowNameTag = false
 
AttributeMap $attributeMap
 
Block $block
 
array $blocksAround = null
 
bool $canClimb = false
 
bool $canClimbWalls = false
 
bool $closed = false
 
float $drag
 
int $fireTicks = 0
 
bool $forceMovementUpdate = false
 
float $gravity
 
bool $gravityEnabled = true
 
array $hasSpawned = []
 
int $id
 
bool $invisible = false
 
bool $justCreated = true
 
EntityDamageEvent $lastDamageCause = null
 
Location $lastLocation
 
Vector3 $lastMotion
 
Location $location
 
Vector3 $motion
 
string $nameTag = ""
 
bool $nameTagVisible = true
 
bool $networkPropertiesDirty = false
 
bool $noClientPredictions = false
 
int $ownerId = null
 
float $scale = 1.0
 
string $scoreTag = ""
 
Server $server
 
bool $silent = false
 
float $stepHeight = 0.0
 
int $targetId = null
 
TimingsHandler $timings
 
float $ySize = 0.0
 
const STEP_CLIP_MULTIPLIER = 0.4
 

Detailed Description

Definition at line 53 of file FallingBlock.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\entity\object\FallingBlock::__construct ( Location $location,
Block $block,
?CompoundTag $nbt = null )

Definition at line 63 of file FallingBlock.php.

Member Function Documentation

◆ __toString()

pocketmine\entity\Entity::__toString ( )
inherited

Definition at line 1729 of file Entity.php.

◆ addAttributes()

pocketmine\entity\Entity::addAttributes ( )
protectedinherited

Definition at line 532 of file Entity.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 1440 of file Entity.php.

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

+ Here is the caller graph for this function:

◆ applyDragBeforeGravity()

pocketmine\entity\Entity::applyDragBeforeGravity ( )
protectedinherited

Definition at line 840 of file Entity.php.

◆ attack()

pocketmine\entity\object\FallingBlock::attack ( EntityDamageEvent $source)

Reimplemented from pocketmine\entity\Entity.

Definition at line 118 of file FallingBlock.php.

◆ broadcastAnimation()

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

Reimplemented in pocketmine\player\Player.

Definition at line 1711 of file Entity.php.

◆ broadcastMotion()

pocketmine\entity\Entity::broadcastMotion ( )
protectedinherited

Definition at line 819 of file Entity.php.

◆ broadcastMovement()

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

Definition at line 801 of file Entity.php.

◆ broadcastSound()

pocketmine\entity\Entity::broadcastSound ( Sound $sound,
?array $targets = null )
inherited

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

Parameters
Player[] | null$targets

Reimplemented in pocketmine\player\Player.

Definition at line 1719 of file Entity.php.

◆ canBeCollidedWith()

pocketmine\entity\Entity::canBeCollidedWith ( )
inherited

Definition at line 767 of file Entity.php.

◆ canBeMovedByCurrents()

pocketmine\entity\object\FallingBlock::canBeMovedByCurrents ( )

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

Reimplemented from pocketmine\entity\Entity.

Definition at line 114 of file FallingBlock.php.

◆ canBeRenamed()

pocketmine\entity\Entity::canBeRenamed ( )
inherited

Returns whether players can rename this entity using a name tag. Note that plugins can still name entities using setNameTag().

Reimplemented in pocketmine\entity\Living, and pocketmine\player\Player.

Definition at line 266 of file Entity.php.

◆ canClimb()

pocketmine\entity\Entity::canClimb ( )
inherited

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

Definition at line 375 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 390 of file Entity.php.

◆ canCollideWith()

pocketmine\entity\object\FallingBlock::canCollideWith ( Entity $entity)

Reimplemented from pocketmine\entity\Entity.

Definition at line 110 of file FallingBlock.php.

◆ canSaveWithChunk()

pocketmine\entity\Entity::canSaveWithChunk ( )
inherited

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

Reimplemented in pocketmine\entity\object\ItemEntity, and pocketmine\player\Player.

Definition at line 466 of file Entity.php.

◆ checkBlockIntersections()

pocketmine\entity\Entity::checkBlockIntersections ( )
protectedinherited

Definition at line 1325 of file Entity.php.

◆ checkGroundState()

pocketmine\entity\Entity::checkGroundState ( float $wantedX,
float $wantedY,
float $wantedZ,
float $dx,
float $dy,
float $dz )
protectedinherited

Definition at line 1269 of file Entity.php.

◆ checkObstruction()

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

Definition at line 868 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 1611 of file Entity.php.

◆ dealFireDamage()

pocketmine\entity\Entity::dealFireDamage ( )
protectedinherited

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

Definition at line 758 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 1558 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 1572 of file Entity.php.

◆ destroyCycles()

pocketmine\entity\Entity::destroyCycles ( )
protectedinherited

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 in pocketmine\entity\Human, pocketmine\entity\Living, and pocketmine\player\Player.

Definition at line 1644 of file Entity.php.

◆ doOnFireTick()

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

Definition at line 734 of file Entity.php.

◆ entityBaseTick()

pocketmine\entity\object\FallingBlock::entityBaseTick ( int $tickDiff = 1)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 124 of file FallingBlock.php.

◆ extinguish()

pocketmine\entity\Entity::extinguish ( int $cause = EntityExtinguishEvent::CAUSE_CUSTOM)
inherited

Definition at line 722 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 1590 of file Entity.php.

◆ getAllNetworkData()

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

Definition at line 1677 of file Entity.php.

◆ getAttributeMap()

pocketmine\entity\Entity::getAttributeMap ( )
inherited

Definition at line 633 of file Entity.php.

◆ getBlock()

pocketmine\entity\object\FallingBlock::getBlock ( )

Definition at line 187 of file FallingBlock.php.

◆ getBlocksAroundWithEntityInsideActions()

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

Definition at line 1303 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 1281 of file Entity.php.

◆ getBoundingBox()

pocketmine\entity\Entity::getBoundingBox ( )
inherited

Definition at line 306 of file Entity.php.

◆ getDirectionPlane()

pocketmine\entity\Entity::getDirectionPlane ( )
inherited

Definition at line 970 of file Entity.php.

◆ getDirectionVector()

pocketmine\entity\Entity::getDirectionVector ( )
inherited

Definition at line 961 of file Entity.php.

◆ getDirtyNetworkData()

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

Definition at line 1665 of file Entity.php.

◆ getEyeHeight()

pocketmine\entity\Entity::getEyeHeight ( )
inherited

Definition at line 1117 of file Entity.php.

◆ getEyePos()

pocketmine\entity\Entity::getEyePos ( )
inherited

Definition at line 1121 of file Entity.php.

◆ getFallDistance()

pocketmine\entity\Entity::getFallDistance ( )
inherited

Definition at line 1082 of file Entity.php.

◆ getFireTicks()

pocketmine\entity\Entity::getFireTicks ( )
inherited

Definition at line 698 of file Entity.php.

◆ getGravity()

pocketmine\entity\Entity::getGravity ( )
inherited

Definition at line 823 of file Entity.php.

◆ getHealth()

pocketmine\entity\Entity::getHealth ( )
inherited

Definition at line 590 of file Entity.php.

◆ getHorizontalFacing()

pocketmine\entity\Entity::getHorizontalFacing ( )
inherited

Definition at line 942 of file Entity.php.

◆ getId()

pocketmine\entity\Entity::getId ( )
inherited

Definition at line 1490 of file Entity.php.

◆ getInitialDragMultiplier()

pocketmine\entity\object\FallingBlock::getInitialDragMultiplier ( )
protected

Returns the percentage by which the entity's velocity is reduced per tick when moving through air. The entity's velocity is multiplied by 1 minus this value.

Returns
float 0-1

Reimplemented from pocketmine\entity\Entity.

Definition at line 70 of file FallingBlock.php.

◆ getInitialGravity()

pocketmine\entity\object\FallingBlock::getInitialGravity ( )
protected

Returns the downwards acceleration of the entity when falling, in blocks/tick².

Returns
float minimum 0

Reimplemented from pocketmine\entity\Entity.

Definition at line 72 of file FallingBlock.php.

◆ getInitialSizeInfo()

pocketmine\entity\object\FallingBlock::getInitialSizeInfo ( )
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 68 of file FallingBlock.php.

◆ getLastDamageCause()

pocketmine\entity\Entity::getLastDamageCause ( )
inherited

Definition at line 629 of file Entity.php.

◆ getLocation()

pocketmine\entity\Entity::getLocation ( )
inherited

Definition at line 1351 of file Entity.php.

◆ getMaxHealth()

pocketmine\entity\Entity::getMaxHealth ( )
inherited

Definition at line 617 of file Entity.php.

◆ getMotion()

pocketmine\entity\Entity::getMotion ( )
inherited

Definition at line 1414 of file Entity.php.

◆ getNameTag()

pocketmine\entity\Entity::getNameTag ( )
inherited

Definition at line 250 of file Entity.php.

◆ getNetworkProperties()

pocketmine\entity\Entity::getNetworkProperties ( )
inherited

Definition at line 637 of file Entity.php.

◆ getNetworkTypeId()

pocketmine\entity\object\FallingBlock::getNetworkTypeId ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 59 of file FallingBlock.php.

◆ getOffsetPosition()

pocketmine\entity\object\FallingBlock::getOffsetPosition ( Vector3 $vector3)

Reimplemented from pocketmine\entity\Entity.

Definition at line 208 of file FallingBlock.php.

◆ getOwningEntity()

pocketmine\entity\Entity::getOwningEntity ( )
inherited

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

Definition at line 412 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 405 of file Entity.php.

◆ getPickedItem()

pocketmine\entity\object\FallingBlock::getPickedItem ( )

Returns the item that players will equip when middle-clicking on this entity.

Reimplemented from pocketmine\entity\Entity.

Definition at line 198 of file FallingBlock.php.

◆ getPosition()

pocketmine\entity\Entity::getPosition ( )
inherited

Definition at line 1347 of file Entity.php.

◆ getScale()

pocketmine\entity\Entity::getScale ( )
inherited

Definition at line 294 of file Entity.php.

◆ getScoreTag()

pocketmine\entity\Entity::getScoreTag ( )
inherited

Definition at line 285 of file Entity.php.

◆ getSize()

pocketmine\entity\Entity::getSize ( )
inherited

Definition at line 323 of file Entity.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 443 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 435 of file Entity.php.

◆ getViewers()

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

Definition at line 1497 of file Entity.php.

◆ getWorld()

pocketmine\entity\Entity::getWorld ( )
inherited

Definition at line 1355 of file Entity.php.

◆ hasGravity()

pocketmine\entity\Entity::hasGravity ( )
inherited

Definition at line 832 of file Entity.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 1072 of file Entity.php.

◆ hasNoClientPredictions()

pocketmine\entity\Entity::hasNoClientPredictions ( )
inherited

Returns whether clients may predict this entity's behaviour and movement. Used for things like water movement, burning, and movement smoothing (interpolation).

Definition at line 337 of file Entity.php.

◆ heal()

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

Definition at line 555 of file Entity.php.

◆ initEntity()

pocketmine\entity\Entity::initEntity ( CompoundTag $nbt)
protectedinherited

Definition at line 513 of file Entity.php.

◆ isAlive()

pocketmine\entity\Entity::isAlive ( )
inherited

Definition at line 586 of file Entity.php.

◆ isClosed()

pocketmine\entity\Entity::isClosed ( )
inherited

Returns whether the entity has been "closed".

Definition at line 1602 of file Entity.php.

◆ isFireProof()

pocketmine\entity\Entity::isFireProof ( )
inherited

Definition at line 730 of file Entity.php.

◆ isFlaggedForDespawn()

pocketmine\entity\Entity::isFlaggedForDespawn ( )
inherited

Definition at line 1595 of file Entity.php.

◆ isInsideOfSolid()

pocketmine\entity\Entity::isInsideOfSolid ( )
inherited

Definition at line 1147 of file Entity.php.

◆ isInvisible()

pocketmine\entity\Entity::isInvisible ( )
inherited

Definition at line 354 of file Entity.php.

◆ isNameTagAlwaysVisible()

pocketmine\entity\Entity::isNameTagAlwaysVisible ( )
inherited

Definition at line 258 of file Entity.php.

◆ isNameTagVisible()

pocketmine\entity\Entity::isNameTagVisible ( )
inherited

Definition at line 254 of file Entity.php.

◆ isOnFire()

pocketmine\entity\Entity::isOnFire ( )
inherited

Definition at line 686 of file Entity.php.

◆ isOnGround()

pocketmine\entity\Entity::isOnGround ( )
inherited

Definition at line 1447 of file Entity.php.

◆ isSilent()

pocketmine\entity\Entity::isSilent ( )
inherited

Definition at line 363 of file Entity.php.

◆ isUnderwater()

pocketmine\entity\Entity::isUnderwater ( )
inherited

Definition at line 1136 of file Entity.php.

◆ kill()

pocketmine\entity\Entity::kill ( )
inherited

Definition at line 564 of file Entity.php.

◆ move()

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

Definition at line 1153 of file Entity.php.

◆ nextRuntimeId()

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

Returns a new runtime entity ID for a new entity.

Definition at line 105 of file Entity.php.

◆ onCollideWithPlayer()

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

Definition at line 1125 of file Entity.php.

◆ onDeath()

pocketmine\entity\Entity::onDeath ( )
protectedinherited

Override this to do actions on death.

Reimplemented in pocketmine\entity\Living, pocketmine\entity\object\Painting, and pocketmine\player\Player.

Definition at line 575 of file Entity.php.

◆ onDeathUpdate()

pocketmine\entity\Entity::onDeathUpdate ( int $tickDiff)
protectedinherited

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

Reimplemented in pocketmine\entity\Living, and pocketmine\player\Player.

Definition at line 582 of file Entity.php.

◆ onDispose()

pocketmine\entity\Entity::onDispose ( )
protectedinherited

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 in pocketmine\entity\Human, pocketmine\entity\Living, and pocketmine\player\Player.

Definition at line 1631 of file Entity.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 978 of file Entity.php.

◆ onHitGround()

pocketmine\entity\object\FallingBlock::onHitGround ( )
protected

Called when a falling entity hits the ground.

Reimplemented from pocketmine\entity\Entity.

Definition at line 168 of file FallingBlock.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 1132 of file Entity.php.

◆ onNearbyBlockChange()

pocketmine\entity\Entity::onNearbyBlockChange ( )
inherited

Definition at line 1046 of file Entity.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 1055 of file Entity.php.

◆ onUpdate()

pocketmine\entity\Entity::onUpdate ( int $currentTick)
inherited

Definition at line 982 of file Entity.php.

◆ parseBlockNBT()

static pocketmine\entity\object\FallingBlock::parseBlockNBT ( RuntimeBlockStateRegistry $factory,
CompoundTag $nbt )
static

Definition at line 74 of file FallingBlock.php.

◆ recalculateBoundingBox()

pocketmine\entity\Entity::recalculateBoundingBox ( )
protectedinherited

Definition at line 310 of file Entity.php.

◆ resetFallDistance()

pocketmine\entity\Entity::resetFallDistance ( )
inherited

Definition at line 1088 of file Entity.php.

◆ resetLastMovements()

pocketmine\entity\Entity::resetLastMovements ( )
protectedinherited

Definition at line 1409 of file Entity.php.

◆ respawnToAll()

pocketmine\entity\Entity::respawnToAll ( )
inherited

Definition at line 1547 of file Entity.php.

◆ saveNBT()

pocketmine\entity\object\FallingBlock::saveNBT ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 191 of file FallingBlock.php.

◆ scheduleUpdate()

pocketmine\entity\Entity::scheduleUpdate ( )
finalinherited

Definition at line 1039 of file Entity.php.

◆ sendData()

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

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

Reimplemented in pocketmine\player\Player.

Definition at line 1654 of file Entity.php.

◆ sendSpawnPacket()

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

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

Reimplemented in pocketmine\entity\Human, pocketmine\entity\Living, pocketmine\entity\object\ItemEntity, and pocketmine\entity\object\Painting.

Definition at line 1506 of file Entity.php.

◆ setCanClimb()

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

Sets whether the entity is able to climb climbable blocks.

Definition at line 382 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 397 of file Entity.php.

◆ setCanSaveWithChunk()

pocketmine\entity\Entity::setCanSaveWithChunk ( bool $value)
inherited

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 in pocketmine\player\Player.

Definition at line 474 of file Entity.php.

◆ setFallDistance()

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

Definition at line 1084 of file Entity.php.

◆ setFireTicks()

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

InvalidArgumentException

Definition at line 705 of file Entity.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 1063 of file Entity.php.

◆ setGravity()

pocketmine\entity\Entity::setGravity ( float $gravity)
inherited

Definition at line 827 of file Entity.php.

◆ setHasGravity()

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

Definition at line 836 of file Entity.php.

◆ setHealth()

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

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

Reimplemented in pocketmine\entity\Living.

Definition at line 597 of file Entity.php.

◆ setInvisible()

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

Definition at line 358 of file Entity.php.

◆ setLastDamageCause()

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

Definition at line 625 of file Entity.php.

◆ setMaxHealth()

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

Definition at line 621 of file Entity.php.

◆ setMotion()

pocketmine\entity\Entity::setMotion ( Vector3 $motion)
inherited

Definition at line 1418 of file Entity.php.

◆ setNameTag()

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

Definition at line 270 of file Entity.php.

◆ setNameTagAlwaysVisible()

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

Definition at line 280 of file Entity.php.

◆ setNameTagVisible()

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

Definition at line 275 of file Entity.php.

◆ setNoClientPredictions()

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

Things such as movement in water, burning, etc. may be predicted by the client. This is sometimes not desirable, since server-side logic may differ from client-side prediction. However, things like movement smoothing (interpolation) are also controlled by this, so it should be used with care.

Setting this flag will also disable player movement inputs, but this should not be relied on, as cheat clients will be able to bypass it.

Definition at line 349 of file Entity.php.

◆ setOnFire()

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

Definition at line 690 of file Entity.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 421 of file Entity.php.

◆ setPosition()

pocketmine\entity\Entity::setPosition ( Vector3 $pos)
protectedinherited

Definition at line 1359 of file Entity.php.

◆ setPositionAndRotation()

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

Definition at line 1399 of file Entity.php.

◆ setRotation()

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

Definition at line 1391 of file Entity.php.

◆ setScale()

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

Definition at line 298 of file Entity.php.

◆ setScoreTag()

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

Definition at line 289 of file Entity.php.

◆ setSilent()

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

Definition at line 367 of file Entity.php.

◆ setSize()

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

Definition at line 327 of file Entity.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 452 of file Entity.php.

◆ spawnTo()

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

Definition at line 1526 of file Entity.php.

◆ spawnToAll()

pocketmine\entity\Entity::spawnToAll ( )
inherited

Definition at line 1538 of file Entity.php.

◆ syncNetworkData()

pocketmine\entity\object\FallingBlock::syncNetworkData ( EntityMetadataCollection $properties)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 202 of file FallingBlock.php.

◆ teleport()

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

Reimplemented in pocketmine\player\Player.

Definition at line 1454 of file Entity.php.

Referenced by pocketmine\item\ChorusFruit\onConsume().

+ Here is the caller graph for this function:

◆ tryChangeMovement()

pocketmine\entity\Entity::tryChangeMovement ( )
protectedinherited

Definition at line 844 of file Entity.php.

◆ updateFallState()

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

Definition at line 1092 of file Entity.php.

◆ updateMovement()

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

Definition at line 771 of file Entity.php.

Member Data Documentation

◆ $alwaysShowNameTag

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

Definition at line 175 of file Entity.php.

◆ $attributeMap

AttributeMap pocketmine\entity\Entity::$attributeMap
protectedinherited

Definition at line 157 of file Entity.php.

◆ $block

Block pocketmine\entity\object\FallingBlock::$block
protected

Definition at line 61 of file FallingBlock.php.

◆ $blocksAround

array pocketmine\entity\Entity::$blocksAround = null
protectedinherited

Definition at line 122 of file Entity.php.

◆ $boundingBox

AxisAlignedBB pocketmine\entity\Entity::$boundingBox
inherited

Definition at line 131 of file Entity.php.

◆ $canClimb

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

Definition at line 179 of file Entity.php.

◆ $canClimbWalls

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

Definition at line 180 of file Entity.php.

◆ $closed

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

Definition at line 165 of file Entity.php.

◆ $drag

float pocketmine\entity\Entity::$drag
protectedinherited

Definition at line 160 of file Entity.php.

◆ $fallDistance

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

Definition at line 143 of file Entity.php.

◆ $fireTicks

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

Definition at line 146 of file Entity.php.

◆ $forceMovementUpdate

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

Definition at line 128 of file Entity.php.

◆ $gravity

float pocketmine\entity\Entity::$gravity
protectedinherited

Definition at line 159 of file Entity.php.

◆ $gravityEnabled

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

Definition at line 161 of file Entity.php.

◆ $hasSpawned

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

Definition at line 113 of file Entity.php.

◆ $id

int pocketmine\entity\Entity::$id
protectedinherited

Definition at line 115 of file Entity.php.

◆ $invisible

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

Definition at line 182 of file Entity.php.

◆ $isCollided

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

Definition at line 150 of file Entity.php.

◆ $isCollidedHorizontally

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

Definition at line 151 of file Entity.php.

◆ $isCollidedVertically

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

Definition at line 152 of file Entity.php.

◆ $justCreated

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

Definition at line 155 of file Entity.php.

◆ $keepMovement

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

Definition at line 141 of file Entity.php.

◆ $lastDamageCause

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

Definition at line 119 of file Entity.php.

◆ $lastLocation

Location pocketmine\entity\Entity::$lastLocation
protectedinherited

Definition at line 125 of file Entity.php.

◆ $lastMotion

Vector3 pocketmine\entity\Entity::$lastMotion
protectedinherited

Definition at line 127 of file Entity.php.

◆ $lastUpdate

int pocketmine\entity\Entity::$lastUpdate
inherited

Definition at line 145 of file Entity.php.

◆ $location

Location pocketmine\entity\Entity::$location
protectedinherited

Definition at line 124 of file Entity.php.

◆ $motion

Vector3 pocketmine\entity\Entity::$motion
protectedinherited

Definition at line 126 of file Entity.php.

◆ $nameTag

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

Definition at line 173 of file Entity.php.

◆ $nameTagVisible

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

Definition at line 174 of file Entity.php.

◆ $networkPropertiesDirty

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

Definition at line 171 of file Entity.php.

◆ $noClientPredictions

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

Definition at line 181 of file Entity.php.

◆ $noDamageTicks

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

Definition at line 154 of file Entity.php.

◆ $onGround

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

Definition at line 132 of file Entity.php.

◆ $ownerId

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

Definition at line 185 of file Entity.php.

◆ $scale

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

Definition at line 177 of file Entity.php.

◆ $scoreTag

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

Definition at line 176 of file Entity.php.

◆ $server

Server pocketmine\entity\Entity::$server
protectedinherited

Definition at line 163 of file Entity.php.

◆ $silent

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

Definition at line 183 of file Entity.php.

◆ $size

EntitySizeInfo pocketmine\entity\Entity::$size
inherited

Definition at line 134 of file Entity.php.

◆ $stepHeight

float pocketmine\entity\Entity::$stepHeight = 0.0
protectedinherited

Definition at line 140 of file Entity.php.

◆ $targetId

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

Definition at line 186 of file Entity.php.

◆ $ticksLived

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

Definition at line 144 of file Entity.php.

◆ $timings

TimingsHandler pocketmine\entity\Entity::$timings
protectedinherited

Definition at line 169 of file Entity.php.

◆ $ySize

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

Definition at line 139 of file Entity.php.

◆ MOTION_THRESHOLD

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

Definition at line 88 of file Entity.php.

◆ STEP_CLIP_MULTIPLIER

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

Definition at line 89 of file Entity.php.

◆ TAG_MOTION

const pocketmine\entity\Entity::TAG_MOTION = "Motion"
inherited

Definition at line 97 of file Entity.php.

◆ TAG_POS

const pocketmine\entity\Entity::TAG_POS = "Pos"
inherited

Definition at line 96 of file Entity.php.

◆ TAG_ROTATION

const pocketmine\entity\Entity::TAG_ROTATION = "Rotation"
inherited

Definition at line 98 of file Entity.php.


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