system.vision.setScreenIndex
Backwards Compatibility
This function replaces system.gui.setScreenIndex. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.
This function is used in Python Scripting.
Description​
Moves an open client to a specific monitor. Use with system.vision.getScreens() to identify monitors before moving.
note
This function is available on secondary desktops via the system.vision.desktop function. See the Multi-Monitor Clients page for more details on secondary desktops.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.vision.setScreenIndex(index)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Integer | index | The new monitor index for this client to move to. 0 based. |
Returns​
Nothing
Scope​
Vision Client
Code Example​
Setting a Screen's Index
# This example could be used on a startup script to move the client to a 2nd monitor.
system.vision.setScreenIndex(1)