Vicon Shogun banner

Description

Returns the number of frames on which a module has keys.

Used to determine the number of frames on which the primary selected module has keys.

Functional area

Data retrieval

Command syntax

Syntax

getNumKeys propertyName[-s] [-onMod string]

Arguments

NameTypeRequiredComments
propertyNamestringyesChannel property

Flags

NameFlag argumentsArgument typeExclusive toComments
s0Selected keys only
onMod1stringReturns key count for the specified module.

Return value

integer

Examples

int $i;
select RKNE; $i = `getNumKeys "Translation"`;
print $i; //Output "4058"
selectRange 1 100;
selectKeys -ranges;
$i = `getNumKeys "Translation.X" -s`;
print $i; //Output "100"
select;
$i = `getNumKeys Translation -onMod RKNE`;
print $i; //Output "4058"

Additional information

Related commands