docs » plugins.core.commands.actions


An action which will execute a command with matching group/id values. Registers itself with the core.action.manager.

API Overview

API Documentation

Functions

execute

Signature plugins.core.commands.actions.execute(action) -> boolean
Type Function
Description Executes the action with the provided parameters.
Parameters
  • action - A table representing the action, matching the following:
* `id` - The specific Command ID within the group.
Returns
  • true if the action was executed successfully.

getId

Signature plugins.core.commands.actions.getId(action) -> string
Type Function
Description Gets an ID from an action table
Parameters
  • action - The action table.
Returns
  • The ID as a string.

init

Signature plugins.core.commands.actions.init(actionmanager, cmds) -> none
Type Function
Description Initialises the module.
Parameters
  • actionmanager - The Action Manager Plugin
  • cmds - The Commands Plugin.
Returns
  • None

onChoices

Signature plugins.core.commands.actions.onChoices(choices) -> none
Type Function
Description Adds available choices to the selection.
Parameters
  • choices - The cp.choices to add choices to.
Returns
  • None

reset

Signature plugins.core.commands.actions.reset() -> nothing
Type Function
Description Resets the set of choices.
Parameters
  • None
Returns
  • Nothing

results matching ""

    No results matching ""