plugins.core.actions.custom

Creates a bunch of commands that can be used to assign actions to. This allows you to assign any action to a shortcut key in CommandPost.


API Overview

Variables - Configurable values

  • shortcuts

Functions - API calls offered directly by the extension

  • apply
  • assign

API Documentation

Variables

shortcuts

   
Signature plugins.core.actions.custom.shortcuts <cp.prop: table>
Type Variable
Description Table of shortcuts.
Notes None
Source src/plugins/core/actions/custom.lua line 25

Functions

apply

   
Signature plugins.core.actions.custom.apply(id) -> none
Type Function
Description Applies a shortcut.
Parameters
  • id - The Custom Action ID.
Returns
  • None
Notes None
Examples None
Source src/plugins/core/actions/custom.lua line 37

assign

   
Signature plugins.core.actions.custom.assign(id, handlerId) -> none
Type Function
Description Assigns an Action to a Shortcut via a Console.
Parameters
  • id - The Custom Action ID.
  • completionFn - An optional completion function that triggers when a selection is made.
Returns
  • None
Notes None
Examples None
Source src/plugins/core/actions/custom.lua line 63