Package org.geysermc.geyser.entity.type

Class ItemFrameEntity

java.lang.Object

org.geysermc.geyser.entity.type.Entity

org.geysermc.geyser.entity.type.HangingEntity

org.geysermc.geyser.entity.type.ItemFrameEntity

All Implemented Interfaces:

org.geysermc.geyser.api.entity.type.GeyserEntity

public class ItemFrameEntity
extends HangingEntity

Item frames are an entity in Java but a block entity in Bedrock.

Field Summary

Fields inherited from class org.geysermc.geyser.entity.type.Entity

bedrockDefinition, customName, customNameVisible, dirtyMetadata, entityId, flags, geyserId, headYaw, javaTypeDefinition, metadata, motion, nametag, offset, onGround, passengers, pitch, position, propertyManager, scale, session, silent, uuid, valid, vehicle, yaw

Constructor Summary

Constructors

Constructor	Description
ItemFrameEntity(EntitySpawnContext context)

Method Summary

Modifier and Type	Method	Description
void	despawnEntity()	Despawns the entity
org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack	getHeldItem()	The item currently in the item frame.
static ItemFrameEntity	getItemFrameEntity(GeyserSession session, org.cloudburstmc.math.vector.Vector3i position)	Finds the Java entity ID of an item frame from its Bedrock position.
protected void	initializeMetadata()	Called on entity spawn.
InteractionResult	interact(org.geysermc.mcprotocollib.protocol.data.game.entity.player.Hand hand)	Simulates interacting with an entity.
void	setDirection(org.geysermc.mcprotocollib.protocol.data.game.entity.object.Direction direction)
void	setItemInFrame(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack,?> entityMetadata)
void	setItemRotation(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.IntEntityMetadata entityMetadata)
void	spawnEntity()
void	updateBedrockMetadata()	Sends the Bedrock metadata to the client
void	updateBlock(boolean force)	Updates the item frame as a block

Methods inherited from class org.geysermc.geyser.entity.type.HangingEntity

setDirectionMetadata

Methods inherited from class org.geysermc.geyser.entity.type.Entity

addAdditionalSpawnData, applyScale, bedrockDefinition, bedrockDefinition, bedrockPosition, bedrockRotation, definition, doesJumpDismount, getBoundingBoxHeight, getBoundingBoxWidth, getCustomBoundingBoxHeight, getCustomBoundingBoxWidth, getDirtyMetadata, getDisplayName, getEntityId, getFlag, getHeadYaw, getJavaTypeDefinition, getMaxAir, getMetadata, getMotion, getNametag, getOffset, getPassengers, getPitch, getPosition, getPropertyManager, getRiderSeatPosition, getScale, getSession, getVehicle, getYaw, geyserId, hasLeashesToDrop, interactAt, isAlive, isCustomNameVisible, isOnGround, isShaking, isSilent, isValid, javaId, moveAbsolute, moveAbsolute, moveAbsoluteRaw, moveRelative, moveRelativeRaw, offset, passengers, playEntityEvent, playEntityEvent, position, scoreVisibility, setAir, setAirSupply, setBoundingBoxHeight, setBoundingBoxWidth, setClientSideSilent, setCustomBoundingBoxHeight, setCustomBoundingBoxWidth, setCustomName, setCustomNameVisible, setDimensionsFromPose, setEntityId, setFlag, setFlags, setFlagsDirty, setFreezing, setGliding, setGravity, setHeadYaw, setInvisible, setJavaTypeDefinition, setMotion, setNameEntityData, setNametag, setNametagAlwaysShow, setOffset, setOnGround, setPassengers, setPitch, setPose, setPosition, setRiderSeatPosition, setScale, setSilent, setSneaking, setSprinting, setValid, setVehicle, setYaw, standardDisplayName, teamIdentifier, teleport, testInteraction, update, updateBedrockEntityProperties, updateHeadLookRotation, updateInteractiveTag, updateMountOffset, updateNametag, updateNametag, updatePassengerOffsets, updatePositionAndRotation, updatePropertiesBatched, updateRotation, uuid, uuid, value, vehicle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.geysermc.geyser.api.entity.type.GeyserEntity

updatePropertiesBatched, updateProperty

Constructor Details

ItemFrameEntity

public ItemFrameEntity(EntitySpawnContext context)

Method Details

initializeMetadata

protected void initializeMetadata()

Description copied from class: Entity

Called on entity spawn. Used to populate the entity metadata and flags with default values.

Overrides:

initializeMetadata in class Entity

spawnEntity

public void spawnEntity()

Overrides:

spawnEntity in class Entity

setDirection

public void setDirection(org.geysermc.mcprotocollib.protocol.data.game.entity.object.Direction direction)

Specified by:

setDirection in class HangingEntity

setItemInFrame

public void setItemInFrame(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.EntityMetadata<org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack,?> entityMetadata)

setItemRotation

public void setItemRotation(org.geysermc.mcprotocollib.protocol.data.game.entity.metadata.type.IntEntityMetadata entityMetadata)

despawnEntity

public void despawnEntity()

Description copied from class: Entity

Despawns the entity

Overrides:

despawnEntity in class Entity

updateBedrockMetadata

public void updateBedrockMetadata()

Description copied from class: Entity

Sends the Bedrock metadata to the client

Overrides:

updateBedrockMetadata in class Entity

updateBlock

public void updateBlock(boolean force)

Updates the item frame as a block

interact

public InteractionResult interact(org.geysermc.mcprotocollib.protocol.data.game.entity.player.Hand hand)

Description copied from class: Entity

Simulates interacting with an entity. The code here should mirror Java Edition code to the best of its ability, to ensure packet parity as well as functionality parity (such as sound effect responses).

Overrides:

interact in class Entity

getItemFrameEntity

public static ItemFrameEntity getItemFrameEntity(GeyserSession session,
 org.cloudburstmc.math.vector.Vector3i position)

Finds the Java entity ID of an item frame from its Bedrock position.

Parameters:

position - position of item frame in Bedrock.

session - GeyserConnection.

Returns:

Java entity ID or -1 if not found.

getHeldItem

public org.geysermc.mcprotocollib.protocol.data.game.item.ItemStack getHeldItem()

The item currently in the item frame. Used for block picking.