org.bukkit.entity

Interface ItemFrame

All Superinterfaces:

Attachable, net.kyori.adventure.audience.Audience, CommandSender, Directional, Entity, Hanging, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, ServerOperator

public interface ItemFrame
extends Hanging

Represents an Item Frame

Nested Class Summary

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

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
@NotNull ItemStack	getItem() Get the item in this frame
float	getItemDropChance() Gets the chance of the item being dropped upon this frame's destruction.
@NotNull Rotation	getRotation() Get the rotation of the frame's item
boolean	isFixed() Returns whether the item frame is "fixed" or not.
boolean	isVisible() Returns whether the item frame is be visible or not.
void	setFixed(boolean visible) Sets whether the item frame should be fixed or not.
void	setItem(@Nullable ItemStack item) Set the item in this frame
void	setItem(@Nullable ItemStack item, boolean playSound) Set the item in this frame
void	setItemDropChance(float chance) Sets the chance of the off hand item being dropped upon this frame's destruction.
void	setRotation(@NotNull Rotation rotation) Set the rotation of the frame's item
void	setVisible(boolean visible) Sets whether the item frame should be visible or not.

Methods inherited from interface org.bukkit.entity.Hanging

setFacingDirection

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.material.Attachable

getAttachedFace

Methods inherited from interface org.bukkit.material.Directional

getFacing, setFacingDirection

Method Detail

getItem

@NotNull
@NotNull ItemStack getItem()

Get the item in this frame

Returns:

a defensive copy the item in this item frame

setItem

void setItem(@Nullable
             @Nullable ItemStack item)

Set the item in this frame

Parameters:

item - the new item

setItem

void setItem(@Nullable
             @Nullable ItemStack item,
             boolean playSound)

Set the item in this frame

Parameters:

item - the new item

playSound - whether or not to play the item placement sound

getItemDropChance

float getItemDropChance()

Gets the chance of the item being dropped upon this frame's destruction.

• A drop chance of 0.0F will never drop
• A drop chance of 1.0F will always drop

Returns:

chance of the off hand item being dropped

setItemDropChance

void setItemDropChance(float chance)

Sets the chance of the off hand item being dropped upon this frame's destruction.

• A drop chance of 0.0F will never drop
• A drop chance of 1.0F will always drop

Parameters:

chance - the chance of off hand item being dropped

getRotation

@NotNull
@NotNull Rotation getRotation()

Get the rotation of the frame's item

Returns:

the direction

setRotation

void setRotation(@NotNull
                 @NotNull Rotation rotation)
          throws IllegalArgumentException

Set the rotation of the frame's item

Parameters:

rotation - the new rotation

Throws:

IllegalArgumentException - if rotation is null

isVisible

boolean isVisible()

Returns whether the item frame is be visible or not.

Returns:

whether the item frame is visible or not

setVisible

void setVisible(boolean visible)

Sets whether the item frame should be visible or not.

Parameters:

visible - whether the item frame is visible or not

isFixed

boolean isFixed()

Returns whether the item frame is "fixed" or not. When true it's not possible to destroy/move the frame (e.g. by damage, interaction, pistons, or missing supporting blocks), rotate the item or place/remove items.

Returns:

whether the item frame is fixed or not

setFixed

void setFixed(boolean visible)

Sets whether the item frame should be fixed or not. When set to true it's not possible to destroy/move the frame (e.g. by damage, interaction, pistons, or missing supporting blocks), rotate the item or place/remove items.

Parameters:

visible - whether the item frame is fixed or not