Interface ItemFrame

All Superinterfaces:

Attachable, net.kyori.adventure.audience.Audience, CommandSender, DataComponentView, Directional, Entity, Hanging, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, PersistentDataViewHolder, net.kyori.adventure.pointer.Pointered, ServerOperator, net.kyori.adventure.sound.Sound.Emitter, net.kyori.adventure.sound.Sound.Source.Provider

All Known Subinterfaces:

GlowItemFrame

public interface ItemFrame
extends Hanging

Represents an Item Frame

Since:

1.4.5

Nested Class Summary

Nested classes/interfaces inherited from interface Entity

Entity.Spigot

Method Summary

Modifier and Type	Method	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 visible or not.
void	setFixed(boolean fixed)	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 Attachable

getAttachedFace

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

clearResourcePacks, clearTitle, closeDialog, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, openBook, playSound, playSound, playSound, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, sendResourcePacks, sendTitlePart, showBossBar, showDialog, showTitle, stopSound, stopSound

Methods inherited from interface CommandSender

getName, name, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlainMessage, sendRichMessage, sendRichMessage

Methods inherited from interface DataComponentView

getData, getDataOrDefault, hasData

Methods inherited from interface Directional

getFacing, setFacingDirection

Methods inherited from interface Entity

addPassenger, addScoreboardTag, asHoverEvent, broadcastHurtAnimation, collidesAt, copy, copy, createSnapshot, eject, fromMobSpawner, getAirDrag, getAsString, getBoundingBox, getChunk, getDefaultGravity, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getGravity, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPickItemStack, getPistonMoveReaction, getPitch, getPortalCooldown, getPose, getRemovalReason, getRemoveEventCause, getScheduler, getScoreboardEntryName, getScoreboardTags, getServer, getSoundCategory, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getTrackedPlayers, getType, getUniqueId, getVehicle, getVelocity, getVisualFire, getWeapon, getWidth, getWorld, getX, getY, getYaw, getZ, hasFixedPose, hasGravity, hasNoPhysics, isCustomNameVisible, isDead, isEmpty, isFreezeTickingLocked, isFrozen, isGlowing, isInBubbleColumn, isInLava, isInPowderedSnow, isInRain, isInsideVehicle, isInvisible, isInvulnerable, isInvulnerableTo, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isInWorld, isMarkedInvulnerable, isOnGround, isPersistent, isSilent, isSneaking, isTicking, isTrackedBy, isUnderWater, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, lockFreezeTicks, lookAt, lookAt, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvisible, setInvulnerable, setLastDamageCause, setNoPhysics, setPassenger, setPersistent, setPortalCooldown, setPose, setPose, setRotation, setRotation, setSilent, setSneaking, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, setVisualFire, spawnAt, spawnAt, spigot, teamDisplayName, teleport, teleport, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync, teleportAsync, teleportAsync, wouldCollideUsing

Methods inherited from interface Hanging

setFacingDirection

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

asHoverEvent

Methods inherited from interface Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface Permissible

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

Methods inherited from interface PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Methods inherited from interface ServerOperator

isOp, setOp

Methods inherited from interface net.kyori.adventure.sound.Sound.Source.Provider

soundSource

Method Details

getItem

@NotNull
@NotNull ItemStack getItem()

Get the item in this frame

Returns:

a defensive copy the item in this item frame

Since:

1.4.5

setItem

void setItem(@Nullable
 @Nullable ItemStack item)

Set the item in this frame

Parameters:

item - the new item

Since:

1.4.5

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

Since:

1.13.1

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

Since:

1.16.4

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

Since:

1.16.4

getRotation

@NotNull
@NotNull Rotation getRotation()

Get the rotation of the frame's item

Returns:

the direction

Since:

1.4.5

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

Since:

1.4.5

isVisible

boolean isVisible()

Returns whether the item frame is visible or not.

Returns:

whether the item frame is visible or not

Since:

1.16.1

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

Since:

1.16.1

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

Since:

1.16.1

setFixed

void setFixed(boolean fixed)

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:

fixed - whether the item frame is fixed or not

Since:

1.16.1