Vicon Shogun banner

Description

Returns a value of true or false depending on whether or not the indicated module is selected.

This command is only used with objects, not strings, as the command is only relevant if the object exists (if the object does not exist, it is not relevant to determine its status of being selected vs. not).

Functional area

Data retrieval

Command syntax

Syntax

isSelected module

Arguments

NameTypeRequiredComments
module

Name of the module in the scene that you wish to query.

Flags

None

Return value

boolean

Examples

// Here are 3 versions of syntax that are equally valid 
// and return the same information
boolean $x = Actor_1.isSelected();
boolean $y = isSelected( Actor_1 );
boolean $z = `isSelected Actor_1`;
print $x $y $z;

Additional information

Related commands