Options
All
  • Public
  • Public/Protected
  • All
Menu

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

since

3.0

Hierarchy

Index

Properties

default: string

Only in the argument of string enum type, default value is required.

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 validate the string value written by the player, and to suggest the enum's values 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: STRING_ENUM | "strenum" | "stringenum"

Integer or string type of the following argument.

Generated using TypeDoc