Class Enums

Represents a enum for the available command packet.

Hierarchy

DataType
- Enums

Index

Constructors

Properties

Methods

Constructors

constructor

new Enums(name: string, values: number[]): Enums
Creates a new enum.
Parameters
- name: string
  The name of the enum.
- values: number[]
  The indexed values of the enum.
Returns Enums
Overrides DataType.constructor
- Defined in packages/protocol/src/proto/types/enums.ts:29

Properties

`Readonly`name

name: string

The name of the enum.

`Readonly`values

values: number[]

The indexed values of the enum.

Methods

`Static`read

read(stream: BinaryStream, options?: PacketDataTypeOptions<string[]>): Enums[]
Read a value from the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to read from.
- Optionaloptions: PacketDataTypeOptions<string[]>
  Options for reading the data type, such as endianness.
Returns Enums[]
The value read from the stream.
Overrides DataType.read
- Defined in packages/protocol/src/proto/types/enums.ts:35

`Static`write

write(
    stream: BinaryStream,
    value: Enums[],
    options?: PacketDataTypeOptions<string[]>,
): void
Write a value to the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to write to.
- value: Enums[]
  The value to write.
- Optionaloptions: PacketDataTypeOptions<string[]>
  Options for writing the data type, such as endianness.
Returns void
Overrides DataType.write
- Defined in packages/protocol/src/proto/types/enums.ts:83