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

Vicon Shogun banner


Retrieves a float value from an object.

Because Shogun Post commands can only have one return type, there must be separate commands for retrieving different types of property data.

This command is used to retrieve channel or attributes values that are floating points (e.g. the Opacity attribute or TranslationX).

If propertyName represents a channel, the channel value at the current time is returned, unless the -c option is specified. It has the exact same functionality as the getProperty command.

Functional area

Data retrieval

Command syntax


getFloatProperty moduleName propertyName[-c] [-d]


propertyNamestringyesName of the property on the object.
moduleNamestringyesObject to retrieve property value from.


NameFlag argumentsArgument typeExclusive toComments
c0Retrieves the property's const value. Only has an effect if propertyName represents a channel (i.e. can be animated).

Return value



// Get some information about the "LFHD" marker.
float $opacity;
float $xTrans;
$opacity = `getFloatProperty "LFHD" "Opacity" `;
print $opacity;

$xTrans = `getFloatProperty "LFHD" "TranslationX"`;
print $xTrans;

Additional information

Related commands