Vicon Shogun banner

Description

Creates a blank docking user window that is similar to the other docking windows found in Shogun Post. This command is the starting point for all custom GUI work inside of Shogun Post.

The window name must not match the window name of any other docking window (user or native), or the command will fail.

The return value is the unique ID of the user window. Save this ID, as it will be used in many of the other custom GUI commands.

Functional area

User Window

Command syntax

Syntax

createWindow "windowName"

Arguments

NameTypeRequiredComments
windowNamestringyesUnique window name. Must not match any other docking window names, user or native.

Flags

None

Return value

integer

Examples

// Create a user window and store its user window ID. 
// Save the ID to our ini file so we can retrieve it
// from other scripts that might need it
int $windowId;

// Create the user window
$windowId = `createWindow "MyWindow"`;

// Save the user window ID to our ini, so we can use it later.
writeProfileInt "MyWindowSection" "MyWindowID" $windowId;

Additional information

Related commands