Class ItemTypeComponentCollection

Hierarchy

CompoundTag<unknown>
- ItemTypeComponentCollection

Constructors

constructor

new ItemTypeComponentCollection(item: ItemType): ItemTypeComponentCollection
Create a new item component collection.
Parameters
- item: ItemType
  The item type that the components are for.
Returns ItemTypeComponentCollection
Overrides CompoundTag<unknown>.constructor
- Defined in packages/core/src/item/identity/collection.ts:36

Properties

`Readonly`entries

entries: Map<string, ItemTypeComponent> = ...

The component definitions of the item type.

`Protected` `Readonly`item

item: ItemType

The type of item that the components are for.

name

name: string

The name of the tag.

`Readonly`type

type: TagType

The nbt tag type of the data type.

value

value: unknown

The value of the tag.

`Static` `Readonly`type

type: Compound = TagType.Compound

The nbt tag type of the data type.

Methods

add

add<T extends typeof ItemTypeComponent, A extends unknown>(
component: T,
...args: [A],
): InstanceType<T>
Adds a new component to the item type.
Type Parameters
- T extends typeof ItemTypeComponent
- A extends unknown
Parameters
- component: T
  The component to add.
- ...args: [A]
  Additional arguments for the component.
Returns InstanceType<T>
The component instance.
- Defined in packages/core/src/item/identity/collection.ts:82

addTag

addTag(tag: Tag): void
Parameters
- tag: Tag
Returns void
Inherited from CompoundTag.addTag
- Defined in packages/nbt/dist/index.d.ts:143

createByteTag

createByteTag(properties: Partial<TagProperties<number>>): ByteTag
Parameters
- properties: Partial<TagProperties<number>>
Returns ByteTag
Inherited from CompoundTag.createByteTag
- Defined in packages/nbt/dist/index.d.ts:145

createCompoundTag

createCompoundTag<T>(properties: Partial<TagProperties<T>>): CompoundTag<T>
Type Parameters
- T
Parameters
- properties: Partial<TagProperties<T>>
Returns CompoundTag<T>
Inherited from CompoundTag.createCompoundTag
- Defined in packages/nbt/dist/index.d.ts:155

createDoubleTag

createDoubleTag(properties: Partial<TagProperties<number>>): DoubleTag
Parameters
- properties: Partial<TagProperties<number>>
Returns DoubleTag
Inherited from CompoundTag.createDoubleTag
- Defined in packages/nbt/dist/index.d.ts:150

createFloatTag

createFloatTag(properties: Partial<TagProperties<number>>): FloatTag
Parameters
- properties: Partial<TagProperties<number>>
Returns FloatTag
Inherited from CompoundTag.createFloatTag
- Defined in packages/nbt/dist/index.d.ts:149

createIntTag

createIntTag(properties: Partial<TagProperties<number>>): IntTag
Parameters
- properties: Partial<TagProperties<number>>
Returns IntTag
Inherited from CompoundTag.createIntTag
- Defined in packages/nbt/dist/index.d.ts:147

createListTag

createListTag<T extends Tag<unknown>>(
properties: Partial<TagProperties<T[]>> & { listType: TagType },
): ListTag<T>
Type Parameters
- T extends Tag<unknown>
Parameters
- properties: Partial<TagProperties<T[]>> & { listType: TagType }
Returns ListTag<T>
Inherited from CompoundTag.createListTag
- Defined in packages/nbt/dist/index.d.ts:152

createLongTag

createLongTag(properties: Partial<TagProperties<bigint>>): LongTag
Parameters
- properties: Partial<TagProperties<bigint>>
Returns LongTag
Inherited from CompoundTag.createLongTag
- Defined in packages/nbt/dist/index.d.ts:148

createShortTag

createShortTag(properties: Partial<TagProperties<number>>): ShortTag
Parameters
- properties: Partial<TagProperties<number>>
Returns ShortTag
Inherited from CompoundTag.createShortTag
- Defined in packages/nbt/dist/index.d.ts:146

createStringTag

createStringTag(properties: Partial<TagProperties<string>>): StringTag
Parameters
- properties: Partial<TagProperties<string>>
Returns StringTag
Inherited from CompoundTag.createStringTag
- Defined in packages/nbt/dist/index.d.ts:151

get

get<T extends typeof ItemTypeComponent>(component: T): InstanceType<T>
Gets the component from the item type.
Type Parameters
- T extends typeof ItemTypeComponent
Parameters
- component: T
  The identifier of the component.
Returns InstanceType<T>
The component instance.
- Defined in packages/core/src/item/identity/collection.ts:49

getAll

getAll(): ItemTypeComponent[]
Get all the components of the item type.

Returns ItemTypeComponent[]
All the components of the item type.
- Defined in packages/core/src/item/identity/collection.ts:119

getBlockPlacer

getBlockPlacer(): ItemTypeBlockPlacerComponent
Get the block placer component of the item type.

Returns ItemTypeBlockPlacerComponent
The block placer component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:175

getCanDestroyInCreative

getCanDestroyInCreative(): boolean
Get whether the item type can destroy blocks in creative mode.

Returns boolean
Whether the item type can destroy blocks in creative mode.
- Defined in packages/core/src/item/identity/collection.ts:270

getCooldown

getCooldown(): ItemTypeCooldownComponent
Get the cooldown component of the item type.

Returns ItemTypeCooldownComponent
The cooldown component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:411

getDigger

getDigger(): ItemTypeDiggerComponent
Get the digger component of the item type.

Returns ItemTypeDiggerComponent
The digger component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:462

getDisplayName

getDisplayName(): string
Get the display name of the item type.

Returns string
The display name of the item type.
- Defined in packages/core/src/item/identity/collection.ts:231

getIcon

getIcon(): ItemTypeIconComponent
Get the icon of the item type.

Returns ItemTypeIconComponent
The icon of the item type.
- Defined in packages/core/src/item/identity/collection.ts:315

getMaxStackSize

getMaxStackSize(): number
Get the max stack size of the item type.

Returns number
The max stack size of the item type.
- Defined in packages/core/src/item/identity/collection.ts:136

getTag

getTag<K extends Tag<unknown>>(name: string): K
Type Parameters
- K extends Tag<unknown>
Parameters
- name: string
Returns K
Inherited from CompoundTag.getTag
- Defined in packages/nbt/dist/index.d.ts:140

getTags

getTags(): Tag<unknown>[]
Returns Tag<unknown>[]
Inherited from CompoundTag.getTags
- Defined in packages/nbt/dist/index.d.ts:141

getWearable

getWearable(): ItemTypeWearableComponent
Get the wearable component of the item type.

Returns ItemTypeWearableComponent
The wearable component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:360

has

has<T extends typeof ItemTypeComponent>(component: string | T): boolean
Checks if the item type has a component.
Type Parameters
- T extends typeof ItemTypeComponent
Parameters
- component: string | T
  The component to check.
Returns boolean
True if the item type has the component, false otherwise.
- Defined in packages/core/src/item/identity/collection.ts:65

hasBlockPlacer

hasBlockPlacer(): boolean
Check if the item type has a block placer component.

Returns boolean
Whether the item type has a block placer component.
- Defined in packages/core/src/item/identity/collection.ts:166

hasCanDestroyInCreative

hasCanDestroyInCreative(): boolean
Check if the item type has a can destroy in creative component.

Returns boolean
Whether the item type has a can destroy in creative component.
- Defined in packages/core/src/item/identity/collection.ts:261

hasCooldown

hasCooldown(): boolean
Check if the item type has a cooldown component.

Returns boolean
Whether the item type has a cooldown component.
- Defined in packages/core/src/item/identity/collection.ts:402

hasDigger

hasDigger(): boolean
Check if the item type has a digger component.

Returns boolean
Whether the item type has a digger component.
- Defined in packages/core/src/item/identity/collection.ts:453

hasDisplayName

hasDisplayName(): boolean
Check if the item type has a display name component.

Returns boolean
Whether the item type has a display name component.
- Defined in packages/core/src/item/identity/collection.ts:222

hasIcon

hasIcon(): boolean
Check if the item type has an icon component.

Returns boolean
Whether the item type has an icon component.
- Defined in packages/core/src/item/identity/collection.ts:306

hasMaxStackSize

hasMaxStackSize(): boolean
Check if the item type has a max stack size component.

Returns boolean
Whether the item type has a max stack size component.
- Defined in packages/core/src/item/identity/collection.ts:127

hasTag

hasTag(name: string): boolean
Parameters
- name: string
Returns boolean
Inherited from CompoundTag.hasTag
- Defined in packages/nbt/dist/index.d.ts:139

hasWearable

hasWearable(): boolean
Check if the item type has a wearable component.

Returns boolean
Whether the item type has a wearable component.
- Defined in packages/core/src/item/identity/collection.ts:351

remove

remove<T extends typeof ItemTypeComponent>(component: T): void
Removes a component from the item type.
Type Parameters
- T extends typeof ItemTypeComponent
Parameters
- component: T
  The component to remove.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:104

removeTag

removeTag(name: string): void
Parameters
- name: string
Returns void
Inherited from CompoundTag.removeTag
- Defined in packages/nbt/dist/index.d.ts:144

setBlockPlacer

setBlockPlacer(options?: Partial<ItemTypeBlockPlacerComponentOptions>): void
Set the block placer component of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeBlockPlacerComponentOptions>
Returns void
- Defined in packages/core/src/item/identity/collection.ts:190

setCanDestroyInCreative

setCanDestroyInCreative(value: boolean): void
Set whether the item type can destroy blocks in creative mode.
Parameters
- value: boolean
  The can destroy in creative value.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:288

setCooldown

setCooldown(options?: Partial<ItemTypeCooldownComponentOptions>): void
Set the cooldown component of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeCooldownComponentOptions>
  The options of the cooldown component.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:426

setDigger

setDigger(options?: Partial<ItemTypeDiggerComponentOptions>): void
Set the digger component of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeDiggerComponentOptions>
  The options of the digger component.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:477

setDisplayName

setDisplayName(value: string): void
Set the display name of the item type.
Parameters
- value: string
  The display name value.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:246

setIcon

setIcon(options?: Partial<ItemTypeIconComponentOptions>): void
Set the icon of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeIconComponentOptions>
Returns void
- Defined in packages/core/src/item/identity/collection.ts:330

setMaxStackSize

setMaxStackSize(value: number): void
Set the max stack size of the item type.
Parameters
- value: number
  The max stack size value.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:151

setTag

setTag(name: string, tag: Tag): void
Parameters
- name: string
- tag: Tag
Returns void
Inherited from CompoundTag.setTag
- Defined in packages/nbt/dist/index.d.ts:142

setWearable

setWearable(options?: Partial<ItemTypeWearableComponentOptions>): void
Set the wearable component of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeWearableComponentOptions>
  The options of the wearable component.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:375

toJSON

toJSON(): TagProperties<unknown> & { type: TagType }
Returns TagProperties<unknown> & { type: TagType }
Inherited from CompoundTag.toJSON
- Defined in packages/nbt/dist/index.d.ts:156

`Static`from

from<T>(buffer: Buffer, varint?: boolean): CompoundTag<T>
Type Parameters
- T
Parameters
- buffer: Buffer
- Optionalvarint: boolean
Returns CompoundTag<T>
Inherited from CompoundTag.from
- Defined in packages/nbt/dist/index.d.ts:161

`Static`read

read<T>(
    stream: BinaryStream,
    varint?: boolean,
    properties?: Partial<ReadingProperties>,
): CompoundTag<T>
Read a nbt tag from a binary stream.
Type Parameters
- T
Parameters
- stream: BinaryStream
  The binary stream to read from.
- Optionalvarint: boolean
  Whether to read the tag as a varint.
- Optionalproperties: Partial<ReadingProperties>
Returns CompoundTag<T>
Inherited from CompoundTag.read
- Defined in packages/nbt/dist/index.d.ts:159

`Protected` `Static`readString

readString(stream: BinaryStream, varint?: boolean): string
Parameters
- stream: BinaryStream
- Optionalvarint: boolean
Returns string
Inherited from CompoundTag.readString
- Defined in packages/nbt/dist/index.d.ts:66

`Static`write

write<T>(
    stream: BinaryStream,
    value: CompoundTag<T>,
    varint?: boolean,
    properties?: Partial<WritingProperties>,
): void
Write a nbt tag to a binary stream.
Type Parameters
- T
Parameters
- stream: BinaryStream
  The binary stream to write to.
- value: CompoundTag<T>
  The value of the tag.
- Optionalvarint: boolean
  Whether to write the tag as a varint.
- Optionalproperties: Partial<WritingProperties>
Returns void
Inherited from CompoundTag.write
- Defined in packages/nbt/dist/index.d.ts:160

`Protected` `Static`writeString

writeString(value: string, stream: BinaryStream, varint?: boolean): void
Parameters
- value: string
- stream: BinaryStream
- Optionalvarint: boolean
Returns void
Inherited from CompoundTag.writeString
- Defined in packages/nbt/dist/index.d.ts:67

Class ItemTypeComponentCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ItemTypeComponentCollection

Properties

Readonlyentries

Protected Readonlyitem

name

Readonlytype

value

Static Readonlytype

Methods

add

Type Parameters

Parameters

Returns InstanceType<T>

addTag

Parameters

Returns void

createByteTag

Parameters

Returns ByteTag

createCompoundTag

Type Parameters

Parameters

Returns CompoundTag<T>

createDoubleTag

Parameters

Returns DoubleTag

createFloatTag

Parameters

Returns FloatTag

createIntTag

Parameters

Returns IntTag

createListTag

Type Parameters

Parameters

Returns ListTag<T>

createLongTag

Parameters

Returns LongTag

createShortTag

Parameters

Returns ShortTag

createStringTag

Parameters

Returns StringTag

get

Type Parameters

Parameters

Returns InstanceType<T>

getAll

Returns ItemTypeComponent[]

getBlockPlacer

Returns ItemTypeBlockPlacerComponent

getCanDestroyInCreative

Returns boolean

getCooldown

Returns ItemTypeCooldownComponent

getDigger

Returns ItemTypeDiggerComponent

getDisplayName

Returns string

getIcon

Returns ItemTypeIconComponent

getMaxStackSize

Returns number

getTag

Type Parameters

Parameters

Returns K

getTags

Returns Tag<unknown>[]

`Readonly`entries

`Protected` `Readonly`item

`Readonly`type

`Static` `Readonly`type

`Static`from

`Static`read

`Protected` `Static`readString