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.finalcutpro.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.

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.

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.

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

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

onExecute

Signature

plugins.finalcutpro.commands.actions.onExecute(action) -> none

Type

Function

Description

On Execute.

Parameters

action - The action table.

Returns

None

reset

Signature

plugins.finalcutpro.commands.actions.reset() -> nothing

Type

Function

Description

Resets the set of choices.

Parameters

None

Returns

Nothing