org.bukkit.entity

Interface ArmorStand

All Superinterfaces:

Attributable, net.kyori.adventure.audience.Audience, CommandSender, Damageable, Entity, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, LivingEntity, Metadatable, Nameable, Permissible, PersistentDataHolder, ProjectileSource, ServerOperator

public interface ArmorStand
extends LivingEntity

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArmorStand.LockType Represents types of locking mechanisms for ArmorStand equipment.

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
void	addDisabledSlots(EquipmentSlot... slots) Disable specific slots, adding them to the currently disabled slots This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) Note: Once a slot is disabled, the only way to get an item back it to break the armor stand.
void	addEquipmentLock(@NotNull EquipmentSlot slot, @NotNull ArmorStand.LockType lockType) Locks the equipment slot with the specified locking mechanism.
boolean	canMove() Tests if this armor stand can move.
boolean	canTick() Tests if this armor stand can tick.
@NotNull EulerAngle	getBodyPose() Returns the armor stand's body's current pose as a EulerAngle.
@NotNull ItemStack	getBoots() Deprecated. prefer EntityEquipment.getBoots()
@NotNull ItemStack	getChestplate() Deprecated. prefer EntityEquipment.getChestplate()
Set<EquipmentSlot>	getDisabledSlots() Get the list of disabled slots
@NotNull EulerAngle	getHeadPose() Returns the armor stand's head's current pose as a EulerAngle.
@NotNull ItemStack	getHelmet() Deprecated. prefer EntityEquipment.getHelmet()
@NotNull ItemStack	getItem(EquipmentSlot slot) Returns the item the armor stand has equip in the given equipment slot
@NotNull ItemStack	getItemInHand() Deprecated. prefer getItem(EquipmentSlot) // Paper
@NotNull EulerAngle	getLeftArmPose() Returns the armor stand's left arm's current pose as a EulerAngle.
@NotNull EulerAngle	getLeftLegPose() Returns the armor stand's left leg's current pose as a EulerAngle.
@NotNull ItemStack	getLeggings() Deprecated. prefer EntityEquipment.getLeggings()
@NotNull EulerAngle	getRightArmPose() Returns the armor stand's right arm's current pose as a EulerAngle.
@NotNull EulerAngle	getRightLegPose() Returns the armor stand's right leg's current pose as a EulerAngle.
boolean	hasArms() Returns whether this armor stand has arms.
boolean	hasBasePlate() Returns whether the armor stand has a base plate.
boolean	hasEquipmentLock(@NotNull EquipmentSlot slot, @NotNull ArmorStand.LockType lockType) Returns if the ArmorStand has the specified locking mechanism.
boolean	isMarker() Returns whether this armor stand is a marker, meaning it has a very small collision box.
boolean	isSlotDisabled(EquipmentSlot slot) Check if a specific slot is disabled
boolean	isSmall() Returns whether this armor stand is scaled down.
boolean	isVisible() Returns whether the armor stand should be visible or not.
void	removeDisabledSlots(EquipmentSlot... slots) Remove the given slots from the disabled slots list, enabling them.
void	removeEquipmentLock(@NotNull EquipmentSlot slot, @NotNull ArmorStand.LockType lockType) Remove a locking mechanism.
void	setArms(boolean arms) Sets whether this armor stand has arms.
void	setBasePlate(boolean basePlate) Sets whether the armor stand has a base plate.
void	setBodyPose(@NotNull EulerAngle pose) Sets the armor stand's body's current pose as a EulerAngle.
void	setBoots(@Nullable ItemStack item) Deprecated. prefer EntityEquipment.setBoots(org.bukkit.inventory.ItemStack)
void	setCanMove(boolean move) Sets if this armor stand can move.
void	setCanTick(boolean tick) Sets if this armor stand can tick.
void	setChestplate(@Nullable ItemStack item) Deprecated. prefer EntityEquipment.setChestplate(org.bukkit.inventory.ItemStack)
void	setDisabledSlots(EquipmentSlot... slots) Set the disabled slots This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) Note: Once a slot is disabled, the only way to get an item back it to break the armor stand.
void	setHeadPose(@NotNull EulerAngle pose) Sets the armor stand's head's current pose as a EulerAngle.
void	setHelmet(@Nullable ItemStack item) Deprecated. prefer EntityEquipment.setHelmet(org.bukkit.inventory.ItemStack)
void	setItem(EquipmentSlot slot, @Nullable ItemStack item) Sets the item the armor stand has equip in the given equipment slot
void	setItemInHand(@Nullable ItemStack item) Deprecated. prefer setItem(EquipmentSlot, ItemStack) // Paper
void	setLeftArmPose(@NotNull EulerAngle pose) Sets the armor stand's left arm's current pose as a EulerAngle.
void	setLeftLegPose(@NotNull EulerAngle pose) Sets the armor stand's left leg's current pose as a EulerAngle.
void	setLeggings(@Nullable ItemStack item) Deprecated. prefer EntityEquipment.setLeggings(org.bukkit.inventory.ItemStack)
void	setMarker(boolean marker) Sets whether this armor stand is a marker, meaning it has a very small collision box.
void	setRightArmPose(@NotNull EulerAngle pose) Sets the armor stand's right arm's current pose as a EulerAngle.
void	setRightLegPose(@NotNull EulerAngle pose) Sets the armor stand's right leg's current pose as a EulerAngle.
void	setSmall(boolean small) Sets whether this armor stand is scaled down.
void	setVisible(boolean visible) Sets whether the armor stand should be visible or not.

Methods inherited from interface org.bukkit.entity.LivingEntity

addPotionEffect, addPotionEffect, addPotionEffects, attack, clearActiveItem, getActiveItem, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getArrowsStuck, getCanPickupItems, getCategory, getCollidableExemptions, getEquipment, getEyeHeight, getEyeHeight, getEyeLocation, getHandRaisedTime, getHurtDirection, getItemUseRemainingTime, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getShieldBlockingDelay, getTargetBlock, getTargetBlock, getTargetBlock, getTargetBlockExact, getTargetBlockExact, getTargetBlockFace, getTargetBlockFace, getTargetBlockInfo, getTargetBlockInfo, getTargetEntity, getTargetEntity, getTargetEntityInfo, getTargetEntityInfo, hasAI, hasLineOfSight, hasPotionEffect, isCollidable, isGliding, isHandRaised, isInvisible, isJumping, isLeashed, isRiptiding, isSleeping, isSwimming, playAnimation, playPickupItemAnimation, playPickupItemAnimation, rayTraceBlocks, rayTraceBlocks, removePotionEffect, setAI, setArrowCooldown, setArrowsInBody, setArrowsStuck, setCanPickupItems, setCollidable, setGliding, setHurtDirection, setInvisible, setJumping, setKiller, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setShieldBlockingDelay, setSwimming, swingMainHand, swingOffHand

Methods inherited from interface org.bukkit.attribute.Attributable

getAttribute, registerAttribute

Methods inherited from interface org.bukkit.entity.Damageable

damage, damage, damage, damage, getAbsorptionAmount, getHealth, getMaxHealth, resetMaxHealth, setAbsorptionAmount, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInBubbleColumn, isInLava, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isTicking, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, spigot, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface net.kyori.adventure.audience.Audience

audience, audience, clearTitle, empty, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound, toAudience

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, unbox

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

launchProjectile, launchProjectile

Method Detail

getItemInHand

@NotNull
 @Deprecated
@NotNull ItemStack getItemInHand()

Deprecated. prefer getItem(EquipmentSlot) // Paper

Returns the item the armor stand is currently holding.

Returns:

the held item

See Also:

LivingEntity.getEquipment()

setItemInHand

@Deprecated
void setItemInHand(@Nullable
                               @Nullable ItemStack item)

Deprecated. prefer setItem(EquipmentSlot, ItemStack) // Paper

Sets the item the armor stand is currently holding.

Parameters:

item - the item to hold

See Also:

LivingEntity.getEquipment()

getBoots

@NotNull
 @Deprecated
@NotNull ItemStack getBoots()

Deprecated. prefer EntityEquipment.getBoots()

Returns the item currently being worn by the armor stand on its feet.

Returns:

the worn item

See Also:

LivingEntity.getEquipment()

setBoots

@Deprecated
void setBoots(@Nullable
                          @Nullable ItemStack item)

Deprecated. prefer EntityEquipment.setBoots(org.bukkit.inventory.ItemStack)

Sets the item currently being worn by the armor stand on its feet.

Parameters:

item - the item to wear

See Also:

LivingEntity.getEquipment()

getLeggings

@NotNull
 @Deprecated
@NotNull ItemStack getLeggings()

Deprecated. prefer EntityEquipment.getLeggings()

Returns the item currently being worn by the armor stand on its legs.

Returns:

the worn item

See Also:

LivingEntity.getEquipment()

setLeggings

@Deprecated
void setLeggings(@Nullable
                             @Nullable ItemStack item)

Deprecated. prefer EntityEquipment.setLeggings(org.bukkit.inventory.ItemStack)

Sets the item currently being worn by the armor stand on its legs.

Parameters:

item - the item to wear

See Also:

LivingEntity.getEquipment()

getChestplate

@NotNull
 @Deprecated
@NotNull ItemStack getChestplate()

Deprecated. prefer EntityEquipment.getChestplate()

Returns the item currently being worn by the armor stand on its chest.

Returns:

the worn item

See Also:

LivingEntity.getEquipment()

setChestplate

@Deprecated
void setChestplate(@Nullable
                               @Nullable ItemStack item)

Deprecated. prefer EntityEquipment.setChestplate(org.bukkit.inventory.ItemStack)

Sets the item currently being worn by the armor stand on its chest.

Parameters:

item - the item to wear

See Also:

LivingEntity.getEquipment()

getHelmet

@NotNull
 @Deprecated
@NotNull ItemStack getHelmet()

Deprecated. prefer EntityEquipment.getHelmet()

Returns the item currently being worn by the armor stand on its head.

Returns:

the worn item

See Also:

LivingEntity.getEquipment()

setHelmet

@Deprecated
void setHelmet(@Nullable
                           @Nullable ItemStack item)

Deprecated. prefer EntityEquipment.setHelmet(org.bukkit.inventory.ItemStack)

Sets the item currently being worn by the armor stand on its head.

Parameters:

item - the item to wear

See Also:

LivingEntity.getEquipment()

getBodyPose

@NotNull
@NotNull EulerAngle getBodyPose()

Returns the armor stand's body's current pose as a EulerAngle.

Returns:

the current pose

setBodyPose

void setBodyPose(@NotNull
                 @NotNull EulerAngle pose)

Sets the armor stand's body's current pose as a EulerAngle.

Parameters:

pose - the current pose

getLeftArmPose

@NotNull
@NotNull EulerAngle getLeftArmPose()

Returns the armor stand's left arm's current pose as a EulerAngle.

Returns:

the current pose

setLeftArmPose

void setLeftArmPose(@NotNull
                    @NotNull EulerAngle pose)

Sets the armor stand's left arm's current pose as a EulerAngle.

Parameters:

pose - the current pose

getRightArmPose

@NotNull
@NotNull EulerAngle getRightArmPose()

Returns the armor stand's right arm's current pose as a EulerAngle.

Returns:

the current pose

setRightArmPose

void setRightArmPose(@NotNull
                     @NotNull EulerAngle pose)

Sets the armor stand's right arm's current pose as a EulerAngle.

Parameters:

pose - the current pose

getLeftLegPose

@NotNull
@NotNull EulerAngle getLeftLegPose()

Returns the armor stand's left leg's current pose as a EulerAngle.

Returns:

the current pose

setLeftLegPose

void setLeftLegPose(@NotNull
                    @NotNull EulerAngle pose)

Sets the armor stand's left leg's current pose as a EulerAngle.

Parameters:

pose - the current pose

getRightLegPose

@NotNull
@NotNull EulerAngle getRightLegPose()

Returns the armor stand's right leg's current pose as a EulerAngle.

Returns:

the current pose

setRightLegPose

void setRightLegPose(@NotNull
                     @NotNull EulerAngle pose)

Sets the armor stand's right leg's current pose as a EulerAngle.

Parameters:

pose - the current pose

getHeadPose

@NotNull
@NotNull EulerAngle getHeadPose()

Returns the armor stand's head's current pose as a EulerAngle.

Returns:

the current pose

setHeadPose

void setHeadPose(@NotNull
                 @NotNull EulerAngle pose)

Sets the armor stand's head's current pose as a EulerAngle.

Parameters:

pose - the current pose

hasBasePlate

boolean hasBasePlate()

Returns whether the armor stand has a base plate.

Returns:

whether it has a base plate

setBasePlate

void setBasePlate(boolean basePlate)

Sets whether the armor stand has a base plate.

Parameters:

basePlate - whether is has a base plate

isVisible

boolean isVisible()

Returns whether the armor stand should be visible or not.

Returns:

whether the stand is visible or not

setVisible

void setVisible(boolean visible)

Sets whether the armor stand should be visible or not.

Parameters:

visible - whether the stand is visible or not

hasArms

boolean hasArms()

Returns whether this armor stand has arms.

Returns:

whether this has arms or not

setArms

void setArms(boolean arms)

Sets whether this armor stand has arms.

Parameters:

arms - whether this has arms or not

isSmall

boolean isSmall()

Returns whether this armor stand is scaled down.

Returns:

whether this is scaled down

setSmall

void setSmall(boolean small)

Sets whether this armor stand is scaled down.

Parameters:

small - whether this is scaled down

isMarker

boolean isMarker()

Returns whether this armor stand is a marker, meaning it has a very small collision box.

Returns:

whether this is a marker

setMarker

void setMarker(boolean marker)

Sets whether this armor stand is a marker, meaning it has a very small collision box.

Parameters:

marker - whether this is a marker

addEquipmentLock

void addEquipmentLock(@NotNull
                      @NotNull EquipmentSlot slot,
                      @NotNull
                      @NotNull ArmorStand.LockType lockType)

Locks the equipment slot with the specified locking mechanism.

Parameters:

slot - the equipment slot to lock

lockType - the LockType to lock the equipment slot with

removeEquipmentLock

void removeEquipmentLock(@NotNull
                         @NotNull EquipmentSlot slot,
                         @NotNull
                         @NotNull ArmorStand.LockType lockType)

Remove a locking mechanism.

Parameters:

slot - the equipment slot to change

lockType - the LockType to remove

hasEquipmentLock

boolean hasEquipmentLock(@NotNull
                         @NotNull EquipmentSlot slot,
                         @NotNull
                         @NotNull ArmorStand.LockType lockType)

Returns if the ArmorStand has the specified locking mechanism.

Parameters:

slot - the EquipmentSlot to test

lockType - the LockType to test

Returns:

if the ArmorStand has been locked with the parameters specified

canMove

boolean canMove()

Tests if this armor stand can move.

The default value is true.

Returns:

true if this armour stand can move, false otherwise

setCanMove

void setCanMove(boolean move)

Sets if this armor stand can move.

Parameters:

move - true if this armour stand can move, false otherwise

canTick

boolean canTick()

Tests if this armor stand can tick.

The default value is defined in paper.yml.

Returns:

true if this armour stand can tick, false otherwise

setCanTick

void setCanTick(boolean tick)

Sets if this armor stand can tick.

Parameters:

tick - true if this armour stand can tick, false otherwise

getItem

@NotNull
@NotNull ItemStack getItem(@NotNull
                                    EquipmentSlot slot)

Returns the item the armor stand has equip in the given equipment slot

Parameters:

slot - the equipment slot to get

Returns:

the ItemStack in the equipment slot

setItem

void setItem(@NotNull
             EquipmentSlot slot,
             @Nullable
             @Nullable ItemStack item)

Sets the item the armor stand has equip in the given equipment slot

Parameters:

slot - the equipment slot to set

item - the item to hold

getDisabledSlots

@NotNull
Set<EquipmentSlot> getDisabledSlots()

Get the list of disabled slots

Returns:

list of disabled slots

setDisabledSlots

void setDisabledSlots(@NotNull
                      EquipmentSlot... slots)

Set the disabled slots This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) Note: Once a slot is disabled, the only way to get an item back it to break the armor stand.

Parameters:

slots - var-arg array of slots to lock

addDisabledSlots

void addDisabledSlots(@NotNull
                      EquipmentSlot... slots)

Disable specific slots, adding them to the currently disabled slots This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) Note: Once a slot is disabled, the only way to get an item back it to break the armor stand.

Parameters:

slots - var-arg array of slots to lock

removeDisabledSlots

void removeDisabledSlots(@NotNull
                         EquipmentSlot... slots)

Remove the given slots from the disabled slots list, enabling them. This makes it so a player is able to interact with the Armor Stand to place, remove, or replace an item in the given slot(s)

Parameters:

slots - var-arg array of slots to unlock

isSlotDisabled

boolean isSlotDisabled(@NotNull
                       EquipmentSlot slot)

Check if a specific slot is disabled

Parameters:

slot - The slot to check

Returns:

true if the slot is disabled, else false.