#plugins.finalcutpro.commands.actions

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

#API Overview

Functions - API calls offered directly by the extension

execute
getId
getId
init
onChoices
onExecute
reset

#API Documentation

#Functions

#execute


Signature	`plugins.finalcutpro.commands.actions.execute(action) -> boolean`
Type	Function
Description	Executes the action with the provided parameters.
Parameters	`action` - A table representing the action
Returns	`true` if successful otherwise `false`
Notes	None
Examples	None
Source	src/plugins/finalcutpro/commands/actions.lua line 110

#getId


Signature	`plugins.finalcutpro.commands.actionss.getId(action) -> string`
Type	Function
Description	Gets the ID from an action.
Parameters	action - The action table.
Returns	The ID as a string.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/commands/actions.lua line 97

#getId


Signature	`plugins.finalcutpro.commands.actions.getId(action) -> string`
Type	Function
Description	Get ID.
Parameters	action - The action table.
Returns	The ID as a string.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/console/font.lua line 317

#init


Signature	`plugins.finalcutpro.commands.actions.init(actionmanager, cmds) -> none`
Type	Function
Description	Initialises the module.
Parameters	actionmanager - The action manager object cmds - Final Cut Pro commands manager
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/commands/actions.lua line 32

#onChoices


Signature	`plugins.finalcutpro.commands.actions.onChoices([choices]) -> none`
Type	Function
Description	Adds available choices to the selection.
Parameters	`choices` - The optional `cp.choices` to add choices to.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/console/font.lua line 241

#onExecute


Signature	`plugins.finalcutpro.commands.actions.onExecute(action) -> none`
Type	Function
Description	On Execute.
Parameters	action - The action table.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/console/font.lua line 330

#reset


Signature	`plugins.finalcutpro.commands.actions.reset() -> nothing`
Type	Function
Description	Resets the set of choices.
Parameters	None
Returns	Nothing
Notes	None
Examples	None
Source	src/plugins/finalcutpro/commands/actions.lua line 150