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

Vicon Shogun banner


Sets 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 expected is either a float or an integer. If createNumBox was used with the -flt flag, then all values are interpreted as floats. Otherwise, values are rounded down to the nearest integer (i.e. any decimal value will be truncated).

Functional area

User Window

Command syntax


setNumBoxNum userControlID numVal


numValfloatyesNumber value to set for the num box. An int can be used as well, and any cast will automatically be made by the num box
userControlIdintyesID of user control to operate on.



Return value



// Set the value on 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`;

// Set the value on the Num Box. Because the Num Box
// was not created with the -flt flag, we are really
// setting the value to be -10.
setNumBoxNum $controlId -10.75;
// Should be -10
$val = `getNumBoxNum $controlId`;
print $val;

Additional information

Related commands