docs » plugins.core.setup


Manager for the CommandPost Setup Screen.

Submodules

API Overview

API Documentation

Constants

DEFAULT_HEIGHT

Signature plugins.core.setup.DEFAULT_HEIGHT -> number
Type Constant
Description The default panel height.

DEFAULT_TITLE

Signature plugins.core.setup.DEFAULT_TITLE -> string
Type Constant
Description The default panel title.

DEFAULT_WIDTH

Signature plugins.core.setup.DEFAULT_WIDTH -> number
Type Constant
Description The default panel width.

enabled

Signature plugins.core.setup.enabled <cp.prop: boolean>
Type Constant
Description Set to true if the manager is enabled. Defaults to false.

FIRST_PRIORITY

Signature plugins.core.setup.FIRST_PRIORITY -> number
Type Constant
Description The first panel priority.

LAST_PRIORITY

Signature plugins.core.setup.LAST_PRIORITY -> number
Type Constant
Description The last panel priority.

visible

Signature plugins.core.setup.visible <cp.prop: boolean; read-only>
Type Constant
Description A property indicating if the welcome window is visible on screen.

Variables

onboardingRequired

Signature plugins.core.setup.onboardingRequired <cp.prop: boolean>
Type Variable
Description Set to true if on-boarding is required otherwise false. Defaults to true.

position

Signature plugins.core.setup.position <cp.prop: table>
Type Variable
Description The last known position of the Setup Window as a frame.

Functions

addPanel

Signature plugins.core.setup.addPanel(newPanel) -> panel
Type Function
Description Adds the new panel to the manager. Panels are created via the
Parameters
  • `newPanel` - The panel to add.
Returns
  • The manager.

currentPanel

Signature plugins.core.setup.currentPanel() -> string
Type Function
Description The Current Panel
Parameters
  • None
Returns
  • The current panel as a string

delete

Signature plugins.core.setup.delete() -> none
Type Function
Description Deletes the Setup Panels.
Parameters
  • None
Returns
  • None

focus

Signature plugins.core.setup.focus() -> none
Type Function
Description Focuses on the Setup Panels window.
Parameters
  • None
Returns
  • None

getLabel

Signature plugins.core.setup.getLabel() -> string
Type Function
Description Returns the Webview label.
Parameters
  • None
Returns
  • The Webview label as a string.

init

Signature plugins.core.setup.init(env) -> module
Type Function
Description Initialises the module.
Parameters
  • env - The plugin environment table
Returns
  • The Module

injectScript

Signature plugins.core.setup.injectScript(script) -> none
Type Function
Description Injects JavaScript into the Setup Panels.
Parameters
  • script - The JavaScript you want to inject as a string.
Returns
  • None

new

Signature plugins.core.setup.new() -> none
Type Function
Description Creates the Setup Panels.
Parameters
  • None
Returns
  • None

nextPanel

Signature plugins.core.setup.nextPanel() -> boolean
Type Function
Description Moves to the next panel. If the window is visible, the panel will be updated.
Parameters
  • None
Returns
  • `true` if there was another panel to move to, or `false` if no panels remain.

setPanelRenderer

Signature plugins.core.setup.setPanelRenderer(renderer) -> none
Type Function
Description Sets a Panel Renderer
Parameters
  • renderer - The renderer
Returns
  • None

show

Signature plugins.core.setup.show() -> none
Type Function
Description Shows the Setup Panels.
Parameters
  • None
Returns
  • None

update

Signature plugins.core.setup.update() -> none
Type Function
Description Updates the Setup Panels.
Parameters
  • None
Returns
  • None

results matching ""

    No results matching ""