Class RegisteredCommandSettings<Command>

constructor

• new RegisteredCommandSettings<
      Command extends Globals.RegisteredCommand<CommandTypeBase>,
  >(
      command: Command,
  ): RegisteredCommandSettings<Command>

  Creates a new instance of the RegisteredCommandSettings class.

  Type Parameters

  • Command extends Globals.RegisteredCommand<CommandTypeBase>

  Parameters

  • command: Command

    The command to manage the settings for.

  Returns RegisteredCommandSettings<Command>

  Throws

  If the command does not have a commandSettingsId defined.

Readonlycommand

defaultSettings

• get defaultSettings(): RegisteredCommandSettingsData

  The default settings for the command.

  Returns RegisteredCommandSettingsData

enabled

• get enabled(): boolean

  Whether or not the command is enabled.

  Returns boolean
• set enabled(enabled: undefined | boolean): void

  Parameters

  • enabled: undefined | boolean

  Returns void

isSaved

• get isSaved(): boolean

  Whether or not the command settings are saved in the world.

  Returns boolean

parsed

• get parsed(): undefined | RegisteredCommandSettingsData

  The parsed command settings data.

  Returns undefined | RegisteredCommandSettingsData

requiredPermissionLevel

• get requiredPermissionLevel(): string | number

  The required permission level to execute the command.

  Only applies when Ultra Security Mode is disabled.

  Returns string | number

  Default

  0
  Copy

• set requiredPermissionLevel(
      requiredPermissionLevel: undefined | string | number,
  ): void

  Parameters

  • requiredPermissionLevel: undefined | string | number

  Returns void

requiredTags

• get requiredTags(): string[]

  The tags required to execute the command.

  Only applies when Ultra Security Mode is disabled.

  Returns string[]

  Default

  ["canUseChatCommands"]
  Copy

• set requiredTags(requiredTags: undefined | string[]): void

  Parameters

  • requiredTags: undefined | string[]

  Returns void

requiresOp

• get requiresOp(): boolean

  Whether or not the command requires operator status to execute.

  Only applies when Ultra Security Mode is disabled.

  Returns boolean

  Deprecated

  The Player.prototype.isOp method is currently very buggy so this may not work as intended and should not be relied upon.

  Default

  false
  Copy

• set requiresOp(requiresOp: undefined | boolean): void

  Parameters

  • requiresOp: undefined | boolean

  Returns void

settings_version

• get settings_version(): string

  The format version the command settings were last saved in.

  Returns string

  See

  • command_settings_format_version
  • legacy_command_settings_format_version

  Default

  command_settings_format_version
  Copy

reset

• reset(): void

  Deletes the command settings from the world, in effect resetting the settings of the command to their default values.

  Returns void

save

• save(settings?: Partial<RegisteredCommandSettingsData>): void

  Saves the command settings to the world.

  Parameters

  • Optionalsettings: Partial<RegisteredCommandSettingsData>

    The settings to save, this will be applied on top of the current command settings.

  Returns void

toJSON

• toJSON(): RegisteredCommandSettingsData

  Converts the command settings to a JSON-serializable object.

  Returns RegisteredCommandSettingsData

  The JSON-serializable object representing the command settings.