Package org.geysermc.geyser.item.type

Class BannerItem

java.lang.Object

org.geysermc.geyser.item.type.Item

org.geysermc.geyser.item.type.BlockItem

org.geysermc.geyser.item.type.BannerItem

public class BannerItem
extends BlockItem

Nested Class Summary

Nested classes/interfaces inherited from class org.geysermc.geyser.item.type.Item

Item.Builder

Field Summary

Fields inherited from class org.geysermc.geyser.item.type.Item

BEDROCK_MAX_STACK_SIZE, javaIdentifier

Constructor Summary

Constructors

Constructor	Description
BannerItem(Item.Builder builder, Block block, Block... otherBlocks)

Method Summary

Modifier and Type	Method	Description
static org.cloudburstmc.nbt.NbtList<org.cloudburstmc.nbt.NbtMap>	convertBannerPattern(List<org.cloudburstmc.nbt.NbtMap> patterns)	Convert a list of patterns from Java nbt to Bedrock nbt
static org.geysermc.mcprotocollib.protocol.data.game.item.component.BannerPatternLayer	getJavaBannerPattern(GeyserSession session, org.cloudburstmc.nbt.NbtMap pattern)	Convert the Bedrock edition banner pattern nbt to Java edition
static boolean	isOminous(List<org.cloudburstmc.nbt.NbtMap> blockEntityPatterns)
static boolean	isOminous(GeyserSession session, List<org.geysermc.mcprotocollib.protocol.data.game.item.component.BannerPatternLayer> patternLayers)
void	translateComponentsToBedrock(@NonNull GeyserSession session, @NonNull org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents components, @NonNull TooltipOptions tooltip, @NonNull BedrockItemBuilder builder)	Takes components from Java Edition and map them into Bedrock.
void	translateNbtToJava(@NonNull GeyserSession session, @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.

Methods inherited from class org.geysermc.geyser.item.type.BlockItem

translationKey

Methods inherited from class org.geysermc.geyser.item.type.Item

builder, byBlock, defaultAttackDamage, defaultMaxDamage, defaultMaxStackSize, gatherComponents, getComponent, ignoreDamage, is, is, javaId, javaIdentifier, javaKey, newItemStack, registerBlock, remapEnchantment, setJavaId, toBedrockDefinition, toString, translateDyedColor, translateToBedrock, translateToJava

Methods inherited from class java.lang.Object

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

Constructor Details

BannerItem

public BannerItem(Item.Builder builder,
 Block block,
 Block... otherBlocks)

Method Details

isOminous

public static boolean isOminous(GeyserSession session,
 List<org.geysermc.mcprotocollib.protocol.data.game.item.component.BannerPatternLayer> patternLayers)

isOminous

public static boolean isOminous(List<org.cloudburstmc.nbt.NbtMap> blockEntityPatterns)

convertBannerPattern

public static org.cloudburstmc.nbt.NbtList<org.cloudburstmc.nbt.NbtMap> convertBannerPattern(List<org.cloudburstmc.nbt.NbtMap> patterns)

Convert a list of patterns from Java nbt to Bedrock nbt

Parameters:

patterns - The patterns to convert

Returns:

The new converted patterns

getJavaBannerPattern

public static org.geysermc.mcprotocollib.protocol.data.game.item.component.BannerPatternLayer getJavaBannerPattern(GeyserSession session,
 org.cloudburstmc.nbt.NbtMap pattern)

Convert the Bedrock edition banner pattern nbt to Java edition

Parameters:

pattern - Bedrock edition pattern nbt

Returns:

The Java edition format pattern layer

translateComponentsToBedrock

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

Description copied from class: Item

Takes components from Java Edition and map them into Bedrock.

Overrides:

translateComponentsToBedrock in class Item

translateNbtToJava

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

Description copied from class: Item

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.

Overrides:

translateNbtToJava in class Item