menuaction

Last updated 9 months ago

A action which will trigger an Final Cut Pro menu with a matching path, if available/enabled. Registers itself with the plugins.core.actions.actionmanager.

API Overview

API Documentation

Functions

actionId

Signature

plugins.finalcutpro.menu.menuaction.actionId(params) -> string

Type

Function

Description

Gets the action ID from the parameters table.

Parameters

Returns

execute

Signature

plugins.finalcutpro.menu.menuaction.execute(action) -> boolean

Type

Function

Description

Executes the action with the provided parameters.

Parameters

id

Signature

plugins.finalcutpro.menu.menuaction.id() -> none

Type

Function

Description

Returns the menu ID

Parameters

Returns

init

Signature

plugins.finalcutpro.menu.menuaction.init(actionmanager) -> none

Type

Function

Description

Initialises the Menu Action plugin

Parameters

Returns

onChoices

Signature

plugins.finalcutpro.menu.menuaction.onChoices(choices) -> none

Type

Function

Description

Add choices to the chooser.

Parameters

Returns

reload

Signature

plugins.finalcutpro.menu.menuaction.reload() -> none

Type

Function

Description

Reloads the choices.

Parameters

Returns

reset

Signature

plugins.finalcutpro.menu.menuaction.reset() -> none

Type

Function

Description

Resets the handler.

Parameters

Returns