Description

Sets a named module as the primary selection.

Use setPrimary to make any scene module the primary selection, whether or not that module is currently selected. If there is a primary selection at the time at which the command is executed, that module will remain selected, but will no longer be primary.

Functional area

Selection

Command syntax

Syntax

setPrimary "name" [-prev] [-next]

Arguments

Name	Type	Required	Comments
`name`	string	no	String name of the module to be declared as primary

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`prev`	0	—	next	If multiple modules are selected, sets the primary module to the next module of those selected.
`next`	0	—	prev	If multiple modules are selected, sets the primary module to the previous module of those selected.

Return value

void

Examples

// Set "LFIN" to the primary selection. 
// Currently selected modules remain selected.
setPrimary "LFIN";

Additional information

Related commands

select

Shogun 1.10 Documentation

setPrimary