Description

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

Syntax

getFloatProperty moduleName propertyName[-c] [-d]

Arguments

Name	Type	Required	Comments
`propertyName`	string	yes	Name of the property on the object.
`moduleName`	string	yes	Object to retrieve property value from.

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`c`	0	—	—	Retrieves the property's const value. Only has an effect if `propertyName` represents a channel (i.e. can be animated).
`d`	0	—	—	—

Return value

float

Examples

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

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

Shogun 1.9 Documentation

getFloatProperty