Documentation

Arrow extends Projectile

in package

• Application

Table of Contents

MOTION_THRESHOLD  = 1.0E-5

PICKUP_ANY  = 1

PICKUP_CREATIVE  = 2

PICKUP_NONE  = 0

TAG_CRIT  = "crit"

STEP_CLIP_MULTIPLIER  = 0.4

TAG_PICKUP  = "pickup"

$boundingBox  : AxisAlignedBB

$canCollide  : bool

$fallDistance  : float

$isCollided  : bool

$isCollidedHorizontally  : bool

$isCollidedVertically  : bool

$keepMovement  : bool

$lastUpdate  : int

$noDamageTicks  : int

$onGround  : bool

$size  : EntitySizeInfo

$ticksLived  : int

$alwaysShowNameTag  : bool

$attributeMap  : AttributeMap

$blockHit  : Block|null

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

$canClimb  : bool

$canClimbWalls  : bool

$closed  : bool

$collideTicks  : int

$critical  : bool

$damage  : float

$drag  : mixed

$fireTicks  : int

$forceMovementUpdate  : bool

$gravity  : mixed

$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

$motion  : Vector3

$nameTag  : string

$nameTagVisible  : bool

$networkPropertiesDirty  : bool

$ownerId  : int|null

$pickupMode  : int

$punchKnockback  : float

$scale  : float

$scoreTag  : string

$server  : Server

$silent  : bool

$stepHeight  : float

$targetId  : int|null

$timings  : TimingsHandler

$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

getBaseDamage()  : float

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

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

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.

getPickupMode()  : int

getPosition()  : Position

getPunchKnockback()  : float

getResultDamage()  : int

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

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.

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

getWorld()  : World

hasGravity()  : bool

hasMovementUpdate()  : bool

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

heal()  : void

isAlive()  : bool

isClosed()  : bool

Returns whether the entity has been "closed".

isCritical()  : bool

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

setBaseDamage()  : void

Sets the base amount of damage applied by the projectile.

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.

setCritical()  : void

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.

setPickupMode()  : void

setPunchKnockback()  : void

setRotation()  : void

setScale()  : void

setScoreTag()  : void

setSilent()  : void

setTargetEntity()  : void

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

spawnTo()  : void

spawnToAll()  : void

teleport()  : bool

addAttributes()  : void

applyDragBeforeGravity()  : bool

broadcastMotion()  : void

broadcastMovement()  : void

calculateInterceptWithBlock()  : RayTraceResult|null

Called by move() when raytracing blocks to discover whether the block should be considered as a point of impact.

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.

onHit()  : void

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

onHitBlock()  : void

Called when the projectile collides with a Block.

onHitEntity()  : void

Called when the projectile collides with an Entity.

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