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

Vicon Shogun banner


Retrieves a string value 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 used to retrieve attributes that can have be represented as strings (e.g. Rotation_Order, Other_Part, Start_Frame).

Functional area

Data retrieval

Command syntax


getStringProperty moduleName propertyName[-fullPath]


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


See above syntax.

Return value



// Get some information about the "thorax" bone.
string $part;
string $rotOrder;
$part = `getStringProperty "thorax" "Other_Part"`;
print $part;
$rotOrder = `getStringProperty "thorax" "Rotation_Order"`;
print $rotOrder;

With a VSK and VSS present in the scene for an actor named GG:

// Print "LIEL" (the name of the marker which is pointed to in the 
// Source attribute of LIEL_LeftArm).
string $str = `getStringProperty "GG Labeling LIEL_LeftArm" "Source"`;
print $str;

// Print "GG\LIEL" which is the full path to that same marker.
string $str = `getStringProperty "GG Labeling LIEL_LeftArm" "Source" -fullPath`;
print $str;

Additional information

Related commands