Class ItemFrame

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

net.minecraft.world.entity.Entity

net.minecraft.world.entity.decoration.BlockAttachedEntity

net.minecraft.world.entity.decoration.HangingEntity

net.minecraft.world.entity.decoration.ItemFrame

All Implemented Interfaces:

DataComponentGetter, TypedInstance<EntityType<?>>, SyncedDataHolder, DebugValueSource, ItemOwner, SlotProvider, EntityAccess, UniquelyIdentifyable, Nameable, ScoreHolder, IAttachmentHolder, IEntityExtension

Direct Known Subclasses:

GlowItemFrame

public class ItemFrame
extends HangingEntity

Nested Class Summary

Nested classes/interfaces inherited from class Entity

Entity.Flags, Entity.MoveFunction, Entity.MovementEmission, Entity.RemovalReason

Nested classes/interfaces inherited from class AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Nested classes/interfaces inherited from interface ItemOwner

ItemOwner.OffsetFromOwner

Field Summary

Fields

Modifier and Type	Field	Description
private static final EntityDataAccessor<ItemStack>	DATA_ITEM
private static final EntityDataAccessor<Integer>	DATA_ROTATION
private static final float	DEFAULT_DROP_CHANCE
private static final boolean	DEFAULT_FIXED
private static final boolean	DEFAULT_INVISIBLE
private static final byte	DEFAULT_ROTATION
private static final float	DEPTH
private float	dropChance
private boolean	fixed
private static final float	HEIGHT
static final int	NUM_ROTATIONS
private static final float	WIDTH

Fields inherited from class BlockAttachedEntity

pos

Fields inherited from class Entity

BASE_SAFE_FALL_DISTANCE, BASE_TICKS_REQUIRED_TO_FREEZE, blocksBuilding, BOARDING_COOLDOWN, boardingCooldown, CONTENTS_SLOT_INDEX, DATA_POSE, DATA_SHARED_FLAGS_ID, DEFAULT_BB_HEIGHT, DEFAULT_BB_WIDTH, DELTA_AFFECTED_BY_BLOCKS_BELOW_0_2, DELTA_AFFECTED_BY_BLOCKS_BELOW_0_5, DELTA_AFFECTED_BY_BLOCKS_BELOW_1_0, ENTITY_COUNTER, entityData, fallDistance, firstTick, FLAG_FALL_FLYING, FLAG_GLOWING, FLAG_ONFIRE, fluidHeight, flyDist, forgeFluidTypeHeight, FREEZE_HURT_FREQUENCY, horizontalCollision, hurtMarked, invulnerableTime, isInPowderSnow, mainSupportingBlockPos, MAX_ENTITY_TAG_COUNT, MAX_MOVEMENTS_HANDELED_PER_TICK, minorHorizontalCollision, moveDist, needsSync, noPhysics, portalProcess, random, stringUUID, stuckSpeedMultiplier, TAG_AIR, TAG_CUSTOM_NAME, TAG_DATA, TAG_FALL_DISTANCE, TAG_FIRE, TAG_GLOWING, TAG_ID, TAG_INVULNERABLE, TAG_MOTION, TAG_NO_GRAVITY, TAG_ON_GROUND, TAG_PASSENGERS, TAG_PORTAL_COOLDOWN, TAG_POS, TAG_ROTATION, TAG_SILENT, TAG_UUID, tickCount, TOTAL_AIR_SUPPLY, uuid, verticalCollision, verticalCollisionBelow, wasEyeInWater, wasInPowderSnow, wasTouchingWater, xo, xOld, xRotO, yo, yOld, yRotO, zo, zOld

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Fields inherited from interface ScoreHolder

WILDCARD, WILDCARD_NAME

Constructor Summary

Constructors

Constructor	Description
ItemFrame(EntityType<? extends ItemFrame> type, Level level)
ItemFrame(EntityType<? extends ItemFrame> type, Level level, BlockPos pos, Direction direction)
ItemFrame(Level level, BlockPos pos, Direction direction)

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalSaveData(ValueOutput output)
protected AABB	calculateBoundingBox(BlockPos blockPos, Direction direction)
private static boolean	canHurtWhenFixed(DamageSource source)
private AABB	createBoundingBox(BlockPos blockPos, Direction direction, boolean hasFramedMap)
protected void	defineSynchedData(SynchedEntityData.Builder entityData)
void	dropItem(ServerLevel level, @Nullable Entity causedBy)
private void	dropItem(ServerLevel level, @Nullable Entity causedBy, boolean withFrame)
Packet<ClientGamePacketListener>	getAddEntityPacket(ServerEntity serverEntity)
SoundEvent	getAddItemSound()
int	getAnalogOutput()
SoundEvent	getBreakSound()
@Nullable MapId	getFramedMapId(ItemStack itemStack)
protected ItemStack	getFrameItemStack()
ItemStack	getItem()
ItemStack	getPickResult()
SoundEvent	getPlaceSound()
protected AABB	getPopBox()
SoundEvent	getRemoveItemSound()
SoundEvent	getRotateItemSound()
int	getRotation()
@Nullable SlotAccess	getSlot(int slot)
float	getVisualRotationYInDegrees()
boolean	hasFramedMap()
boolean	hurtClient(DamageSource source)
boolean	hurtServer(ServerLevel level, DamageSource source, float damage)
InteractionResult	interact(Player player, InteractionHand hand, Vec3 location)
void	kill(ServerLevel level)
void	move(MoverType moverType, Vec3 delta)
private void	onItemChanged(ItemStack item)
void	onSyncedDataUpdated(EntityDataAccessor<?> accessor)
void	playPlacementSound()
void	push(double xa, double ya, double za)	Adds to the current velocity of the entity, and sets invalid reference #isAirBorne to true.
protected void	readAdditionalSaveData(ValueInput input)
protected final void	recalculateBoundingBox()
void	recreateFromPacket(ClientboundAddEntityPacket packet)
private void	removeFramedMap(ItemStack itemStack)	Removes the dot representing this frame's position from the map when the item frame is broken.
protected void	setDirection(Direction direction)	Updates facing and bounding box based on it
void	setItem(ItemStack itemStack)
void	setItem(ItemStack itemStack, boolean updateNeighbours)
void	setRotation(int rotation)
private void	setRotation(int rotation, boolean updateNeighbours)
private boolean	shouldDamageDropItem(DamageSource source)
boolean	shouldRenderAtSqrDistance(double distance)	Checks if the entity is in range to render.
boolean	survives()

Methods inherited from class HangingEntity

calculateSupportBox, canCoexist, getDirection, hasLevelCollision, mirror, rotate, setDirectionRaw, spawnAtLocation

Methods inherited from class BlockAttachedEntity

getPos, ignoreExplosion, isPickable, refreshDimensions, repositionEntityAfterLoad, setPos, skipAttackInteraction, thunderHit, tick

Methods inherited from class Entity

absSnapRotationTo, absSnapTo, absSnapTo, addDeltaMovement, addPassenger, addTag, adjustSpawnLocation, animateHurt, applyComponentsFromItemStack, applyEffectsFromBlocks, applyEffectsFromBlocks, applyGravity, applyImplicitComponent, applyImplicitComponentIfPresent, applyImplicitComponents, awardKillScore, baseTick, blockPosition, broadcastToPlayer, calculateUpVector, calculateViewVector, canAddPassenger, canBeCollidedWith, canBeHitByProjectile, canCollideWith, canControlVehicle, canFreeze, canInteractWithLevel, canRide, canSimulateMovement, canSpawnSprintParticle, canSprint, canTeleport, canTrample, canUsePortal, captureDrops, captureDrops, castComponentValue, causeFallDamage, checkBelowWorld, checkDespawn, checkFallDamage, checkFallDistanceAccumulation, checkSupportingBlock, chunkPosition, clearFire, clearFreeze, clearMovementThisTick, closerThan, closerThan, collectAllColliders, collideBoundingBox, collidedWithFluid, collidedWithShapeMovingFrom, computeSpeed, considersEntityAsAlly, copyPosition, couldAcceptPassenger, countPlayerPassengers, createCommandSourceStackForNameResolution, createHoverEvent, damageSources, dampensVibrations, deflection, discard, dismountsUnderwater, dismountTo, displayFireAnimation, distanceTo, distanceToSqr, distanceToSqr, distanceToSqr, doCheckFallDamage, doWaterSplashEffect, dropAllLeashConnections, ejectPassengers, entityTags, equals, extinguishFire, fillCrashReportCategory, fireImmune, fixupDimensions, forceSetRotation, fudgePositionAfterSizeChange, gameEvent, gameEvent, get, getAirSupply, getAttachments, getAvailableSpaceBelow, getBbHeight, getBbWidth, getBlockExplosionResistance, getBlockJumpFactor, getBlockPosBelowThatAffectsMyMovement, getBlockSpeedFactor, getBlockStateOn, getBlockStateOnLegacy, getBlockX, getBlockY, getBlockZ, getBoundingBox, getCapability, getCapability, getCollisionHorizontalEscapeVector, getControlledVehicle, getControllingPassenger, getCustomName, getDefaultGravity, getDefaultPassengerAttachmentPoint, getDeltaMovement, getDimensionChangingDelay, getDimensions, getDismountLocationForPassenger, getDisplayName, getEncodeId, getEntityData, getEyeHeight, getEyeHeight, getEyeInFluidType, getEyePosition, getEyePosition, getEyeY, getFireImmuneTicks, getFirstPassenger, getFluidHeight, getFluidJumpThreshold, getFluidTypeHeight, getForward, getGravity, getHandHoldingItemAngle, getHeadLookAngle, getId, getInBlockState, getIndirectPassengers, getInputVector, getInterpolation, getKnownMovement, getKnownSpeed, getLightLevelDependentMagicValue, getLightProbePosition, getLookAngle, getLootTable, getMaxAirSupply, getMaxFallDistance, getMaxHeightFluidType, getMotionDirection, getMovementEmission, getName, getNearestViewDirection, getOnPos, getOnPos, getOnPosLegacy, getPassengerAttachmentPoint, getPassengerRidingPosition, getPassengers, getPassengersAndSelf, getPercentFrozen, getPersistentData, getPickRadius, getPistonPushReaction, getPortalCooldown, getPose, getPosition, getPositionCodec, getPreciseBodyRotation, getPrimaryStepSoundBlockPos, getQuadLeashHolderOffsets, getRandom, getRandomX, getRandomY, getRandomZ, getRelativePortalPosition, getRemainingFireTicks, getRemovalReason, getRequiresPrecisePosition, getRootVehicle, getRopeHoldPosition, getRotationVector, getScoreboardName, getSelfAndPassengers, getSharedFlag, getSoundSource, getStringUUID, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTeam, getTeamColor, getTicksFrozen, getTicksRequiredToFreeze, getType, getTypeName, getUpVector, getUUID, getVehicle, getVehicleAttachmentPoint, getViewScale, getViewVector, getViewXRot, getViewYRot, getWeaponItem, getX, getX, getXRot, getXRot, getY, getY, getYHeadRot, getYRot, getYRot, getZ, getZ, handleDamageEvent, handleEntityEvent, handleOnAboveBubbleColumn, handleOnInsideBubbleColumn, handlePortal, hasControllingPassenger, hasCustomName, hasExactlyOnePlayerPassenger, hasGlowingTag, hashCode, hasIndirectPassenger, hasMovedHorizontallyRecently, hasPassenger, hasPassenger, hasPose, hurt, hurtOrSimulate, igniteForSeconds, igniteForTicks, is, isAddedToLevel, isAffectedByBlocks, isAlive, isAlliedTo, isAlliedTo, isAlwaysTicking, isAttackable, isClientAuthoritative, isColliding, isCrouching, isCurrentlyGlowing, isCustomNameVisible, isDescending, isDiscrete, isEffectiveAi, isEyeInFluid, isFlapping, isFlyingVehicle, isFree, isFreezing, isFullyFrozen, isHorizontalCollisionMinor, isIgnoringBlockTriggers, isInClouds, isInFluidType, isInFluidType, isInLava, isInLiquid, isInShallowWater, isInterpolating, isInvisible, isInvisibleTo, isInvulnerable, isInvulnerableToBase, isInWall, isInWater, isInWaterOrRain, isLocalClientAuthoritative, isLocalInstanceAuthoritative, isNoGravity, isOnFire, isOnPortalCooldown, isOnRails, isPassenger, isPassengerOfSameVehicle, isPushable, isPushedByFluid, isRemoved, isShiftKeyDown, isSilent, isSpectator, isSprinting, isSteppingCarefully, isSupportedBy, isSuppressingBounce, isSwimming, isUnderWater, isVehicle, isVisuallyCrawling, isVisuallySwimming, killedEntity, lavaHurt, lavaIgnite, lerpHeadTo, lerpMotion, lerpPositionAndRotationStep, level, limitPistonMovement, load, lookAt, makeBoundingBox, makeBoundingBox, makeStuckInBlock, markHurt, maxUpStep, maybeBackOffFromEdge, mayInteract, moveOrInterpolateTo, moveOrInterpolateTo, moveOrInterpolateTo, moveOrInterpolateTo, moveRelative, moveTowardsClosestSpace, nextStep, notifyLeasheeRemoved, notifyLeashHolder, oldPosition, onAboveBubbleColumn, onAddedToLevel, onBelowWorld, onClientRemoval, onExplosionHit, onFlap, onGround, onInsideBlock, onInsideBubbleColumn, onPassengerTurned, onRemoval, onRemovedFromLevel, onSyncedDataUpdated, pick, placePortalTicket, playCombinationStepSounds, playEntityOnFireExtinguishedSound, playerTouch, playMuffledStepSound, playSound, playSound, playStepSound, playSwimSound, position, positionRider, positionRider, problemPath, processFlappingMovement, processPortalCooldown, propagateFallToPassengers, push, push, reapplyPosition, registerDebugValues, registryAccess, remove, removeAfterChangingDimensions, removeLatestMovementRecording, removePassenger, removeTag, removeVehicle, resetFallDistance, restoreFrom, revive, rideTick, save, saveAsPassenger, saveWithoutId, sendBubbleColumnParticles, setAirSupply, setAsInsidePortal, setBoundingBox, setComponent, setCustomName, setCustomNameVisible, setData, setDeltaMovement, setDeltaMovement, setFluidTypeHeight, setGlowingTag, setId, setInvisible, setInvulnerable, setIsInPowderSnow, setLevel, setLevelCallback, setNoGravity, setOldPos, setOldPosAndRot, setOldPosAndRot, setOldRot, setOnGround, setOnGroundWithMovement, setOnGroundWithMovement, setPortalCooldown, setPortalCooldown, setPos, setPose, setPosRaw, setRemainingFireTicks, setRemoved, setRequiresPrecisePosition, setRot, setSharedFlag, setSharedFlagOnFire, setShiftKeyDown, setSilent, setSprinting, setSwimming, setTicksFrozen, setUUID, setViewScale, setXRot, setYBodyRot, setYHeadRot, setYRot, shearOffAllLeashConnections, shouldBeSaved, shouldBlockExplode, shouldPlayLavaHurtSound, shouldRender, shouldShowName, showVehicleHealth, snapTo, snapTo, snapTo, snapTo, snapTo, spawnAtLocation, spawnAtLocation, spawnAtLocation, spawnSprintParticle, startRiding, startRiding, startSeenByPlayer, stopRiding, stopSeenByPlayer, supportQuadLeashAsHolder, syncData, syncPacketPositionCodec, teleport, teleportRelative, teleportSetPosition, teleportSetPosition, teleportSpectators, teleportTo, teleportTo, toString, touchingUnloadedChunk, trackingPosition, turn, typeHolder, unRide, unsetRemoved, updateDataBeforeSync, updateDynamicGameEventListener, updateFluidHeightAndDoCanPushEntityFluidPushing, updateFluidHeightAndDoFluidPushing, updateFluidHeightAndDoFluidPushing, updateInWaterStateAndDoFluidPushing, updateSwimming, waterSwimSound

Methods inherited from class AttachmentHolder

deserializeAttachments, getData, getExistingDataOrNull, hasAttachments, hasData, removeData, serializeAttachments

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DataComponentGetter

get, getOrDefault, getOrDefault, getTyped, has, has

Methods inherited from interface IAttachmentHolder

getData, getExistingData, getExistingData, getExistingDataOrNull, hasData, removeData, setData, syncData

Methods inherited from interface IEntityExtension

canBeRiddenUnderFluidType, canFluidExtinguish, canHydrateInFluidType, canRiderInteract, canStartSwimming, canSwimInFluidType, copyAttachmentsFrom, getClassification, getFluidFallDistanceModifier, getFluidMotionScale, getParts, getSoundFromFluidType, hasCustomOutlineRendering, isEyeInFluidType, isInFluidType, isInFluidType, isInFluidType, isMultipartEntity, isPushedByFluid, sendPairingData, shouldRiderSit

Methods inherited from interface ItemOwner

asLivingEntity

Methods inherited from interface Nameable

getPlainTextName

Methods inherited from interface ScoreHolder

getFeedbackDisplayName

Methods inherited from interface SlotProvider

getSlotsFromRange

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

DATA_ITEM

private static final EntityDataAccessor<ItemStack> DATA_ITEM

DATA_ROTATION

private static final EntityDataAccessor<Integer> DATA_ROTATION

NUM_ROTATIONS

public static final int NUM_ROTATIONS

See Also:

• Constant Field Values

DEPTH

private static final float DEPTH

See Also:

• Constant Field Values

WIDTH

private static final float WIDTH

See Also:

• Constant Field Values

HEIGHT

private static final float HEIGHT

See Also:

• Constant Field Values

DEFAULT_ROTATION

private static final byte DEFAULT_ROTATION

See Also:

• Constant Field Values

DEFAULT_DROP_CHANCE

private static final float DEFAULT_DROP_CHANCE

See Also:

• Constant Field Values

DEFAULT_INVISIBLE

private static final boolean DEFAULT_INVISIBLE

See Also:

• Constant Field Values

DEFAULT_FIXED

private static final boolean DEFAULT_FIXED

See Also:

• Constant Field Values

dropChance

private float dropChance

fixed

private boolean fixed

Constructor Details

ItemFrame

public ItemFrame(EntityType<? extends ItemFrame> type,
 Level level)

ItemFrame

public ItemFrame(Level level,
 BlockPos pos,
 Direction direction)

ItemFrame

public ItemFrame(EntityType<? extends ItemFrame> type,
 Level level,
 BlockPos pos,
 Direction direction)

Method Details

defineSynchedData

protected void defineSynchedData(SynchedEntityData.Builder entityData)

Overrides:

defineSynchedData in class HangingEntity

setDirection

protected void setDirection(Direction direction)

Updates facing and bounding box based on it

Overrides:

setDirection in class HangingEntity

recalculateBoundingBox

protected final void recalculateBoundingBox()

Overrides:

recalculateBoundingBox in class HangingEntity

calculateBoundingBox

protected AABB calculateBoundingBox(BlockPos blockPos,
 Direction direction)

Specified by:

calculateBoundingBox in class HangingEntity

getPopBox

protected AABB getPopBox()

Overrides:

getPopBox in class HangingEntity

createBoundingBox

private AABB createBoundingBox(BlockPos blockPos,
 Direction direction,
 boolean hasFramedMap)

survives

public boolean survives()

Overrides:

survives in class HangingEntity

move

public void move(MoverType moverType,
 Vec3 delta)

Overrides:

move in class BlockAttachedEntity

push

public void push(double xa,
 double ya,
 double za)

Adds to the current velocity of the entity, and sets

invalid reference

#isAirBorne

to true.

Overrides:

push in class BlockAttachedEntity

kill

public void kill(ServerLevel level)

Overrides:

kill in class Entity

shouldDamageDropItem

private boolean shouldDamageDropItem(DamageSource source)

canHurtWhenFixed

private static boolean canHurtWhenFixed(DamageSource source)

hurtClient

public boolean hurtClient(DamageSource source)

Overrides:

hurtClient in class BlockAttachedEntity

hurtServer

public boolean hurtServer(ServerLevel level,
 DamageSource source,
 float damage)

Overrides:

hurtServer in class BlockAttachedEntity

getRemoveItemSound

public SoundEvent getRemoveItemSound()

shouldRenderAtSqrDistance

public boolean shouldRenderAtSqrDistance(double distance)

Checks if the entity is in range to render.

Overrides:

shouldRenderAtSqrDistance in class Entity

dropItem

public void dropItem(ServerLevel level,
 @Nullable Entity causedBy)

Specified by:

dropItem in class BlockAttachedEntity

getBreakSound

public SoundEvent getBreakSound()

playPlacementSound

public void playPlacementSound()

Specified by:

playPlacementSound in class HangingEntity

getPlaceSound

public SoundEvent getPlaceSound()

dropItem

private void dropItem(ServerLevel level,
 @Nullable Entity causedBy,
 boolean withFrame)

removeFramedMap

private void removeFramedMap(ItemStack itemStack)

Removes the dot representing this frame's position from the map when the item frame is broken.

getItem

public ItemStack getItem()

getFramedMapId

public @Nullable MapId getFramedMapId(ItemStack itemStack)

hasFramedMap

public boolean hasFramedMap()

setItem

public void setItem(ItemStack itemStack)

setItem

public void setItem(ItemStack itemStack,
 boolean updateNeighbours)

getAddItemSound

public SoundEvent getAddItemSound()

getSlot

public @Nullable SlotAccess getSlot(int slot)

Specified by:

getSlot in interface SlotProvider

Overrides:

getSlot in class Entity

onSyncedDataUpdated

public void onSyncedDataUpdated(EntityDataAccessor<?> accessor)

Specified by:

onSyncedDataUpdated in interface SyncedDataHolder

Overrides:

onSyncedDataUpdated in class HangingEntity

onItemChanged

private void onItemChanged(ItemStack item)

getRotation

public int getRotation()

setRotation

public void setRotation(int rotation)

setRotation

private void setRotation(int rotation,
 boolean updateNeighbours)

addAdditionalSaveData

protected void addAdditionalSaveData(ValueOutput output)

Overrides:

addAdditionalSaveData in class BlockAttachedEntity

readAdditionalSaveData

protected void readAdditionalSaveData(ValueInput input)

Overrides:

readAdditionalSaveData in class BlockAttachedEntity

interact

public InteractionResult interact(Player player,
 InteractionHand hand,
 Vec3 location)

Overrides:

interact in class Entity

getRotateItemSound

public SoundEvent getRotateItemSound()

getAnalogOutput

public int getAnalogOutput()

getAddEntityPacket

public Packet<ClientGamePacketListener> getAddEntityPacket(ServerEntity serverEntity)

Overrides:

getAddEntityPacket in class Entity

recreateFromPacket

public void recreateFromPacket(ClientboundAddEntityPacket packet)

Overrides:

recreateFromPacket in class Entity

getPickResult

public ItemStack getPickResult()

Overrides:

getPickResult in class Entity

getFrameItemStack

protected ItemStack getFrameItemStack()

getVisualRotationYInDegrees

public float getVisualRotationYInDegrees()

Specified by:

getVisualRotationYInDegrees in interface ItemOwner

Overrides:

getVisualRotationYInDegrees in class Entity