nbt_parser_item

package
v1.7.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 3, 2026 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HaveSubBlockData

func HaveSubBlockData(tag map[string]any) bool

HaveSubBlockData 验证 tag 是否指向有效的子方块数据荷载。

一个特殊情况是,可能在首次解析时,目标子方块的子方块被证明 为不需要进行特殊处理,于是它的子方块数据被剔除。

但由于这个子方块对应的物品形式含有物品名称,于是在验证导入 完整性时,由于 len(tag) > 0 而尝试解析子方块,并得到一个 需要特殊处理的子方块 (而原始情况却是不需要进行处理)。

这是因为,此时的 tag 虽然不包含子方块的数据,但包含其他 NBT 字段,如这个物品的物品组件或名称数据等。于是,在尝试解析它为 子方块时,子方块会得到全零值的字段,但这不代表它是不需要被特 殊处理的情况——于是再次解析所得的产物跟原产物不等价,自环发生。

所以,HaveSubBlockData 深拷贝 tag 并移除所有可能因导入而产生 的额外的 NBT 字段,然后再检查 tag 的长度是否大于 0 并返回结果

func ParseItemNetwork

func ParseItemNetwork(itemStack protocol.ItemStack, itemName string) (item nbt_parser_interface.Item, err error)

ParseItemNetwork 解析网络传输上的物品堆栈实例 item。 itemName 是这个物品堆栈实例的名称

func ParseItemNormal

func ParseItemNormal(
	nameChecker func(name string) bool,
	nbtMap map[string]any,
) (item nbt_parser_interface.Item, canGetByCommand bool, err error)

ParseItemNormal 从 nbtMap 解析一个 NBT 物品。 nbtMap 是含有这个物品 tag 标签的父复合标签。

nameChecker 是一个可选的函数,用于检查 name 所 指示的物品名称是否可通过指令获取。如果不能,则返 回的 canGetByCommand 为假。

无论 canGetByCommand 的值是多少,如果解析没有发 生错误,则 item 不会为空。

另外,如果没有这样的 nameChecker 函数,则可以将其 简单的置为 nil

Types

type Banner struct {
	DefaultItem
	NBT BannerNBT
}

旗帜

func (*Banner) Format

func (b *Banner) Format(prefix string) string

func (*Banner) FullStableBytes

func (b *Banner) FullStableBytes() []byte

func (Banner) IsComplex

func (b Banner) IsComplex() bool

func (*Banner) NBTStableBytes

func (b *Banner) NBTStableBytes() []byte

func (*Banner) ParseNetwork

func (b *Banner) ParseNetwork(item protocol.ItemStack, itemName string) error

func (*Banner) ParseNormal

func (b *Banner) ParseNormal(nbtMap map[string]any) error

func (*Banner) TypeStableBytes

func (b *Banner) TypeStableBytes() []byte

type BannerNBT

type BannerNBT struct {
	Patterns []nbt_parser_general.BannerPattern
	Type     int32
}

BannerNBT ..

type Book

type Book struct {
	DefaultItem
	NBT BookNBT
}

成书

func (*Book) Format

func (b *Book) Format(prefix string) string

func (*Book) FullStableBytes

func (b *Book) FullStableBytes() []byte

func (*Book) IsComplex

func (b *Book) IsComplex() bool

func (*Book) NBTStableBytes

func (b *Book) NBTStableBytes() []byte

func (*Book) ParseNetwork

func (b *Book) ParseNetwork(item protocol.ItemStack, itemName string) error

func (*Book) ParseNormal

func (b *Book) ParseNormal(nbtMap map[string]any) error

func (*Book) TypeStableBytes

func (b *Book) TypeStableBytes() []byte

type BookNBT

type BookNBT struct {
	Pages  []string
	Author string
	Title  string
}

BookNBT ..

type DefaultItem

type DefaultItem struct {
	Basic       ItemBasicData
	Enhance     ItemEnhanceData
	Block       ItemBlockData
	NameChecker func(name string) bool
}

默认 NBT 物品

func (*DefaultItem) Format

func (d *DefaultItem) Format(prefix string) string

func (*DefaultItem) FullStableBytes

func (d *DefaultItem) FullStableBytes() []byte

func (DefaultItem) IsComplex

func (d DefaultItem) IsComplex() bool

func (DefaultItem) ItemCount

func (d DefaultItem) ItemCount() uint8

func (DefaultItem) ItemMetadata

func (d DefaultItem) ItemMetadata() int16

func (*DefaultItem) ItemName

func (d *DefaultItem) ItemName() string

func (*DefaultItem) NBTStableBytes

func (d *DefaultItem) NBTStableBytes() []byte

func (DefaultItem) NeedEnchOrRename

func (d DefaultItem) NeedEnchOrRename() bool

func (*DefaultItem) ParseNetwork

func (d *DefaultItem) ParseNetwork(item protocol.ItemStack, itemName string) error

func (*DefaultItem) ParseNormal

func (d *DefaultItem) ParseNormal(nbtMap map[string]any) error

func (*DefaultItem) TypeStableBytes

func (d *DefaultItem) TypeStableBytes() []byte

func (*DefaultItem) UnderlyingItem

func (d *DefaultItem) UnderlyingItem() nbt_parser_interface.Item

type ItemBasicData

type ItemBasicData struct {
	Name     string `mapstructure:"Name"`   // 物品名称
	Count    uint8  `mapstructure:"Count"`  // 物品数量
	Metadata int16  `mapstructure:"Damage"` // 物品元数据
}

ItemBasicData 是物品的基本数据

func ParseItemBasicData

func ParseItemBasicData(nbtMap map[string]any) (result ItemBasicData, err error)

func ParseItemBasicDataNetwork

func ParseItemBasicDataNetwork(item protocol.ItemStack, itemName string) (result ItemBasicData, err error)

type ItemBlockData

type ItemBlockData struct {
	// Name 是这个方块的名称
	Name string
	// States 是这个方块的方块状态
	States map[string]any
	// SubBlock 是这个方块的附加数据。
	//
	// 如果这个方块是已被支持的 NBT 方块,
	// 且已被确认是需要进行特殊处理的子方块,
	// 则 SubBlock 非空。
	//
	// 这意味着,纵使这个物品是一个带有 NBT
	// 数据的容器,但如果被判定为不需要特殊
	// 处理,则 SubBlock 仍然解析为空
	SubBlock nbt_parser_interface.Block
}

ItemBlockData 指示该物品是一个方块, 或该物品可以作为一个方块进行放置

func ParseItemBlock

func ParseItemBlock(
	nameChecker func(name string) bool,
	itemName string,
	nbtMap map[string]any,
) (result ItemBlockData, err error)

ParseItemBlock ..

func ParseItemBlockNetwork

func ParseItemBlockNetwork(itemName string, item protocol.ItemStack) (result ItemBlockData, err error)

ParseItemBlockNetwork ..

type ItemEnhanceData

type ItemEnhanceData struct {
	// 该物品的物品组件数据
	ItemComponent utils.ItemComponent
	// 该物品的显示名称。
	// 如果为空,则不存在
	DisplayName string
	// 该物品的附魔属性
	EnchList []SingleItemEnch
}

ItemEnhanceData 是物品的增强数据, 例如物品组件、显示名称和附魔属性

func ParseItemEnhance

func ParseItemEnhance(nbtMap map[string]any) (result ItemEnhanceData, err error)

ParseItemEnhance ..

func ParseItemEnhanceNetwork

func ParseItemEnhanceNetwork(item protocol.ItemStack) (result ItemEnhanceData, err error)

ParseItemEnhanceNetwork ..

type Shield

type Shield struct {
	DefaultItem
	NBT ShieldNBT
}

盾牌

func (*Shield) Format

func (s *Shield) Format(prefix string) string

func (*Shield) FullStableBytes

func (s *Shield) FullStableBytes() []byte

func (Shield) IsComplex

func (s Shield) IsComplex() bool

func (*Shield) NBTStableBytes

func (s *Shield) NBTStableBytes() []byte

func (*Shield) ParseNetwork

func (s *Shield) ParseNetwork(item protocol.ItemStack, itemName string) error

func (*Shield) ParseNormal

func (s *Shield) ParseNormal(nbtMap map[string]any) error

func (*Shield) TypeStableBytes

func (s *Shield) TypeStableBytes() []byte

type ShieldNBT

type ShieldNBT struct {
	HaveBase bool
	Base     int32
	Patterns []nbt_parser_general.BannerPattern
}

ShieldNBT ..

type SingleItemEnch

type SingleItemEnch struct {
	ID    int16 `mapstructure:"id"`  // 魔咒 ID
	Level int16 `mapstructure:"lvl"` // 魔咒等级
}

SingleItemEnch 是物品持有的单个魔咒数据

func ParseItemEnchList

func ParseItemEnchList(nbtMap map[string]any) (result []SingleItemEnch, err error)

ParseItemEnchList ..

func ParseItemEnchListNetwork

func ParseItemEnchListNetwork(item protocol.ItemStack) (result []SingleItemEnch, err error)

ParseItemEnchListNetwork ..

func (*SingleItemEnch) Marshal

func (s *SingleItemEnch) Marshal(io protocol.IO)

Marshal ..

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址