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

Vicon Shogun banner

Description

Returns the value of the given parameter.

Parameters are stored on characters and used by bones and constraints. The getParameter command allows the value of a parameter to be accessed. By default, the command expects the character to be selected, but the -onMod option can be used to specify the character without having to select it.

Functional area

Parameters

Command syntax

Syntax

getParameter parameterName[-onMod string] [-solving]

Arguments

None

Flags

NameFlag argumentsArgument typeExclusive toComments
onMod1stringSpecifies which character to look on for a parameter of the given name.
solving



Return value

float

Returns the value of the parameter.

Examples

// Get the parameter UpperLegLength from the character Bob 
float $upperLegLength = `getParameter UpperLegLength -onMod "Bob"`;

Additional information

Related commands