Class Commands

Represents the commands of a available command packet.

Hierarchy

DataType
- Commands

Index

Constructors

constructor

new Commands(
    name: string,
    description: string,
    flags: number,
    permissionLevel: CommandPermissionLevel,
    alias: number,
    subcommands: number[],
    overloads: CommandsOverload[],
): Commands
Parameters
- name: string
- description: string
- flags: number
- permissionLevel: CommandPermissionLevel
- alias: number
- subcommands: number[]
- overloads: CommandsOverload[]
Returns Commands
Overrides DataType.constructor
- Defined in packages/protocol/src/proto/types/commands.ts:56

Properties

`Readonly`alias

alias: number

The alias of the command.

`Readonly`description

description: string

The description of the command.

`Readonly`flags

flags: number

The flags of the command. Setting this value to 1 will make the command blue.

`Readonly`name

name: string

The name of the command.

`Readonly`overloads

overloads: CommandsOverload[]

The overloads of the command.

`Readonly`permissionLevel

permissionLevel: CommandPermissionLevel

The permission level of the command.

`Readonly`subcommands

subcommands: number[]

The subcommands of the command.

Methods

`Static`read

read(stream: BinaryStream): Commands[]
Read a value from the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to read from.
Returns Commands[]
The value read from the stream.
Overrides DataType.read
- Defined in packages/protocol/src/proto/types/commands.ts:75

`Static`write

write(stream: BinaryStream, value: Commands[]): void
Write a value to the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to write to.
- value: Commands[]
  The value to write.
Returns void
Overrides DataType.write
- Defined in packages/protocol/src/proto/types/commands.ts:150

Class Commands

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Commands

Properties

`Readonly`alias

`Readonly`description

`Readonly`flags

`Readonly`name

`Readonly`overloads

`Readonly`permissionLevel

`Readonly`subcommands

Methods

`Static`read

Parameters

Returns Commands[]

`Static`write

Parameters

Returns void

Settings

On This Page

Class Commands

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Commands

Properties

Readonlyalias

Readonlydescription

Readonlyflags

Readonlyname

Readonlyoverloads

ReadonlypermissionLevel

Readonlysubcommands

Methods

Staticread

Parameters

Returns Commands[]

Staticwrite

Parameters

Returns void

Settings

On This Page

`Readonly`alias

`Readonly`description

`Readonly`flags

`Readonly`name

`Readonly`overloads

`Readonly`permissionLevel

`Readonly`subcommands

`Static`read

`Static`write