Interface RegisteredCommandSettingsData

The data structure that holds the settings of a registered command.

See

RegisteredCommandSettings

interface RegisteredCommandSettingsData {
    commandSettingsId: string;
    enabled?: boolean;
    requiredPermissionLevel?: string | number;
    requiredTags?: string[];
    requiresOp?: boolean;
    settings_version: string;
    type: "built-in" | "custom" | "unknown";
}

Properties

commandSettingsId enabled? requiredPermissionLevel? requiredTags? requiresOp? settings_version type

Properties

commandSettingsId

commandSettingsId: string

The ID of the dynamic property that holds the command settings.

Optionalenabled

enabled?: boolean

Whether or not the command is enabled.

OptionalrequiredPermissionLevel

requiredPermissionLevel?: string | number

The required permission level to execute the command.

OptionalrequiredTags

requiredTags?: string[]

The tags required to execute the command.

Only applies when Ultra Security Mode is disabled.

OptionalrequiresOp

requiresOp?: boolean

Whether or not the command requires operator status to execute.

settings_version

settings_version: string

The format version the command settings were last saved in.

See

type

type: "built-in" | "custom" | "unknown"

The type of command.

Settings

Member Visibility

On This Page

Properties