Class StringTag

Hierarchy (View Summary)

Tag<string>
- StringTag

Index

Constructors

Properties

name type value type

Methods

toJSON from read readString write writeString

Constructors

constructor

new StringTag(properties?: Partial<TagProperties<string>>): StringTag
Parameters
- properties: Partial<TagProperties<string>> = {}
Returns StringTag
Inherited from Tag.constructor
- Defined in types/tag.ts:41

Properties

name

name: string = ""

The name of the tag.

`Readonly`type

type: TagType = ...

The nbt tag type of the data type.

value

value: string = ...

The value of the tag.

`Static` `Readonly`type

type: String = TagType.String

The nbt tag type of the data type.

Methods

toJSON

toJSON(): TagProperties<string> & { type: TagType }
Returns TagProperties<string> & { type: TagType }
Inherited from Tag.toJSON
- Defined in types/tag.ts:47

`Static`from

from(buffer: Buffer, varint?: boolean): Tag
Parameters
- buffer: Buffer
- varint: boolean = false
Returns Tag
Inherited from Tag.from
- Defined in types/tag.ts:51

`Static`read

read(
    stream: BinaryStream,
    varint: boolean,
    properties?: Partial<ReadingProperties>,
): Tag
Read a nbt tag from a binary stream.
Parameters
- stream: BinaryStream
  The binary stream to read from.
- varint: boolean
  Whether to read the tag as a varint.
- properties: Partial<ReadingProperties> = ...
Returns Tag
Overrides Tag.read
- Defined in types/string.ts:10

`Protected` `Static`readString

readString(stream: BinaryStream, varint?: boolean): string
Parameters
- stream: BinaryStream
- varint: boolean = false
Returns string
Inherited from Tag.readString
- Defined in types/tag.ts:87

`Static`write

write(
    stream: BinaryStream,
    value: StringTag,
    varint?: boolean,
    properties?: Partial<WritingProperties>,
): void
Write a nbt tag to a binary stream.
Parameters
- stream: BinaryStream
  The binary stream to write to.
- value: StringTag
  The value of the tag.
- Optionalvarint: boolean
  Whether to write the tag as a varint.
- properties: Partial<WritingProperties> = ...
Returns void
Overrides Tag.write
- Defined in types/string.ts:40

`Protected` `Static`writeString

writeString(value: string, stream: BinaryStream, varint?: boolean): void
Parameters
- value: string
- stream: BinaryStream
- varint: boolean = false
Returns void
Inherited from Tag.writeString
- Defined in types/tag.ts:98