Vicon Shogun banner

Description

Retrieves an array of integer values from an object's attributes.

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 mainly used to retrieve the color attribute values. Colors are returned as a three element integer array, holding the R, G, and B values of the color. Values range from 0-255.

Functional area

Data retrieval

Command syntax

Syntax

getIntArrayProperty moduleName propertyName

Arguments

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

Flags

None

Return value

integer array

Examples

// Get an object's color.
int $color[];
$color = `getIntArrayProperty "LFHD" "Color"`;
print $color;

Additional information

Related commands