Class ItemStackInstanceStorage

Hierarchy

CompoundTag
- ItemStackInstanceStorage

Index

Constructors

constructor

new ItemStackInstanceStorage(
itemStack: ItemStack,
source?: CompoundTag,
): ItemStackInstanceStorage
Create a new item stack instance storage.
Parameters
- itemStack: ItemStack
  The item stack to create the storage for.
- Optionalsource: CompoundTag
  The source compound tag to copy data from.
Returns ItemStackInstanceStorage
Overrides CompoundTag.constructor
- Defined in packages/core/src/item/instance-storage.ts:16

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

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 tag to the storage.
Type Parameters
- T extends BaseTag
Parameters
- tag: T
  The tag to add.
Returns T
The added tag.
Overrides CompoundTag.add
- Defined in packages/core/src/item/instance-storage.ts:64

clear

clear(): void
Clear all tags from the storage.

Returns void
Overrides CompoundTag.clear
- Defined in packages/core/src/item/instance-storage.ts:94

delete

delete(key: string): boolean
Delete a tag from the storage.
Parameters
- key: string
  The key of the tag to delete.
Returns boolean
True if the tag was deleted, false otherwise.
Overrides CompoundTag.delete
- Defined in packages/core/src/item/instance-storage.ts:80

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

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

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
Push tags to the storage.
Type Parameters
- T extends BaseTag
Parameters
- ...tags: T[]
  The tags to push.
Returns this
The instance storage itself for chaining.
Overrides CompoundTag.push
- Defined in packages/core/src/item/instance-storage.ts:48

set

set<T extends BaseTag>(key: string, value: T): this
Set a tag in the storage.
Type Parameters
- T extends BaseTag
Parameters
- key: string
  The key of the tag to set.
- value: T
  The value of the tag to set.
Returns this
The instance storage itself for chaining.
Overrides CompoundTag.set
- Defined in packages/core/src/item/instance-storage.ts:32

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

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

`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:213

Class ItemStackInstanceStorage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ItemStackInstanceStorage

Properties

Readonly[toStringTag]

name

Readonlysize

Returns

Readonlytype

Static Readonly[species]

Methods

[iterator]

Returns MapIterator<[string, BaseTag]>

add

Type Parameters

Parameters

Returns T

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[string, BaseTag]>

forEach

Parameters

Returns void

get

Type Parameters

Parameters

Returns undefined | T

has

Parameters

Returns boolean

keys

Returns MapIterator<string>

push

Type Parameters

Parameters

Returns this

set

Type Parameters

Parameters

Returns this

toJSON

Returns Record<string, unknown>

values

Returns MapIterator<BaseTag>

StaticgroupBy

Type Parameters

Parameters

Returns Map<K, T[]>

Staticread

Parameters

Returns CompoundTag

Staticwrite

Parameters

Returns void

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Readonly`type

`Static` `Readonly`[species]

`Static`groupBy

`Static`read

`Static`write