system.gui.setScreenIndex
This function is used in Python Scripting.
Description
Moves an open client to a specific monitor. Use with system.gui.getScreens() to identify monitors before moving.
Client Permission Restrictions
This scripting function has no Client Permission restrictions.
Syntax
system.gui.setScreenIndex(index)
Parameters
| Type | Parameter | Description |
|---|---|---|
| integer | index | The new monitor index for this client to move to. 0 based. |
Returns
Nothing
Scope
Client
Code Examples
Example #1
# This example could be used on a startup script to move the client to a 2nd monitor.
system.gui.setScreenIndex(1)