Vicon Shogun banner

Description

Retrieves the value of a specified floating point global variable.

Shogun's scripting language supports global variables that are accessible across scripts within a session of Shogun Post. This command retrieves the value of a specified global variable (identified by the name argument of the command) which stores a double-precision float value.

Functional area

Data retrieval

Command syntax

Syntax

getGlobalFloatVar name

Arguments

NameTypeRequiredComments
namestringyesName of the variable to retrieve

Flags

None

Return value

float

Returns the (double precision) floating-point value stored in the specified global variable.

Examples

// Use the global myVar
float $localVar = 2.0;
print($localVar);
if (`getGlobalVarExists myVar`)
{
// Override local variable with global floating point value
$localVar = `getGlobalFloatVar myVar`;
}
print($localVar);

Additional information

Related commands