FMOD Studio User Manual 2.02

26. Scripting API Reference | Window

Module: Window

The studio.window module allows for interaction with the window context.

window.open(windowType)

Opens a new window of the given window type (e.g. "Event Editor").

Returns true if the window request is valid, or false otherwise.

window.navigateTo(managedObject)

Attempts to navigate to a ManagedObject in the UI. Will open a new window if required. Returns true if successful.

window.browserCurrent([tabName])

Returns the currently selected ManagedObject in the active browser tab of the last active window. A tabName can optionally be specified to select from a different browser tab.

window.browserSelection([tabName])

Returns an Array of selected ManagedObjects in the active browser tab of the last active window. A tabName can optionally be specified to select from a different browser tab.

window.editorCurrent()

Returns the currently selected ManagedObject in the last active editor (e.g. in the multitrack view).

window.editorSelection()

Returns an array of selected ManagedObjects in the last active editor (e.g. in the multitrack view).

window.deckCurrent()

Returns the currently selected ManagedObject in the deck of the last active window.

window.deckSelection()

Returns an array of selected ManagedObjects in the deck of the last active window.

window.actions

An enumeration used with studio.window.triggerAction() to trigger the execution of an action. Possible values are:

window.triggerAction(actionType)

Attempts to trigger the actionType action for the last active window. The available options are described by the window.actions enum.