ICommand

Index

Properties

• Action
• Arguments
• AutoComplete
• Clear
• Description
• Prerequisite
• PreserveCase
• Reference
• Subcommands
• Tag

Properties

optionalAction

Action?: (this, argumentsString, message, arguments) => void

The function that handles the command

---

Type declaration

• • (this, argumentsString, message, arguments): void

  • Parameters

    • this: ICommand[]

    • argumentsString: string

    • message: string

    • arguments: string[]

    Returns void

optionalArguments

Arguments?: ArgumentDef[]

Array of arguments that the command accepts. Can be a function to generate arguments at runtime. Typically used to provide additional context for users

optionalAutoComplete

AutoComplete?: (this, arguments, lowercaseMessage, message) => void

Function to execute on autocomplete key (Tab default) press if chat input matches tag

---

Type declaration

• • (this, arguments, lowercaseMessage, message): void

  • Parameters

    • this: ICommand

    • arguments: string[]

    • lowercaseMessage: string

    • message: string

    Returns void

optionalClear

Clear?: false

Whether chat input should be cleared after execution of command. True if omitted

optionalDescription

Description?: string | Partial<Record<ServerChatRoomLanguage | TW, string>>

Description of the command

optionalPrerequisite

Prerequisite?: (this) => boolean

Function that returns whether the command can be executed

---

Type declaration

• • (this): boolean

  • Parameters

    • this: ICommand

    Returns boolean

optionalPreserveCase

PreserveCase?: boolean

Whether the case of the command should be preserved. False if omitted

optionalReference

Reference?: string

Reference to another command, used for aliases

optionalSubcommands

Subcommands?: Thunk<Subcommand[]>

Array of commands that can be used as subcommands.

Tag

Tag: string

Name of the command