Package net.minecraft.world.entity.decoration

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, SyncedDataHolder, EntityAccess, UniquelyIdentifyable, Nameable, ScoreHolder, IAttachmentHolder, IEntityExtension

Direct Known Subclasses:

GlowItemFrame

public class ItemFrame
extends HangingEntity

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.world.entity.Entity

Entity.MoveFunction, Entity.MovementEmission, Entity.RemovalReason

Nested classes/interfaces inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

AttachmentHolder.AsField

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 net.minecraft.world.entity.decoration.HangingEntity

HANGING_ENTITY

Fields inherited from class net.minecraft.world.entity.decoration.BlockAttachedEntity

pos

Fields inherited from class net.minecraft.world.entity.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, hasImpulse, horizontalCollision, hurtMarked, invulnerableTime, isInPowderSnow, mainSupportingBlockPos, MAX_ENTITY_TAG_COUNT, MAX_MOVEMENTS_HANDELED_PER_TICK, minorHorizontalCollision, moveDist, noPhysics, portalProcess, random, stringUUID, stuckSpeedMultiplier, TAG_AIR, 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 net.neoforged.neoforge.attachment.AttachmentHolder

ATTACHMENTS_NBT_KEY

Fields inherited from interface net.minecraft.world.scores.ScoreHolder

WILDCARD, WILDCARD_NAME

Constructor Summary

Constructors

Constructor	Description
ItemFrame(EntityType<? extends ItemFrame> pEntityType, Level pLevel)
ItemFrame(EntityType<? extends ItemFrame> pEntityType, Level pLevel, BlockPos pPos, Direction pDirection)
ItemFrame(Level pLevel, BlockPos pPos, Direction pFacingDirection)

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalSaveData(ValueOutput pOutput)
protected AABB	calculateBoundingBox(BlockPos pPos, Direction pDirection)
private static boolean	canHurtWhenFixed(DamageSource pDamageSource)
protected void	defineSynchedData(SynchedEntityData.Builder pBuilder)
void	dropItem(ServerLevel pLevel, Entity pEntity)
private void	dropItem(ServerLevel pLevel, Entity pEntity, boolean pDropItem)
Packet<ClientGamePacketListener>	getAddEntityPacket(ServerEntity pEntity)
SoundEvent	getAddItemSound()
int	getAnalogOutput()
SoundEvent	getBreakSound()
MapId	getFramedMapId(ItemStack pStack)
protected ItemStack	getFrameItemStack()
ItemStack	getItem()
ItemStack	getPickResult()
SoundEvent	getPlaceSound()
SoundEvent	getRemoveItemSound()
SoundEvent	getRotateItemSound()
int	getRotation()
SlotAccess	getSlot(int pSlot)
float	getVisualRotationYInDegrees()
boolean	hasFramedMap()
boolean	hurtClient(DamageSource pDamageSource)
boolean	hurtServer(ServerLevel pLevel, DamageSource pDamageSource, float pAmount)
InteractionResult	interact(Player pPlayer, InteractionHand pHand)
void	kill(ServerLevel pLevel)
void	move(MoverType pType, Vec3 pPos)
private void	onItemChanged(ItemStack pItem)
void	onSyncedDataUpdated(EntityDataAccessor<?> pKey)
void	playPlacementSound()
void	push(double pX, double pY, double pZ)	Adds to the current velocity of the entity, and sets invalid reference #isAirBorne to true.
protected void	readAdditionalSaveData(ValueInput pInput)
protected final void	recalculateBoundingBox()
void	recreateFromPacket(ClientboundAddEntityPacket pPacket)
private void	removeFramedMap(ItemStack pStack)	Removes the dot representing this frame's position from the map when the item frame is broken.
protected void	setDirection(Direction pFacingDirection)	Updates facing and bounding box based on it
void	setItem(ItemStack p_31806_)
void	setItem(ItemStack pStack, boolean pUpdateNeighbours)
void	setRotation(int pRotation)
private void	setRotation(int pRotation, boolean pUpdateNeighbours)
private boolean	shouldDamageDropItem(DamageSource pDamageSource)
boolean	shouldRenderAtSqrDistance(double pDistance)	Checks if the entity is in range to render.
boolean	survives()

Methods inherited from class net.minecraft.world.entity.decoration.HangingEntity

calculateSupportBox, getDirection, mirror, rotate, setDirectionRaw, spawnAtLocation

Methods inherited from class net.minecraft.world.entity.decoration.BlockAttachedEntity

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

Methods inherited from class net.minecraft.world.entity.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, canRide, canSimulateMovement, canSpawnSprintParticle, canSprint, canTeleport, canTrample, canUsePortal, captureDrops, captureDrops, castComponentValue, causeFallDamage, checkBelowWorld, checkDespawn, checkFallDamage, checkFallDistanceAccumulation, checkSupportingBlock, chunkPosition, clearFire, clearFreeze, clearMovementThisTick, closerThan, closerThan, collideBoundingBox, collidedWithFluid, collidedWithShapeMovingFrom, considersEntityAsAlly, copyPosition, couldAcceptPassenger, countPlayerPassengers, createCommandSourceStackForNameResolution, createHoverEvent, damageSources, dampensVibrations, deflection, discard, dismountsUnderwater, dismountTo, displayFireAnimation, distanceTo, distanceToSqr, distanceToSqr, distanceToSqr, doCheckFallDamage, doWaterSplashEffect, dropAllLeashConnections, ejectPassengers, equals, extinguishFire, fillCrashReportCategory, fireImmune, fixupDimensions, forceSetRotation, fudgePositionAfterSizeChange, gameEvent, gameEvent, get, getAirSupply, getAttachments, 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, getId, getInBlockState, getIndirectPassengers, getInputVector, getInterpolation, getKnownMovement, 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, getServer, getSharedFlag, getSoundSource, getStringUUID, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTags, 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, hasPassenger, hasPassenger, hasPose, hurt, hurtOrSimulate, igniteForSeconds, igniteForTicks, interactAt, 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, 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, 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, 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, spawnAtLocation, spawnSprintParticle, startRiding, startRiding, startSeenByPlayer, stopRiding, stopSeenByPlayer, supportQuadLeashAsHolder, syncPacketPositionCodec, teleport, teleportRelative, teleportSetPosition, teleportSpectators, teleportTo, teleportTo, toString, touchingUnloadedChunk, trackingPosition, turn, unRide, unsetRemoved, updateDynamicGameEventListener, updateFluidHeightAndDoFluidPushing, updateFluidHeightAndDoFluidPushing, updateInWaterStateAndDoFluidPushing, updateSwimming, waterSwimSound

Methods inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.core.component.DataComponentGetter

get, getOrDefault, getOrDefault, getTyped, has, has

Methods inherited from interface net.neoforged.neoforge.attachment.IAttachmentHolder

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

Methods inherited from interface net.neoforged.neoforge.common.extensions.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 net.minecraft.world.scores.ScoreHolder

getFeedbackDisplayName

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> pEntityType,
 Level pLevel)

ItemFrame

public ItemFrame(Level pLevel,
 BlockPos pPos,
 Direction pFacingDirection)

ItemFrame

public ItemFrame(EntityType<? extends ItemFrame> pEntityType,
 Level pLevel,
 BlockPos pPos,
 Direction pDirection)

Method Details

defineSynchedData

protected void defineSynchedData(SynchedEntityData.Builder pBuilder)

Overrides:

defineSynchedData in class HangingEntity

setDirection

protected void setDirection(Direction pFacingDirection)

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 pPos,
 Direction pDirection)

Specified by:

calculateBoundingBox in class HangingEntity

survives

public boolean survives()

Overrides:

survives in class HangingEntity

move

public void move(MoverType pType,
 Vec3 pPos)

Overrides:

move in class BlockAttachedEntity

push

public void push(double pX,
 double pY,
 double pZ)

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 pLevel)

Overrides:

kill in class Entity

shouldDamageDropItem

private boolean shouldDamageDropItem(DamageSource pDamageSource)

canHurtWhenFixed

private static boolean canHurtWhenFixed(DamageSource pDamageSource)

hurtClient

public boolean hurtClient(DamageSource pDamageSource)

Overrides:

hurtClient in class BlockAttachedEntity

hurtServer

public boolean hurtServer(ServerLevel pLevel,
 DamageSource pDamageSource,
 float pAmount)

Overrides:

hurtServer in class BlockAttachedEntity

getRemoveItemSound

public SoundEvent getRemoveItemSound()

shouldRenderAtSqrDistance

public boolean shouldRenderAtSqrDistance(double pDistance)

Checks if the entity is in range to render.

Overrides:

shouldRenderAtSqrDistance in class Entity

dropItem

public void dropItem(ServerLevel pLevel,
 @Nullable
 Entity pEntity)

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 pLevel,
 @Nullable
 Entity pEntity,
 boolean pDropItem)

removeFramedMap

private void removeFramedMap(ItemStack pStack)

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

getItem

public ItemStack getItem()

getFramedMapId

@Nullable
public MapId getFramedMapId(ItemStack pStack)

hasFramedMap

public boolean hasFramedMap()

setItem

public void setItem(ItemStack p_31806_)

setItem

public void setItem(ItemStack pStack,
 boolean pUpdateNeighbours)

getAddItemSound

public SoundEvent getAddItemSound()

getSlot

public SlotAccess getSlot(int pSlot)

Overrides:

getSlot in class Entity

onSyncedDataUpdated

public void onSyncedDataUpdated(EntityDataAccessor<?> pKey)

Specified by:

onSyncedDataUpdated in interface SyncedDataHolder

Overrides:

onSyncedDataUpdated in class HangingEntity

onItemChanged

private void onItemChanged(ItemStack pItem)

getRotation

public int getRotation()

setRotation

public void setRotation(int pRotation)

setRotation

private void setRotation(int pRotation,
 boolean pUpdateNeighbours)

addAdditionalSaveData

protected void addAdditionalSaveData(ValueOutput pOutput)

Overrides:

addAdditionalSaveData in class BlockAttachedEntity

readAdditionalSaveData

protected void readAdditionalSaveData(ValueInput pInput)

Overrides:

readAdditionalSaveData in class BlockAttachedEntity

interact

public InteractionResult interact(Player pPlayer,
 InteractionHand pHand)

Overrides:

interact in class Entity

getRotateItemSound

public SoundEvent getRotateItemSound()

getAnalogOutput

public int getAnalogOutput()

getAddEntityPacket

public Packet<ClientGamePacketListener> getAddEntityPacket(ServerEntity pEntity)

Overrides:

getAddEntityPacket in class Entity

recreateFromPacket

public void recreateFromPacket(ClientboundAddEntityPacket pPacket)

Overrides:

recreateFromPacket in class Entity

getPickResult

public ItemStack getPickResult()

Overrides:

getPickResult in class Entity

getFrameItemStack

protected ItemStack getFrameItemStack()

getVisualRotationYInDegrees

public float getVisualRotationYInDegrees()

Overrides:

getVisualRotationYInDegrees in class Entity