Package org.geysermc.geyser.item.type

Class Item

java.lang.Object

org.geysermc.geyser.item.type.Item

Direct Known Subclasses:

ArmorItem, ArrowItem, AxolotlBucketItem, BlockItem, BoatItem, CompassItem, CrossbowItem, DyeItem, ElytraItem, EnchantedBookItem, FireworkRocketItem, FireworkStarItem, FishingRodItem, GoatHornItem, MaceItem, MapItem, PlayerHeadItem, PotionItem, ShieldItem, SpawnEggItem, TieredItem, TropicalFishBucketItem, WritableBookItem, WrittenBookItem

public class Item
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Item.Builder

Constructor Summary

Constructors

Constructor	Description
Item(String javaIdentifier, Item.Builder builder)

Method Summary

Modifier and Type	Method	Description
int	attackDamage()
static Item.Builder	builder()
boolean	isValidRepairItem(Item other)
int	javaId()
String	javaIdentifier()
int	maxDamage()
int	maxStackSize()
GeyserItemStack	newItemStack(int count, org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components)
protected final @Nullable org.cloudburstmc.nbt.NbtMap	remapEnchantment(GeyserSession session, int enchantId, int level, BedrockItemBuilder builder)
void	setJavaId(int javaId)
ItemMapping	toBedrockDefinition(org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components, ItemMappings mappings)
String	toString()
void	translateComponentsToBedrock(@NonNull GeyserSession session, @NonNull org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components, @NonNull BedrockItemBuilder builder)	Takes components from Java Edition and map them into Bedrock.
void	translateNbtToJava(@NonNull org.cloudburstmc.nbt.NbtMap bedrockTag, @NonNull org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components, @NonNull ItemMapping mapping)	Takes NBT from Bedrock Edition and converts any value that Java parses differently.
org.cloudburstmc.protocol.bedrock.data.inventory.ItemData.Builder	translateToBedrock(int count, org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components, ItemMapping mapping, ItemMappings mappings)
@NonNull GeyserItemStack	translateToJava(@NonNull org.cloudburstmc.protocol.bedrock.data.inventory.ItemData itemData, @NonNull ItemMapping mapping, @NonNull ItemMappings mappings)

Methods inherited from class java.lang.Object

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

Constructor Details

Item

public Item(String javaIdentifier,
 Item.Builder builder)

Method Details

javaIdentifier

public String javaIdentifier()

javaId

public int javaId()

maxDamage

public int maxDamage()

attackDamage

public int attackDamage()

maxStackSize

public int maxStackSize()

isValidRepairItem

public boolean isValidRepairItem(Item other)

translateToBedrock

public org.cloudburstmc.protocol.bedrock.data.inventory.ItemData.Builder translateToBedrock(int count,
 org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components,
 ItemMapping mapping,
 ItemMappings mappings)

translateToJava

public @NonNull GeyserItemStack translateToJava(@NonNull org.cloudburstmc.protocol.bedrock.data.inventory.ItemData itemData,
 @NonNull ItemMapping mapping,
 @NonNull ItemMappings mappings)

toBedrockDefinition

public ItemMapping toBedrockDefinition(org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components,
 ItemMappings mappings)

translateComponentsToBedrock

public void translateComponentsToBedrock(@NonNull GeyserSession session,
 @NonNull org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components,
 @NonNull BedrockItemBuilder builder)

Takes components from Java Edition and map them into Bedrock.

translateNbtToJava

public void translateNbtToJava(@NonNull org.cloudburstmc.nbt.NbtMap bedrockTag,
 @NonNull org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components,
 @NonNull ItemMapping mapping)

Takes NBT from Bedrock Edition and converts any value that Java parses differently.
Do note that this method is, these days, only called in three places (as of 2023/~1.19):

• Extra recipe loading
• Creative menu
• Stonecutters

Therefore, if translation cannot be achieved for a certain item, it is not necessarily bad.

remapEnchantment

protected final @Nullable org.cloudburstmc.nbt.NbtMap remapEnchantment(GeyserSession session,
 int enchantId,
 int level,
 BedrockItemBuilder builder)

newItemStack

public GeyserItemStack newItemStack(int count,
 org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components)

setJavaId

public void setJavaId(int javaId)

toString

public String toString()

Overrides:

toString in class Object

builder

public static Item.Builder builder()