Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface declaring a description object template for the command argument of integer enum type.

since

3.0

Hierarchy

Index

Properties

default?: number

Default value for the following argument, sometimes doesn't need to be specified, if the type of argument doesn't take default values.

label: string

Argument's name that will be displayed in command syntax hint text, and also will be used to access its value on command call.

name: string

String name of the enum used to convert string enum keys written by the player to corresponding integer enum values, and to suggest the enum's keys to the player above the chat input box.

optional?: boolean

Whether the following argument is optional, defaults to false. If you at least once set this property to true, then all the arguments coming after the following one will become optional too.

type: ENUM | "enum"

Integer or string type of the following argument.

Generated using TypeDoc