plugins.core.tangent.commandpost.favourites.md

docs » plugins.core.tangent.commandpost.favourites

---

Tangent Favourites.

API Overview

• Functions - API calls offered directly by the extension
• clearAction
• favourites
• init
• saveAction
• updateControls

API Documentation

Functions

clearAction

Signature	plugins.core.tangent.commandpost.favourites.clearAction(buttonID) -> none
Type	Function
Description	Clears an Action from Favourites.
Parameters	buttonID - The button ID you want to clear.
Returns	None

favourites

Signature	plugins.core.tangent.commandpost.favourites.favourites() -> table
Type	Function
Description	Gets a table of favourites from file.
Parameters	None
Returns	A table of favourites.

init

Signature	plugins.core.tangent.commandpost.favourites.init() -> none
Type	Function
Description	Initialise Module.
Parameters	tangentManager - Tangent Manager Plugin actionManager - Action Manager Plugin cpGroup - CommandPost Group
Returns	None

saveAction

Signature	plugins.core.tangent.commandpost.favourites.saveAction(buttonID, actionTitle, handlerID, action) -> none
Type	Function
Description	Saves an action to Favourites.
Parameters	buttonID - The button ID as number. actionTitle - The action title as string. handlerID - The handler ID as string. action - The action table.
Returns	None

updateControls

Signature	plugins.core.tangent.commandpost.favourites.updateControls() -> none
Type	Function
Description	Update Controls
Parameters	None
Returns	None