PocketMine-MP 5.11.1 git-db894e3a4a5bb9a80b3ac07ac91f58bdaf15176a
pocketmine\entity\projectile\Projectile Class Reference
+ Inheritance diagram for pocketmine\entity\projectile\Projectile:
+ Collaboration diagram for pocketmine\entity\projectile\Projectile:

Public Member Functions

 __construct (Location $location, ?Entity $shootingEntity, ?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 ()
 
 canClimb ()
 
 canClimbWalls ()
 
 canCollideWith (Entity $entity)
 
 canSaveWithChunk ()
 
 close ()
 
 despawnFrom (Player $player, bool $send=true)
 
 despawnFromAll ()
 
 extinguish ()
 
 flagForDespawn ()
 
 getAttributeMap ()
 
 getBaseDamage ()
 
 getBoundingBox ()
 
 getDirectionPlane ()
 
 getDirectionVector ()
 
 getEyeHeight ()
 
 getEyePos ()
 
 getFallDistance ()
 
 getFireTicks ()
 
 getGravity ()
 
 getHealth ()
 
 getHorizontalFacing ()
 
 getId ()
 
 getLastDamageCause ()
 
 getLocation ()
 
 getMaxHealth ()
 
 getMotion ()
 
 getNameTag ()
 
 getNetworkProperties ()
 
 getOffsetPosition (Vector3 $vector3)
 
 getOwningEntity ()
 
 getOwningEntityId ()
 
 getPosition ()
 
 getResultDamage ()
 
 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)
 
 setBaseDamage (float $damage)
 
 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 getNetworkTypeId ()
 
static nextRuntimeId ()
 

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)
 
 calculateInterceptWithBlock (Block $block, Vector3 $start, Vector3 $end)
 
 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)
 
 onHit (ProjectileHitEvent $event)
 
 onHitBlock (Block $blockHit, RayTraceResult $hitResult)
 
 onHitEntity (Entity $entityHit, RayTraceResult $hitResult)
 
 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
 
Vector3 $blockHit = null
 
array $blocksAround = null
 
bool $canClimb = false
 
bool $canClimbWalls = false
 
bool $closed = false
 
float $damage = 0.0
 
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 54 of file Projectile.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\entity\projectile\Projectile::__construct ( Location  $location,
?Entity  $shootingEntity,
?CompoundTag  $nbt = null 
)

Definition at line 64 of file Projectile.php.

Member Function Documentation

◆ __toString()

pocketmine\entity\Entity::__toString ( )
inherited

Definition at line 1697 of file Entity.php.

◆ addAttributes()

pocketmine\entity\Entity::addAttributes ( )
protectedinherited

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

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

+ Here is the caller graph for this function:

◆ applyDragBeforeGravity()

pocketmine\entity\projectile\Projectile::applyDragBeforeGravity ( )
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 144 of file Projectile.php.

◆ attack()

pocketmine\entity\projectile\Projectile::attack ( EntityDamageEvent  $source)

Reimplemented from pocketmine\entity\Entity.

Definition at line 71 of file Projectile.php.

◆ broadcastAnimation()

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

Reimplemented in pocketmine\player\Player.

Definition at line 1679 of file Entity.php.

◆ broadcastMotion()

pocketmine\entity\Entity::broadcastMotion ( )
protectedinherited

Definition at line 794 of file Entity.php.

◆ broadcastMovement()

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

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

◆ calculateInterceptWithBlock()

pocketmine\entity\projectile\Projectile::calculateInterceptWithBlock ( Block  $block,
Vector3  $start,
Vector3  $end 
)
protected

Called by move() when raytracing blocks to discover whether the block should be considered as a point of impact. This can be overridden by other projectiles to allow altering the blocks which are collided with (for example some projectiles collide with any non-air block).

Returns
RayTraceResult|null the result of the ray trace if successful, or null if no interception is found.

Definition at line 273 of file Projectile.php.

◆ canBeCollidedWith()

pocketmine\entity\projectile\Projectile::canBeCollidedWith ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 102 of file Projectile.php.

◆ canBeMovedByCurrents()

pocketmine\entity\Entity::canBeMovedByCurrents ( )
inherited

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

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

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

◆ canCollideWith()

pocketmine\entity\projectile\Projectile::canCollideWith ( Entity  $entity)

Reimplemented from pocketmine\entity\Entity.

Definition at line 98 of file Projectile.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 451 of file Entity.php.

◆ checkBlockIntersections()

pocketmine\entity\Entity::checkBlockIntersections ( )
protectedinherited

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

◆ checkObstruction()

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

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

◆ dealFireDamage()

pocketmine\entity\Entity::dealFireDamage ( )
protectedinherited

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

Definition at line 733 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 1533 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 1547 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 1612 of file Entity.php.

◆ doOnFireTick()

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

Definition at line 709 of file Entity.php.

◆ entityBaseTick()

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

Definition at line 626 of file Entity.php.

◆ extinguish()

pocketmine\entity\Entity::extinguish ( )
inherited

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

◆ getAllNetworkData()

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

Definition at line 1645 of file Entity.php.

◆ getAttributeMap()

pocketmine\entity\Entity::getAttributeMap ( )
inherited

Definition at line 618 of file Entity.php.

◆ getBaseDamage()

pocketmine\entity\projectile\Projectile::getBaseDamage ( )

Returns the base damage applied on collision. This is multiplied by the projectile's speed to give a result damage.

Definition at line 110 of file Projectile.php.

◆ getBlocksAroundWithEntityInsideActions()

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

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

◆ getBoundingBox()

pocketmine\entity\Entity::getBoundingBox ( )
inherited

Definition at line 291 of file Entity.php.

◆ getDirectionPlane()

pocketmine\entity\Entity::getDirectionPlane ( )
inherited

Definition at line 945 of file Entity.php.

◆ getDirectionVector()

pocketmine\entity\Entity::getDirectionVector ( )
inherited

Definition at line 936 of file Entity.php.

◆ getDirtyNetworkData()

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

Definition at line 1633 of file Entity.php.

◆ getEyeHeight()

pocketmine\entity\Entity::getEyeHeight ( )
inherited

Definition at line 1092 of file Entity.php.

◆ getEyePos()

pocketmine\entity\Entity::getEyePos ( )
inherited

Definition at line 1096 of file Entity.php.

◆ getFallDistance()

pocketmine\entity\Entity::getFallDistance ( )
inherited

Definition at line 1057 of file Entity.php.

◆ getFireTicks()

pocketmine\entity\Entity::getFireTicks ( )
inherited

Definition at line 683 of file Entity.php.

◆ getGravity()

pocketmine\entity\Entity::getGravity ( )
inherited

Definition at line 798 of file Entity.php.

◆ getHealth()

pocketmine\entity\Entity::getHealth ( )
inherited

Definition at line 575 of file Entity.php.

◆ getHorizontalFacing()

pocketmine\entity\Entity::getHorizontalFacing ( )
inherited

Definition at line 917 of file Entity.php.

◆ getId()

pocketmine\entity\Entity::getId ( )
inherited

Definition at line 1465 of file Entity.php.

◆ getInitialDragMultiplier()

pocketmine\entity\Entity::getInitialDragMultiplier ( )
abstractprotectedinherited

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 in pocketmine\entity\Living, pocketmine\entity\object\ExperienceOrb, pocketmine\entity\object\FallingBlock, pocketmine\entity\object\ItemEntity, pocketmine\entity\object\Painting, pocketmine\entity\object\PrimedTNT, pocketmine\entity\projectile\Arrow, and pocketmine\entity\projectile\Throwable.

◆ getInitialGravity()

◆ getLastDamageCause()

pocketmine\entity\Entity::getLastDamageCause ( )
inherited

Definition at line 614 of file Entity.php.

◆ getLocation()

pocketmine\entity\Entity::getLocation ( )
inherited

Definition at line 1326 of file Entity.php.

◆ getMaxHealth()

pocketmine\entity\Entity::getMaxHealth ( )
inherited

Definition at line 602 of file Entity.php.

◆ getMotion()

pocketmine\entity\Entity::getMotion ( )
inherited

Definition at line 1389 of file Entity.php.

◆ getNameTag()

pocketmine\entity\Entity::getNameTag ( )
inherited

Definition at line 243 of file Entity.php.

◆ getNetworkProperties()

pocketmine\entity\Entity::getNetworkProperties ( )
inherited

Definition at line 622 of file Entity.php.

◆ getOffsetPosition()

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

Definition at line 772 of file Entity.php.

◆ getOwningEntity()

pocketmine\entity\Entity::getOwningEntity ( )
inherited

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

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

◆ getPosition()

pocketmine\entity\Entity::getPosition ( )
inherited

Definition at line 1322 of file Entity.php.

◆ getResultDamage()

pocketmine\entity\projectile\Projectile::getResultDamage ( )

Returns the amount of damage this projectile will deal to the entity it hits.

Reimplemented in pocketmine\entity\projectile\Arrow, pocketmine\entity\projectile\ExperienceBottle, and pocketmine\entity\projectile\SplashPotion.

Definition at line 124 of file Projectile.php.

◆ getScale()

pocketmine\entity\Entity::getScale ( )
inherited

Definition at line 279 of file Entity.php.

◆ getScoreTag()

pocketmine\entity\Entity::getScoreTag ( )
inherited

Definition at line 270 of file Entity.php.

◆ getSize()

pocketmine\entity\Entity::getSize ( )
inherited

Definition at line 308 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 428 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 420 of file Entity.php.

◆ getViewers()

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

Definition at line 1472 of file Entity.php.

◆ getWorld()

pocketmine\entity\Entity::getWorld ( )
inherited

Definition at line 1330 of file Entity.php.

◆ hasGravity()

pocketmine\entity\Entity::hasGravity ( )
inherited

Definition at line 807 of file Entity.php.

◆ hasMovementUpdate()

pocketmine\entity\projectile\Projectile::hasMovementUpdate ( )

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

Reimplemented from pocketmine\entity\Entity.

Definition at line 159 of file Projectile.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 322 of file Entity.php.

◆ heal()

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

Definition at line 540 of file Entity.php.

◆ initEntity()

pocketmine\entity\projectile\Projectile::initEntity ( CompoundTag  $nbt)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 77 of file Projectile.php.

◆ isAlive()

pocketmine\entity\Entity::isAlive ( )
inherited

Definition at line 571 of file Entity.php.

◆ isClosed()

pocketmine\entity\Entity::isClosed ( )
inherited

Returns whether the entity has been "closed".

Definition at line 1570 of file Entity.php.

◆ isFireProof()

pocketmine\entity\Entity::isFireProof ( )
inherited

Definition at line 705 of file Entity.php.

◆ isFlaggedForDespawn()

pocketmine\entity\Entity::isFlaggedForDespawn ( )
inherited

Definition at line 1563 of file Entity.php.

◆ isInsideOfSolid()

pocketmine\entity\Entity::isInsideOfSolid ( )
inherited

Definition at line 1122 of file Entity.php.

◆ isInvisible()

pocketmine\entity\Entity::isInvisible ( )
inherited

Definition at line 339 of file Entity.php.

◆ isNameTagAlwaysVisible()

pocketmine\entity\Entity::isNameTagAlwaysVisible ( )
inherited

Definition at line 251 of file Entity.php.

◆ isNameTagVisible()

pocketmine\entity\Entity::isNameTagVisible ( )
inherited

Definition at line 247 of file Entity.php.

◆ isOnFire()

pocketmine\entity\Entity::isOnFire ( )
inherited

Definition at line 671 of file Entity.php.

◆ isOnGround()

pocketmine\entity\Entity::isOnGround ( )
inherited

Definition at line 1422 of file Entity.php.

◆ isSilent()

pocketmine\entity\Entity::isSilent ( )
inherited

Definition at line 348 of file Entity.php.

◆ isUnderwater()

pocketmine\entity\Entity::isUnderwater ( )
inherited

Definition at line 1111 of file Entity.php.

◆ kill()

pocketmine\entity\Entity::kill ( )
inherited

Definition at line 549 of file Entity.php.

◆ move()

pocketmine\entity\projectile\Projectile::move ( float  $dx,
float  $dy,
float  $dz 
)
protected

Reimplemented from pocketmine\entity\Entity.

Definition at line 163 of file Projectile.php.

◆ nextRuntimeId()

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

Returns a new runtime entity ID for a new entity.

Definition at line 101 of file Entity.php.

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

+ Here is the caller graph for this function:

◆ onCollideWithPlayer()

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

Definition at line 1100 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 560 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 567 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 1599 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 953 of file Entity.php.

◆ onHit()

pocketmine\entity\projectile\Projectile::onHit ( ProjectileHitEvent  $event)
protected

Called when the projectile hits something. Override this to perform non-target-specific effects when the projectile hits something.

Reimplemented in pocketmine\entity\projectile\Arrow, pocketmine\entity\projectile\Egg, pocketmine\entity\projectile\EnderPearl, pocketmine\entity\projectile\ExperienceBottle, pocketmine\entity\projectile\Snowball, and pocketmine\entity\projectile\SplashPotion.

Definition at line 281 of file Projectile.php.

◆ onHitBlock()

pocketmine\entity\projectile\Projectile::onHitBlock ( Block  $blockHit,
RayTraceResult  $hitResult 
)
protected

Called when the projectile collides with a Block.

Reimplemented in pocketmine\entity\projectile\Arrow, and pocketmine\entity\projectile\Throwable.

Definition at line 315 of file Projectile.php.

◆ onHitEntity()

pocketmine\entity\projectile\Projectile::onHitEntity ( Entity  $entityHit,
RayTraceResult  $hitResult 
)
protected

Called when the projectile collides with an Entity.

Reimplemented in pocketmine\entity\projectile\Arrow.

Definition at line 288 of file Projectile.php.

◆ onHitGround()

pocketmine\entity\Entity::onHitGround ( )
protectedinherited

Called when a falling entity hits the ground.

Reimplemented in pocketmine\entity\Living, and pocketmine\entity\object\FallingBlock.

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

◆ onNearbyBlockChange()

pocketmine\entity\projectile\Projectile::onNearbyBlockChange ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 148 of file Projectile.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 1030 of file Entity.php.

◆ onUpdate()

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

Definition at line 957 of file Entity.php.

◆ recalculateBoundingBox()

pocketmine\entity\Entity::recalculateBoundingBox ( )
protectedinherited

Definition at line 295 of file Entity.php.

◆ resetFallDistance()

pocketmine\entity\Entity::resetFallDistance ( )
inherited

Definition at line 1063 of file Entity.php.

◆ resetLastMovements()

pocketmine\entity\Entity::resetLastMovements ( )
protectedinherited

Definition at line 1384 of file Entity.php.

◆ respawnToAll()

pocketmine\entity\Entity::respawnToAll ( )
inherited

Definition at line 1522 of file Entity.php.

◆ saveNBT()

pocketmine\entity\projectile\Projectile::saveNBT ( )

Reimplemented from pocketmine\entity\Entity.

Definition at line 128 of file Projectile.php.

◆ scheduleUpdate()

pocketmine\entity\Entity::scheduleUpdate ( )
finalinherited

Definition at line 1014 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 1622 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 1481 of file Entity.php.

◆ setBaseDamage()

pocketmine\entity\projectile\Projectile::setBaseDamage ( float  $damage)

Sets the base amount of damage applied by the projectile.

Definition at line 117 of file Projectile.php.

◆ setCanClimb()

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

Sets whether the entity is able to climb climbable blocks.

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

◆ setFallDistance()

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

Definition at line 1059 of file Entity.php.

◆ setFireTicks()

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

InvalidArgumentException

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

◆ setGravity()

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

Definition at line 802 of file Entity.php.

◆ setHasGravity()

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

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

◆ setInvisible()

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

Definition at line 343 of file Entity.php.

◆ setLastDamageCause()

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

Definition at line 610 of file Entity.php.

◆ setMaxHealth()

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

Definition at line 606 of file Entity.php.

◆ setMotion()

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

Definition at line 1393 of file Entity.php.

◆ setNameTag()

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

Definition at line 255 of file Entity.php.

◆ setNameTagAlwaysVisible()

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

Definition at line 265 of file Entity.php.

◆ setNameTagVisible()

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

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

◆ setOnFire()

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

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

◆ setPosition()

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

Definition at line 1334 of file Entity.php.

◆ setPositionAndRotation()

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

Definition at line 1374 of file Entity.php.

◆ setRotation()

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

Definition at line 1366 of file Entity.php.

◆ setScale()

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

Definition at line 283 of file Entity.php.

◆ setScoreTag()

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

Definition at line 274 of file Entity.php.

◆ setSilent()

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

Definition at line 352 of file Entity.php.

◆ setSize()

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

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

◆ spawnTo()

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

Definition at line 1501 of file Entity.php.

◆ spawnToAll()

pocketmine\entity\Entity::spawnToAll ( )
inherited

Definition at line 1513 of file Entity.php.

◆ syncNetworkData()

pocketmine\entity\Entity::syncNetworkData ( EntityMetadataCollection  $properties)
protectedinherited

Definition at line 1653 of file Entity.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 1429 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 819 of file Entity.php.

◆ updateFallState()

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

Definition at line 1067 of file Entity.php.

◆ updateMovement()

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

Definition at line 746 of file Entity.php.

Member Data Documentation

◆ $alwaysShowNameTag

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

Definition at line 168 of file Entity.php.

◆ $attributeMap

AttributeMap pocketmine\entity\Entity::$attributeMap
protectedinherited

Definition at line 150 of file Entity.php.

◆ $blockHit

Vector3 pocketmine\entity\projectile\Projectile::$blockHit = null
protected

Definition at line 62 of file Projectile.php.

◆ $blocksAround

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

Definition at line 115 of file Entity.php.

◆ $boundingBox

AxisAlignedBB pocketmine\entity\Entity::$boundingBox
inherited

Definition at line 124 of file Entity.php.

◆ $canClimb

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

Definition at line 172 of file Entity.php.

◆ $canClimbWalls

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

Definition at line 173 of file Entity.php.

◆ $closed

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

Definition at line 158 of file Entity.php.

◆ $damage

float pocketmine\entity\projectile\Projectile::$damage = 0.0
protected

Definition at line 61 of file Projectile.php.

◆ $drag

float pocketmine\entity\Entity::$drag
protectedinherited

Definition at line 153 of file Entity.php.

◆ $fallDistance

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

Definition at line 136 of file Entity.php.

◆ $fireTicks

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

Definition at line 139 of file Entity.php.

◆ $forceMovementUpdate

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

Definition at line 121 of file Entity.php.

◆ $gravity

float pocketmine\entity\Entity::$gravity
protectedinherited

Definition at line 152 of file Entity.php.

◆ $gravityEnabled

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

Definition at line 154 of file Entity.php.

◆ $hasSpawned

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

Definition at line 106 of file Entity.php.

◆ $id

int pocketmine\entity\Entity::$id
protectedinherited

Definition at line 108 of file Entity.php.

◆ $invisible

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

Definition at line 175 of file Entity.php.

◆ $isCollided

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

Definition at line 143 of file Entity.php.

◆ $isCollidedHorizontally

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

Definition at line 144 of file Entity.php.

◆ $isCollidedVertically

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

Definition at line 145 of file Entity.php.

◆ $justCreated

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

Definition at line 148 of file Entity.php.

◆ $keepMovement

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

Definition at line 134 of file Entity.php.

◆ $lastDamageCause

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

Definition at line 112 of file Entity.php.

◆ $lastLocation

Location pocketmine\entity\Entity::$lastLocation
protectedinherited

Definition at line 118 of file Entity.php.

◆ $lastMotion

Vector3 pocketmine\entity\Entity::$lastMotion
protectedinherited

Definition at line 120 of file Entity.php.

◆ $lastUpdate

int pocketmine\entity\Entity::$lastUpdate
inherited

Definition at line 138 of file Entity.php.

◆ $location

Location pocketmine\entity\Entity::$location
protectedinherited

Definition at line 117 of file Entity.php.

◆ $motion

Vector3 pocketmine\entity\Entity::$motion
protectedinherited

Definition at line 119 of file Entity.php.

◆ $nameTag

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

Definition at line 166 of file Entity.php.

◆ $nameTagVisible

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

Definition at line 167 of file Entity.php.

◆ $networkPropertiesDirty

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

Definition at line 164 of file Entity.php.

◆ $noClientPredictions

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

Definition at line 174 of file Entity.php.

◆ $noDamageTicks

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

Definition at line 147 of file Entity.php.

◆ $onGround

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

Definition at line 125 of file Entity.php.

◆ $ownerId

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

Definition at line 178 of file Entity.php.

◆ $scale

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

Definition at line 170 of file Entity.php.

◆ $scoreTag

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

Definition at line 169 of file Entity.php.

◆ $server

Server pocketmine\entity\Entity::$server
protectedinherited

Definition at line 156 of file Entity.php.

◆ $silent

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

Definition at line 176 of file Entity.php.

◆ $size

EntitySizeInfo pocketmine\entity\Entity::$size
inherited

Definition at line 127 of file Entity.php.

◆ $stepHeight

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

Definition at line 133 of file Entity.php.

◆ $targetId

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

Definition at line 179 of file Entity.php.

◆ $ticksLived

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

Definition at line 137 of file Entity.php.

◆ $timings

TimingsHandler pocketmine\entity\Entity::$timings
protectedinherited

Definition at line 162 of file Entity.php.

◆ $ySize

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

Definition at line 132 of file Entity.php.

◆ MOTION_THRESHOLD

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

Definition at line 84 of file Entity.php.

◆ STEP_CLIP_MULTIPLIER

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

Definition at line 85 of file Entity.php.

◆ TAG_MOTION

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

Definition at line 93 of file Entity.php.

◆ TAG_POS

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

Definition at line 92 of file Entity.php.

◆ TAG_ROTATION

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

Definition at line 94 of file Entity.php.


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