Class OptionCommand

An option command sent from the server to describe an option, it's type, it's name and it's default value.

Hierarchy

ClientCommand
- OptionCommand

Index

Constructors

Properties

defaultValue? kind max? min? name options?

Constructors

constructor

new OptionCommand(name: string, kind: "string" | "button" | "check" | "spin" | "combo", min?: number, max?: number, options?: string[], defaultValue?: string | number | boolean): OptionCommand
Parameters
- name: string
  
  The option name.
- kind: "string" | "button" | "check" | "spin" | "combo"
  
  The option type.
- Optional min: number
  
  The minimum value.
- Optional max: number
  
  The maximum value.
- Optional options: string[]
  
  The combo options.
- Optional defaultValue: string | number | boolean
  
  The default value.
Returns OptionCommand
Overrides ClientCommand.constructor
- Defined in OptionCommand.ts:8

Properties

`Optional` `Readonly` defaultValue

defaultValue?: string | number | boolean

The default value.

`Readonly` kind

kind: "string" | "button" | "check" | "spin" | "combo"

The option type.

`Optional` `Readonly` max

max?: number

The maximum value.

`Optional` `Readonly` min

min?: number

The minimum value.

`Readonly` name

name: string

The option name.

`Optional` `Readonly` options

options?: string[]

The combo options.

Generated using TypeDoc