#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

#API Documentation

#Functions

Signatureplugins.finalcutpro.commands.actions.execute(action) -> boolean
TypeFunction
DescriptionExecutes the action with the provided parameters.
Parameters
  • action - A table representing the action
Returns
  • true if successful otherwise false
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/commands/actions.lua line 110
Signatureplugins.finalcutpro.commands.actionss.getId(action) -> string
TypeFunction
DescriptionGets the ID from an action.
Parameters
  • action - The action table.
Returns
  • The ID as a string.
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/commands/actions.lua line 97
Signatureplugins.finalcutpro.commands.actions.getId(action) -> string
TypeFunction
DescriptionGet ID.
Parameters
  • action - The action table.
Returns
  • The ID as a string.
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/console/font.lua line 317
Signatureplugins.finalcutpro.commands.actions.init(actionmanager, cmds) -> none
TypeFunction
DescriptionInitialises the module.
Parameters
  • actionmanager - The action manager object
  • cmds - Final Cut Pro commands manager
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/commands/actions.lua line 32
Signatureplugins.finalcutpro.commands.actions.onChoices([choices]) -> none
TypeFunction
DescriptionAdds available choices to the selection.
Parameters
  • choices - The optional cp.choices to add choices to.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/console/font.lua line 241
Signatureplugins.finalcutpro.commands.actions.onExecute(action) -> none
TypeFunction
DescriptionOn Execute.
Parameters
  • action - The action table.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/console/font.lua line 330
Signatureplugins.finalcutpro.commands.actions.reset() -> nothing
TypeFunction
DescriptionResets the set of choices.
Parameters
  • None
Returns
  • Nothing
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/commands/actions.lua line 150

© Copyright 2025 LateNite Films Pty Ltd. All rights reserved.