Class ItemTypeComponentCollection

Hierarchy

CompoundTag
- 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.constructor
- Defined in packages/core/src/item/identity/collection.ts:41

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`components

components: 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: null | string

The name of the nbt tag.

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Readonly`type

type: Compound = TagType.Compound

The nbt tag type of the data type.

`Static` `Readonly`[species]

"[species]": MapConstructor

Methods

[iterator]

"[iterator]"(): MapIterator<[string, BaseTag]>
Returns an iterable of entries in the map.

Returns MapIterator<[string, BaseTag]>
Inherited from CompoundTag.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

add

add<T extends BaseTag>(tag: T): T
Add a single tag to the compound tag.
Type Parameters
- T extends BaseTag
Parameters
- tag: T
  The tag to add to the compound tag.
Returns T
The tag that was added.
Inherited from CompoundTag.add
- Defined in packages/nbt/dist/index.d.ts:214

addComponent

addComponent<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:83

clear

clear(): void
Returns void
Inherited from CompoundTag.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from CompoundTag.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): MapIterator<[string, BaseTag]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[string, BaseTag]>
Inherited from CompoundTag.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

forEach(
    callbackfn: (
        value: BaseTag,
        key: string,
        map: Map<string, BaseTag>,
    ) => void,
    thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: BaseTag, key: string, map: Map<string, BaseTag>) => void
- OptionalthisArg: any
Returns void
Inherited from CompoundTag.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get<T extends BaseTag>(key: string): undefined | T
Get a nbt tag by its key.
Type Parameters
- T extends BaseTag
Parameters
- key: string
  The key of the tag to retrieve.
Returns undefined | T
The tag associated with the key, or undefined if not found.
Inherited from CompoundTag.get
- Defined in packages/nbt/dist/index.d.ts:195

getAllComponents

getAllComponents(): 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:122

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:178

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:273

getComponent

getComponent<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:54

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:419

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:470

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:234

getFood

getFood(): ItemTypeFoodComponent
Get the food component of the item type.

Returns ItemTypeFoodComponent
The food component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:553

getHandEquipped

getHandEquipped(): ItemTypeHandEquippedComponent
Get the hand equipped component of the item type.

Returns ItemTypeHandEquippedComponent
The hand equipped component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:514

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:319

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:139

getUseModifiers

getUseModifiers(): ItemTypeUseModifiersComponent
Get the use modifiers component of the item type.

Returns ItemTypeUseModifiersComponent
The use modifiers component of the item type.
- Defined in packages/core/src/item/identity/collection.ts:612

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:368

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from CompoundTag.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

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:169

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:264

hasComponent

hasComponent<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:66

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:410

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:461

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:225

hasFood

hasFood(): boolean
Check if the item type has a food component.

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

hasHandEquipped

hasHandEquipped(): boolean
Check if the item type has a hand equipped component.

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

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:310

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:130

hasUseModifiers

hasUseModifiers(): boolean
Check if the item type has a use modifiers component.

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

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:359

keys

keys(): MapIterator<string>
Returns an iterable of keys in the map

Returns MapIterator<string>
Inherited from CompoundTag.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

push

push<T extends BaseTag>(...tags: T[]): this
Add multiple tags to the compound tag.
Type Parameters
- T extends BaseTag
Parameters
- ...tags: T[]
  An array of tags to add.
Returns this
The current instance for method chaining.
Inherited from CompoundTag.push
- Defined in packages/nbt/dist/index.d.ts:208

removeComponent

removeComponent<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:105

set

set<T extends BaseTag>(key: string, value: T): this
Set a nbt tag with a specific key.
Type Parameters
- T extends BaseTag
Parameters
- key: string
  The key to associate with the tag.
- value: T
  The tag to set.
Returns this
The current instance for method chaining.
Inherited from CompoundTag.set
- Defined in packages/nbt/dist/index.d.ts:202

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:193

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:293

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:434

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:485

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:249

setFood

setFood(options?: Partial<ItemTypeFoodComponentOptions>): void
Set the food component of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeFoodComponentOptions>
  The options of the food component.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:568

setHandEquipped

setHandEquipped(value: boolean): void
Set the hand equipped component of the item type.
Parameters
- value: boolean
  The hand equipped value.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:529

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:334

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:154

setUseModifiers

setUseModifiers(options?: Partial<ItemTypeUseModifiersComponentOptions>): void
Set the use modifiers component of the item type.
Parameters
- Optionaloptions: Partial<ItemTypeUseModifiersComponentOptions>
  The options of the use modifiers component.
Returns void
- Defined in packages/core/src/item/identity/collection.ts:627

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:383

toJSON

toJSON(): Record<string, unknown>
Convert the tag to a JSON object.

Returns Record<string, unknown>
Inherited from CompoundTag.toJSON
- Defined in packages/nbt/dist/index.d.ts:189

values

values(): MapIterator<BaseTag>
Returns an iterable of values in the map

Returns MapIterator<BaseTag>
Inherited from CompoundTag.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from CompoundTag.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:25

`Static`read

read(stream: BinaryStream, options?: ReadWriteOptions): CompoundTag
Read the nbt tag from the stream.
Parameters
- stream: BinaryStream
  The binary stream to read from.
- Optionaloptions: ReadWriteOptions
  The options for reading the tag.
Returns CompoundTag
Inherited from CompoundTag.read
- Defined in packages/nbt/dist/index.d.ts:215

`Static`write

write(
    stream: BinaryStream,
    value: CompoundTag,
    options?: ReadWriteOptions,
): void
Write the nbt tag to the stream.
Parameters
- stream: BinaryStream
  The binary stream to write to.
- value: CompoundTag
  The value of the tag to write.
- Optionaloptions: ReadWriteOptions
  The options for writing the tag.
Returns void
Inherited from CompoundTag.write
- Defined in packages/nbt/dist/index.d.ts:216

Class ItemTypeComponentCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ItemTypeComponentCollection

Properties

Readonly[toStringTag]

Readonlycomponents

Protected Readonlyitem

name

Readonlysize

Returns

Readonlytype

Static Readonly[species]

Methods

[iterator]

Returns MapIterator<[string, BaseTag]>

add

Type Parameters

Parameters

Returns T

addComponent

Type Parameters

Parameters

Returns InstanceType<T>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[string, BaseTag]>

forEach

Parameters

Returns void

get

Type Parameters

Parameters

Returns undefined | T

getAllComponents

Returns ItemTypeComponent[]

getBlockPlacer

Returns ItemTypeBlockPlacerComponent

getCanDestroyInCreative

Returns boolean

getComponent

Type Parameters

Parameters

Returns InstanceType<T>

getCooldown

Returns ItemTypeCooldownComponent

getDigger

Returns ItemTypeDiggerComponent

getDisplayName

Returns string

getFood

Returns ItemTypeFoodComponent

getHandEquipped

Returns ItemTypeHandEquippedComponent

getIcon

Returns ItemTypeIconComponent

getMaxStackSize

Returns number

getUseModifiers

Returns ItemTypeUseModifiersComponent

getWearable

Returns ItemTypeWearableComponent

has

Parameters

Returns boolean

hasBlockPlacer

Returns boolean

hasCanDestroyInCreative

Returns boolean

hasComponent

`Readonly`[toStringTag]

`Readonly`components

`Protected` `Readonly`item

`Readonly`size

`Readonly`type

`Static` `Readonly`[species]