Class CompoundTag

Hierarchy

Map<string, BaseTag>
- CompoundTag

Implements

BaseTag

Index

Constructors

constructor

new CompoundTag(name?: null | string): CompoundTag
Create a new CompoundTag instance.
Parameters
- Optionalname: null | string
  The name of the tag, defaults to null.
Returns CompoundTag
Overrides Map<string, BaseTag>.constructor
- Defined in packages/nbt/src/types/compound.ts:26

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 Map.[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.
- Defined in packages/nbt/src/types/compound.ts:90

clear

clear(): void
Returns void
Inherited from Map.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 Map.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 Map.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 Map.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.
Overrides Map.get
- Defined in packages/nbt/src/types/compound.ts:50

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.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 Map.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.
- Defined in packages/nbt/src/types/compound.ts:74

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.
Overrides Map.set
- Defined in packages/nbt/src/types/compound.ts:61

toJSON

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

Returns Record<string, unknown>
Implementation of BaseTag.toJSON
- Defined in packages/nbt/src/types/compound.ts:31

values

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

Returns MapIterator<BaseTag>
Inherited from Map.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 Map.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.
- options: ReadWriteOptions = ...
  The options for reading the tag.
Returns CompoundTag
- Defined in packages/nbt/src/types/compound.ts:98

`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.
- options: ReadWriteOptions = ...
  The options for writing the tag.
Returns void
- Defined in packages/nbt/src/types/compound.ts:305

Class CompoundTag

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CompoundTag

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