docs » plugins.core.setup


Manager for the CommandPost Setup Screen.

Submodules

API Overview

API Documentation

Constants

enabled

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

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.

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.

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.

results matching ""

    No results matching ""