Interface ExecutableAction

Undocumented

interface ExecutableAction {
    actionGroup?: string;
    actionType?: string;
    boundObject?: any;
    category?: string | (() => string);
    checkAble?: boolean;
    checkedHandler?: (() => void);
    disabled?: OptionalPromiseResolvable<boolean>;
    execute: ((...params) => void);
    getTracklist?: ((...params) => Tracklist);
    hotkeyAble?: boolean;
    hotkeyTitle?: OptionalResolvable<string>;
    icon?: OptionalResolvable<string>;
    submenu?: OptionalPromiseResolvable<Action[] | SubmenuItem[]>;
    title?: OptionalResolvable<string>;
    visible?: OptionalPromiseResolvable<boolean>;
}

Hierarchy (view full)

Properties

actionGroup? actionType? boundObject? category? checkAble? checkedHandler? disabled? execute getTracklist? hotkeyAble? hotkeyTitle? icon? submenu? title? visible?

Properties

Optional actionGroup

actionGroup?: string

Undocumented

Optional actionType

actionType?: string

Undocumented

Optional boundObject

boundObject?: any

Undocumented

Optional category

category?: string | (() => string)

Name of the action's category. Categories are defined in the global actionCategories object. Default is general.

Type declaration

    • (): string

    • Returns string

Optional checkAble

checkAble?: boolean

Undocumented

Optional checkedHandler

checkedHandler?: (() => void)

Type declaration

    • (): void

    • Returns void

Undocumented

Optional disabled

disabled?: OptionalPromiseResolvable<boolean>

Undocumented

execute

execute: ((...params) => void)

Type declaration

    • (...params): void

    • Parameters

      • Rest ...params: any[]

      Returns void

Undocumented

Optional getTracklist

getTracklist?: ((...params) => Tracklist)

Type declaration

Undocumented

Optional hotkeyAble

hotkeyAble?: boolean

Determines whether the action can be tied to a hotkey. Default is false.

Optional hotkeyTitle

hotkeyTitle?: OptionalResolvable<string>

Undocumented

Optional icon

icon?: OptionalResolvable<string>

Icon that shows in menus that contain the action. The icon ids are located in skin/(iconname).svg.

Optional submenu

submenu?: OptionalPromiseResolvable<Action[] | SubmenuItem[]>

Undocumented

Optional title

title?: OptionalResolvable<string>

Title of the action.

Optional visible

visible?: OptionalPromiseResolvable<boolean>

Determines whether the action will show up in menus. This can be useful for integrating party mode, for example, by disabling your action when party mode is enabled with visible: uitools.getCanEdit.

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc