This information is for Vicon Shogun 1.7. For up-to-date help, see the latest Shogun documentation.

Vicon Shogun banner


Gets the user num box number value.

Returns the number that appears in a num box user control that is specified by userControlID.

Num boxes are text boxes that restrict their input and output to numerical values. The number returned is a float, to accommodate both integer and floating point values. If createNumBox was created with the -flt flag, then all values will be interpreted as floats. Otherwise, values will be rounded down to the nearest integer (i.e. any decimal value will be truncated).

Functional area

User Window

Command syntax


getNumBoxNum userControlID


userControlIdintyesID of user control to operate on.



Return value



// Get the value of a Num Box User Control
int $windowId;
int $controlId;
float $val;

// First create a User Window to place the Control on
$windowId = `createWindow "MyWindow"`;

// Create the User Control on the Window.
$controlId = `createNumBox $windowId -flt -num -10.75`;

// Get the value of the Num Box
$val = `getNumBoxNum $controlId`;
print $val;

Additional information

Related commands