Class TextVariant

Hierarchy

DataType
- TextVariant

Index

Constructors

Properties

message parameters source type

Methods

Constructors

constructor

new TextVariant(
    message: string,
    type: TextType,
    source?: null | string,
    parameters?: null | string[],
): TextVariant
Parameters
- message: string
- type: TextType
- source: null | string = null
- parameters: null | string[] = null
Returns TextVariant
Overrides DataType.constructor
- Defined in packages/protocol/src/proto/types/text-variant.ts:29

Properties

message

message: string

The message of the text variant.

parameters

parameters: null | string[] = null

The parameters of the text variant. If packet variant is TextVariantType.MessageAndParams otherwise null.

source

source: null | string = null

The source of the text variant. If packet variant is TextVariantType.AuthorAndMessage otherwise null.

type

The type of the text variant.

Methods

`Static`read

read(
stream: BinaryStream,
options: PacketDataTypeOptions<TextVariantType>,
): TextVariant
Read a value from the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to read from.
- options: PacketDataTypeOptions<TextVariantType>
  Options for reading the data type, such as endianness.
Returns TextVariant
The value read from the stream.
Overrides DataType.read
- Defined in packages/protocol/src/proto/types/text-variant.ts:42

`Static`write

write(
    stream: BinaryStream,
    value: TextVariant,
    options: PacketDataTypeOptions<TextVariantType>,
): void
Write a value to the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to write to.
- value: TextVariant
  The value to write.
- options: PacketDataTypeOptions<TextVariantType>
  Options for writing the data type, such as endianness.
Returns void
Overrides DataType.write
- Defined in packages/protocol/src/proto/types/text-variant.ts:107