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

Vicon Shogun banner


Returns a Boolean of whether or not a module with a name that matches the specified string value exists in the scene.

The exists command is used to query the scene for the existence of a given module or module type. For instance, you may be writing an automatic editing script and are trying to determine whether or not a certain marker, like LUPA (left upper arm) exists or not, in order to determine what method to used for filling in gaps on other arm related markers.

Functional area

Data editing

Command syntax


exists modPath [-type string] [-priorityOnly]


modPathstringyesName of module to be queried


NameFlag argumentsArgument typeExclusive toComments
type1stringType of module for which to check existence
priorityOnly0Search only the priority module

Return value



// either one returns a value of True if this node exists in the scene
boolean $t = `exists "Actor_1"`;
boolean $v = exists( "Actor_1" );

Additional information

Related commands