Description

Returns a Boolean providing information on whether or not a specified node has a key at the requested frame.

If you do not specify a specific frame, Shogun uses the current frame as a default. For example, this command will help if you are trying to determine whether or not there is a gap in the data of the marker you are examining.

Also, hasKey has the option of letting you determine whether or not an existing key is selected or not selected. For example, you may be trying to figure out not only if a given object has a key, but also whether or not that key has been selected by some other operation.

Functional area

Data retrieval

Command syntax

Syntax

hasKey "moduleName" "propertyName" [-selected] [-seconds integer] [-frame integer] [-allTime] [-any]

Arguments

Name	Type	Required	Comments
`propertyName`	string		Specifies the name of the property to query.
`moduleName`	string		Specifies the name of the module to query.

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`selected`	0	—	allTime	Allows for a narrowing of the query. If this flag is used, a selected key on the indicated property of the indicated module must exist in order to return a TRUE value
`seconds`	1	integer	frame, allTime	Allows for the specification of a specific time in seconds to narrow the query
`frame`	1	integer	seconds, allTime	Allows for the specification of a specific key to narrow the query
`all time`	0	—	seconds, frame	Query all time
`any`	0	—	—	Query channels independently.
`allTime`	0	—	seconds, frame	—

Return value

boolean

Examples

boolean $ktrans = `hasKey "LFHD" "TranslationX" -frame 50`;
print $ktrans;
// returns a value of "True" if the module "LHFD" has a 
// translation key at frame 50
 
boolean $krot = `hasKey "lfemur" "RotationX" -frame 20 -selected`;
print $krot;
// returns a value of "True" if the module "lfemur" has a 
// selected rotation key at frame 20

Shogun 1.14 Documentation

hasKey