Options
All
  • Public
  • Public/Protected
  • All
Menu

Object returned by CommandsModule.newCommand used to describe a custom chat command.

since

3.0

Hierarchy

  • CommandOverloadBase

Index

Methods

  • Adds multiple aliases (alternative names) for the following command.

    since

    3.0

    Parameters

    Returns CommandOverloadBase

    reference to itself to be used in sequential calls

  • Specifies command's description, that will be displayed above the chat input box when writing /your_command_name. In this overload, the given description is set as the English localization, which will be used by default if you don't add translations to other languages.

    since

    3.0

    Parameters

    Returns CommandOverloadBase

    reference to itself to be used in sequential calls

  • Specifies command's description, that will be displayed above the chat input box when writing /your_command_name.

    since

    3.0

    Parameters

    • translations: {}

      object with language codes as keys and translations of the command description to the corresponding language as values

      • [key: string]: string

    Returns CommandOverloadBase

    reference to itself to be used in sequential calls

Generated using TypeDoc