Hierarchy

  • CommandEvents

Properties

Properties

execute: ((label, args, commandLine) => boolean)

Type declaration

    • (label, args, commandLine): boolean
    • Called on any command being used.

      Parameters

      • label: string

        The beginning of the command line (for example, 'test' in '.test 123')

      • args: string[]

        The list of arguments of the command line (for example, ['123'] in '.test 123')

      • commandLine: string

        The command line (for example, '.test 123 test' in '.test 123 test')

      Returns boolean

      Whether the command usage is successful or not (return false if the user misused the command)

Generated using TypeDoc