Vicon Shogun banner

Description

This command is used to cause a time delay, specified in milliseconds.

It could be used after a command that is known to take a while to complete, and which is needed to be complete for further commands in the script, for example, waiting for the system to connect.

Functional area

Interface

Command syntax

Syntax

wait milliseconds

Arguments

NameTypeRequiredComments
millisecondsintyesThe time that the script will pause on the command, eg, 3000 is 3 seconds.

Flags

None

Return value

void

Examples

//print to log the time at the beginning and end of the script
int $TimeNow = `getSystemTime`;
print $TimeNow;
wait 3000;
$TimeNow = `getSystemTime`;print $TimeNow;
//The log shows 2 numbers that have a difference of 3
//meaning 3 seconds have elapsed