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

Vicon Shogun banner

Description

Prints the contents of the specified variables to the Log.

The print command prints the contents of any variable(s) to the feedback line. Each value (and array element) will get its own log entry. If you specify -warning or -error, the value printed for each entry will have the words "Warning: " or "ERROR: " prepended to it, respectively, and will draw with an alternate background color on the log line of the status bar.

System

Command syntax

print "stringToPrint" [-warning] [-error]

NameTypeRequiredComments
stringToPrintanyyesThis argument can be any data type. If it is an array type, each array value is printed to the command log in its own line.
You may specify any number of variables/values to print.

NameFlag argumentsArgument typeExclusive toComments
warning0errorMarks each log entry as a warning. The word Warning: prepends the entry and a different background color is applied in the Log line of the status bar.
error0warningMarks each log entry as an error. The word ERROR: prepends the entry and a different background color is applied in the Log line of the status bar.

void

// Demonstrate the versatility of the print command 
string $str[2];
vector $vec = << 1, 2, 3 >>;
$str[0] = "test 1";
$str[1] = "test 2";
print $str;
print $vec;
print -error "Something very wrong has happened";