Go to: Synopsis. Return value. Flags. Python examples.
nameCommand(
[string]
, [annotation=string], [command=script], [data1=string], [data2=string], [data3=string], [default=boolean], [sourceType=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
nameCommand is undoable, NOT queryable, and NOT editable.
This command creates a nameCommand object. Each nameCommand object
can be connected to a hotkey. Thereafter, the nameCommand's command
string will be executed whenever the hotkey is pressed (or released,
as specified by the user).
| string | The name of the nameCommand object created |
annotation, command, data1, data2, data3, default, sourceType
| Long name (short name) |
Argument types |
Properties |
|
annotation(ann)
|
string
|
|
|
A description of the command.
|
|
command(c)
|
script
|
|
|
The command that is executed
when the nameCommand is invoked.
|
|
data1(da1)
|
string
|
|
|
|
data2(da2)
|
string
|
|
|
|
data3(da3)
|
string
|
|
|
These are optional, user-defined data strings that
are attached to the nameCommand object. They can be
edited or queried using the assignCommand command.
|
|
default(d)
|
boolean
|
|
|
Indicate that this name command is a default command.
Default name commands will not be saved to preferences.
|
|
sourceType(stp)
|
string
|
|
|
Sets the language type for the command script. Can only be used in conjunction with the -command flag.
Valid values are "mel" (enabled by default), and "python".
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
# Create a nameCommand object.
#
cmds.nameCommand( 'circleToolNameCommand', ann='The Circle Tool', c='cmds.setToolTo("circleContext")' )
# Now map the nameCommand to a hotkey.
#
cmds.hotkey( keyShortcut='F5', altModifier=True, name='circleToolNameCommand' )