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

Vicon Shogun banner


Set the value of the selected keys on the named property on the selected modules.

Use setProperty when you need to set the same value (in either absolute terms, or in terms relative to the existing keyframes) on a named property for the selected group of keys, whether the selection contains one object or several objects.

This command functions on attributes as well as channels. In the case of attributes, the current key selection is ignored since in Shogun Post, attributes are fixed settings and cannot be animated.

Functional area

Data manipulators

Command syntax


setProperty propertyName propertyVal1 propertyVal2 ... [-r] [-all] [-onMod string] [-type string] [-d]



An argument indicating the property to be changed, usually followed by one to three arguments values.
The number and type of argument values depends on the property called, eg, one numeric value float will be required if Translation.X is indicated, and three values if Translation is indicated. On the other hand, one string value is required for a property name like Name.
The arguments can be taken directly from the names of the fields in the Attributes and Channels dialog boxes. For instance, Name and Rotation_Order are legitimate string arguments for Character Node attributes while Weight and Translation.X are legitimate float channel arguments for Direction Constraints and Markers respectively.


NameFlag argumentsArgument typeExclusive toComments
c0Alter only the constant value for the property. Will not be visible to the user if keys already exist.
r0Set value relative to current value instead of absolute value. Requires keys to be selected.
all0Applies property change to all modules
onMod1stringtypeApplies property change only to specified Module
type1stringonModApplies property change only to objects of a certain type

Return value



selectRange 0 1000;
selectKeys -ranges;
setProperty -r "Translation" 0.0 0.0 400.0;
// For the range of selected keys, move the named nodes 40 millimeters
// in the Z direction relative to the selected keyframe values.
setProperty "Rotation_Order" YZX;
// Changes the rotation order to YZX for the selected object(s)
select LFHD;
setProperty "Name" taco;
// changes the name of the object called LFHD to taco;

Additional information

Related commands