Class CompoundTag<T>

constructor

• new CompoundTag<T>(properties?: Partial<TagProperties<T>>): CompoundTag<T>

  Type Parameters

  • T

  Parameters

  • Optionalproperties: Partial<TagProperties<T>>

  Returns CompoundTag<T>

value

Static Readonlytype

addTag

• addTag(tag: Tag): void

  Parameters

  • tag: Tag

  Returns void

createByteTag

• createByteTag(properties: Partial<TagProperties<number>>): ByteTag

  Parameters

  • properties: Partial<TagProperties<number>>

  Returns ByteTag

createCompoundTag

• createCompoundTag<T>(properties: Partial<TagProperties<T>>): CompoundTag<T>

  Type Parameters

  • T

  Parameters

  • properties: Partial<TagProperties<T>>

  Returns CompoundTag<T>

createDoubleTag

• createDoubleTag(properties: Partial<TagProperties<number>>): DoubleTag

  Parameters

  • properties: Partial<TagProperties<number>>

  Returns DoubleTag

createFloatTag

• createFloatTag(properties: Partial<TagProperties<number>>): FloatTag

  Parameters

  • properties: Partial<TagProperties<number>>

  Returns FloatTag

createIntTag

• createIntTag(properties: Partial<TagProperties<number>>): IntTag

  Parameters

  • properties: Partial<TagProperties<number>>

  Returns IntTag

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>

createLongTag

• createLongTag(properties: Partial<TagProperties<bigint>>): LongTag

  Parameters

  • properties: Partial<TagProperties<bigint>>

  Returns LongTag

createShortTag

• createShortTag(properties: Partial<TagProperties<number>>): ShortTag

  Parameters

  • properties: Partial<TagProperties<number>>

  Returns ShortTag

createStringTag

• createStringTag(properties: Partial<TagProperties<string>>): StringTag

  Parameters

  • properties: Partial<TagProperties<string>>

  Returns StringTag

getTag

• getTag<K extends Tag<unknown>>(name: string): K

  Type Parameters

  • K extends Tag<unknown>

  Parameters

  • name: string

  Returns K

getTags

• getTags(): Tag<unknown>[]

  Returns Tag<unknown>[]

hasTag

• hasTag(name: string): boolean

  Parameters

  • name: string

  Returns boolean

removeTag

• removeTag(name: string): void

  Parameters

  • name: string

  Returns void

setTag

• setTag(name: string, tag: Tag): void

  Parameters

  • name: string
  • tag: Tag

  Returns void

toJSON

• toJSON(): TagProperties<T> & { type: TagType }

  Returns TagProperties<T> & { type: TagType }

Staticfrom

• from<T>(buffer: Buffer, varint?: boolean): CompoundTag<T>

  Type Parameters

  • T

  Parameters

  • buffer: Buffer
  • varint: boolean = false

  Returns CompoundTag<T>

Staticread

• 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.
  • varint: boolean = false

    Whether to read the tag as a varint.
  • properties: Partial<ReadingProperties> = ...

  Returns CompoundTag<T>

Staticwrite

• 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.
  • varint: boolean = false

    Whether to write the tag as a varint.
  • properties: Partial<WritingProperties> = ...

  Returns void