Documentation

ExperienceOrb extends Entity

in package

• Application

Table of Contents

MAX_TARGET_DISTANCE  = 8.0

Max distance an orb will follow a player across.

MOTION_THRESHOLD  = 1.0E-5

ORB_SPLIT_SIZES  = [2477, 1237, 617, 307, 149, 73, 37, 17, 7, 3, 1]

Split sizes used for dropping experience orbs.

TAG_VALUE_PC  = "Value"

TAG_VALUE_PE  = "experience value"

STEP_CLIP_MULTIPLIER  = 0.4

$boundingBox  : AxisAlignedBB

$canCollide  : bool

$drag  : float

$fallDistance  : float

$gravity  : float

$isCollided  : bool

$isCollidedHorizontally  : bool

$isCollidedVertically  : bool

$keepMovement  : bool

$lastUpdate  : int

$noDamageTicks  : int

$onGround  : bool

$size  : EntitySizeInfo

$ticksLived  : int

$age  : int

$alwaysShowNameTag  : bool

$attributeMap  : AttributeMap

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

$canClimb  : bool

$canClimbWalls  : bool

$closed  : bool

$fireTicks  : int

$forceMovementUpdate  : bool

$gravityEnabled  : bool

$hasSpawned  : array<string|int, Player>

$id  : int

$immobile  : bool

$invisible  : bool

$isStatic  : bool

$justCreated  : bool

$lastDamageCause  : EntityDamageEvent|null

$lastLocation  : Location

$lastMotion  : Vector3

$location  : Location

$lookForTargetTime  : int

$motion  : Vector3

$nameTag  : string

$nameTagVisible  : bool

$networkPropertiesDirty  : bool

$ownerId  : int|null

$scale  : float

$scoreTag  : string

$server  : Server

$silent  : bool

$stepHeight  : float

$targetId  : int|null

$targetPlayerRuntimeId  : int|null

$timings  : TimingsHandler

$xpValue  : int

$ySize  : float

$closeInFlight  : bool

$entityCount  : int

$health  : float

$maxHealth  : int

$needsDespawn  : bool

$networkProperties  : EntityMetadataCollection

$savedWithChunk  : bool

__construct()  : mixed

__destruct()  : mixed

__toString()  : mixed

addMotion()  : void

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

attack()  : void

broadcastAnimation()  : void

broadcastSound()  : void

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

canBeCollidedWith()  : bool

canBeMovedByCurrents()  : bool

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

canClimb()  : bool

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

canClimbWalls()  : bool

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

canCollideWith()  : bool

canSaveWithChunk()  : bool

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

close()  : void

Closes the entity and frees attached references.

despawnFrom()  : void

despawnFromAll()  : void

extinguish()  : void

flagForDespawn()  : void

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

getAttributeMap()  : AttributeMap

getBoundingBox()  : AxisAlignedBB

getDirectionPlane()  : Vector2

getDirectionVector()  : Vector3

getEyeHeight()  : float

getEyePos()  : Vector3

getFallDistance()  : float

getFireTicks()  : int

getHealth()  : float

getHorizontalFacing()  : int

getId()  : int

getLastDamageCause()  : EntityDamageEvent|null

getLocation()  : Location

getMaxHealth()  : int

getMaxOrbSize()  : int

Returns the largest size of normal XP orb that will be spawned for the specified amount of XP. Used to split XP up into multiple orbs when an amount of XP is dropped.

getMotion()  : Vector3

getNameTag()  : string

getNetworkProperties()  : EntityMetadataCollection

getNetworkTypeId()  : string

getOffsetPosition()  : Vector3

getOwningEntity()  : Entity|null

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

getOwningEntityId()  : int|null

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

getPosition()  : Position

getScale()  : float

getScoreTag()  : string|null

getTargetEntity()  : Entity|null

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

getTargetEntityId()  : int|null

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

getTargetPlayer()  : Human|null

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

getWorld()  : World

getXpValue()  : int

hasGravity()  : bool

hasMovementUpdate()  : bool

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

hasTargetPlayer()  : bool

heal()  : void

isAlive()  : bool

isClosed()  : bool

Returns whether the entity has been "closed".

isFireProof()  : bool

isFlaggedForDespawn()  : bool

isImmobile()  : bool

isInsideOfSolid()  : bool

isInvisible()  : bool

isNameTagAlwaysVisible()  : bool

isNameTagVisible()  : bool

isOnFire()  : bool

isOnGround()  : bool

isSilent()  : bool

isUnderwater()  : bool

kill()  : void

nextRuntimeId()  : int

Returns a new runtime entity ID for a new entity.

onCollideWithPlayer()  : void

onInteract()  : bool

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

onNearbyBlockChange()  : void

onRandomUpdate()  : void

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

onUpdate()  : bool

resetFallDistance()  : void

respawnToAll()  : void

saveNBT()  : CompoundTag

scheduleUpdate()  : void

sendData()  : void

setCanClimb()  : void

Sets whether the entity is able to climb climbable blocks.

setCanClimbWalls()  : void

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

setCanSaveWithChunk()  : void

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

setFallDistance()  : void

setFireTicks()  : void

setForceMovementUpdate()  : void

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

setHasGravity()  : void

setHealth()  : void

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

setImmobile()  : void

setInvisible()  : void

setLastDamageCause()  : void

setMaxHealth()  : void

setMotion()  : bool

setNameTag()  : void

setNameTagAlwaysVisible()  : void

setNameTagVisible()  : void

setOnFire()  : void

setOwningEntity()  : void

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

setRotation()  : void

setScale()  : void

setScoreTag()  : void

setSilent()  : void

setTargetEntity()  : void

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

setTargetPlayer()  : void

setXpValue()  : void

spawnTo()  : void

spawnToAll()  : void

splitIntoOrbSizes()  : array<string|int, int>

Splits the specified amount of XP into an array of acceptable XP orb sizes.

teleport()  : bool

addAttributes()  : void

applyDragBeforeGravity()  : bool

broadcastMotion()  : void

broadcastMovement()  : void

checkBlockIntersections()  : void

checkGroundState()  : void

checkObstruction()  : bool

dealFireDamage()  : void

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

destroyCycles()  : void

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

doOnFireTick()  : bool

entityBaseTick()  : bool

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

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

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

getInitialSizeInfo()  : EntitySizeInfo

initEntity()  : void

move()  : void

onDeath()  : void

Override this to do actions on death.

onDeathUpdate()  : bool

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

onDispose()  : void

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

onHitGround()  : float|null

Called when a falling entity hits the ground.

recalculateBoundingBox()  : void

resetLastMovements()  : void

sendSpawnPacket()  : void

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

setPosition()  : bool

setPositionAndRotation()  : bool

syncNetworkData()  : void

tryChangeMovement()  : void

updateFallState()  : float|null

updateMovement()  : void