Description

Retrieves an integer 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 attributes values that are integers (e.g Frame_In on characters) or time values (e.g. Start_Frame on clip).

It can also retrieve integer channel values. If propertyName represents a channel, the channel value at the current time is returned, unless the -c option is specified.

Functional area

Data retrieval

Command syntax

Syntax

getIntProperty 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

integer

Examples

// Get some information about the "LFHD" marker
int $FrameIn = `getIntProperty "Actor_1" "Frame_In"`;
print $FrameIn;

Additional information

Related commands

Browser not supported