Class ItemStackLevelStorage

Hierarchy

CompoundTag
- ItemStackLevelStorage

Constructors

constructor

new ItemStackLevelStorage(
source?: CompoundTag | ItemStackLevelStorage,
): ItemStackLevelStorage
Parameters
- Optionalsource: CompoundTag | ItemStackLevelStorage
Returns ItemStackLevelStorage
Overrides CompoundTag.constructor
- Defined in packages/core/src/item/storage.ts:8

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

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

getDynamicProperties

getDynamicProperties(): [string, JSONLikeValue][]
Get the dynamic properties of the item stack from the level storage.

Returns [string, JSONLikeValue][]
An array of tuples containing property identifiers and their values.
- Defined in packages/core/src/item/storage.ts:62

getIdentifier

getIdentifier(): string
Returns string
- Defined in packages/core/src/item/storage.ts:15

getMetadata

getMetadata(): number
Returns number
- Defined in packages/core/src/item/storage.ts:38

getStackNbt

getStackNbt(): CompoundTag
Returns CompoundTag
- Defined in packages/core/src/item/storage.ts:48

getStackSize

getStackSize(): number
Returns number
- Defined in packages/core/src/item/storage.ts:28

getTraits

getTraits(): string[]
Get the traits of the item stack from the level storage.

Returns string[]
An array of trait identifiers.
- Defined in packages/core/src/item/storage.ts:124

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

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

setDynamicProperties

setDynamicProperties(properties: [string, JSONLikeValue][]): void
Set dynamic properties for the item stack in the level storage.
Parameters
- properties: [string, JSONLikeValue][]
  An array of tuples containing property identifiers and their values.
Returns void
- Defined in packages/core/src/item/storage.ts:94

setIdentifier

setIdentifier(identifier: string): void
Parameters
- identifier: string
Returns void
- Defined in packages/core/src/item/storage.ts:23

setMetadata

setMetadata(metadata: number): void
Parameters
- metadata: number
Returns void
- Defined in packages/core/src/item/storage.ts:43

setStackNbt

setStackNbt(stackNbt: CompoundTag): void
Parameters
- stackNbt: CompoundTag
Returns void
- Defined in packages/core/src/item/storage.ts:53

setStackSize

setStackSize(size: number): void
Parameters
- size: number
Returns void
- Defined in packages/core/src/item/storage.ts:33

setTraits

setTraits(traits: string[]): void
Set traits for the item stack in the level storage.
Parameters
- traits: string[]
  An array of trait identifiers to set.
Returns void
- Defined in packages/core/src/item/storage.ts:150

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`fromBuffer

fromBuffer(buffer: Buffer): ItemStackLevelStorage
Initialize the ItemStackLevelStorage from a buffer.
Parameters
- buffer: Buffer
  The buffer containing the serialized ItemStackLevelStorage data.
Returns ItemStackLevelStorage
A new ItemStackLevelStorage instance initialized from the buffer.
- Defined in packages/core/src/item/storage.ts:172

`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`toBuffer

toBuffer(storage: CompoundTag | ItemStackLevelStorage): Buffer
Convert the ItemStackLevelStorage to a buffer.
Parameters
- storage: CompoundTag | ItemStackLevelStorage
  The ItemStackLevelStorage or CompoundTag to convert.
Returns Buffer
A Buffer containing the serialized ItemStackLevelStorage data.
- Defined in packages/core/src/item/storage.ts:188

`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 ItemStackLevelStorage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ItemStackLevelStorage

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

getDynamicProperties

Returns [string, JSONLikeValue][]

getIdentifier

Returns string

getMetadata

Returns number

getStackNbt

Returns CompoundTag

getStackSize

Returns number

getTraits

Returns string[]

has

Parameters

Returns boolean

keys

Returns MapIterator<string>

push

Type Parameters

Parameters

Returns this

set

Type Parameters

Parameters

Returns this

setDynamicProperties

Parameters

Returns void

setIdentifier

Parameters

Returns void

setMetadata

Parameters

Returns void

setStackNbt

Parameters

Returns void

setStackSize

Parameters

Returns void

setTraits

Parameters

`Readonly`[toStringTag]

`Readonly`size

`Readonly`type

`Static` `Readonly`[species]

`Static`fromBuffer

`Static`groupBy

`Static`read

`Static`toBuffer

`Static`write