Long name (short name) |
Argument types |
Properties |
-exists(-ex) |
int |
|
|
Returns true if a scriptJob with the specified "job number"
exists, and false otherwise. The "job number" should be a value
that was returned on creation of a new scriptJob. |
|
-conditionTrue(-ct) |
string script |
|
|
Run the script when the named condition becomes true. The
string must be the name of a pre-defined, or a user-defined boolean
condition. To get a list of what conditions exist, use the
-listConditions flag. |
|
-conditionFalse(-cf) |
string script |
|
|
Run the script when the named condition becomes false. The
string must be the name of a pre-defined, or a user-defined boolean
condition. To get a list of what conditions exist, use the
-listConditions flag. |
|
-conditionChange(-cc) |
string script |
|
|
Run the script when the named condition changes state. The
string must be the name of a pre-defined, or a user-defined boolean
condition. To get a list of what conditions exist, use the
-listConditions flag. |
|
-event(-e) |
string script |
|
|
Run the script when the named event occurs. This string must be
the name of a pre-defined maya event. To get a list of what events
exist, use the -listEvents flag. |
|
-attributeChange(-ac) |
string script |
|
|
Run the script when the named attribute changes value. The
string must identify both the dependency node and the particular
attribute. If the dependency node is deleted, this job is killed
(even if the deletion is undoable). |
|
-attributeDeleted(-ad) |
string script |
|
|
Run the script when the named attribute is deleted. The string
must identify both the dependency node and the particular
attribute. If the dependency node is deleted, this job is killed
(even if the deletion is undoable). |
|
-attributeAdded(-aa) |
string script |
|
|
Run the script when the named attribute is added. The string
must identify both the dependency node and the particular
attribute. If the dependency node is deleted, this job is killed
(even if the deletion is undoable). |
|
-connectionChange(-con) |
string script |
|
|
Run the script when the named attribute changes its
connectivity. The string must identify both the dependency node and
the particular attribute. If the dependency node is deleted, this
job is killed (even if the deletion is undoable). |
|
-permanent(-per) |
|
|
|
Makes the job un-killable. Permanent jobs exist for the life of
the application, or for the life of their parent object. The
-killWithScene flag does apply to permanent jobs. |
|
-protected(-pro) |
|
|
|
Makes the job harder to kill. Protected jobs must be killed or
replaced intentionally by using the -force flag. The -killWithScene
flag does apply to protected jobs. |
|
-idleEvent(-ie) |
script |
|
|
Run the script every time maya is idle. WARNING, as long as an
idle event is is registered, the application will keep calling it
and will use up all available CPU time. Use idleEvents with
caution. |
|
-disregardIndex(-dri) |
|
|
|
This flag can only be used in conjunction with the
-ac/attributeChange flag. If it is specified, and the job is
attached to a multi (indexed) attribute, then the job will run no
matter which attribute in the multi changes. |
|
-allChildren(-alc) |
|
|
|
This flag can only be used in conjunction with the
-ac/attributeChange flag. If it is specified, and the job is
attached to a compound attribute, then the job will run due to
changes to the specified attribute as well as changes to its
children. |
|
-timeChange(-tc) |
script |
|
|
Run the script whenever the current time changes. The script
will not be executed if the time is changed by clicking on the time
slider, whereas scripts triggered by the "timeChanged" condition
will be executed. |
|
-uiDeleted(-uid) |
string script |
|
|
Run the script when the named piece of UI is deleted. |
|
-nodeNameChanged(-nnc) |
string script |
|
|
Run the script when the name of the named node changes |
|
-parent(-p) |
string |
|
|
Attaches this job to a piece of maya UI. When the UI is
destroyed, the job will be killed along with it. |
|
-replacePrevious(-rp) |
|
|
|
This flag can only be used with the -parent flag. Before the
new scriptJob is created, any existing scriptJobs that have the
same parent are first deleted. |
|
-force(-f) |
|
|
|
This flag can only be used with -kill, -killAll, or
-replacePrevious. It enables the deletion of protected jobs. |
|
-killWithScene(-kws) |
|
|
|
Attaches the job to the current scene, and when the scene is
emptied. The current scene is emptied by opening a new or existing
scene. |
|
-runOnce(-ro) |
boolean |
|
|
If this is set to true, the script will only be run a single
time. If false (the default) the script will run every time the
triggering condition/event occurs. If the -uid flag is used,
runOnce is turned on automatically. |
|
-compressUndo(-cu) |
boolean |
|
|
If this is set to true, and the scriptJob is undoable, then its
action will be bundled with the last user action for undo purposes.
For example; if the scriptJob was triggered by a selection change,
then pressing undo will undo both the scriptJob and the selection
change at the same time. |
|
-listJobs(-lj) |
|
|
|
This causes the command to return a string array containing a
description of all existing jobs, along with their job numbers.
These numbers can be used to kill the jobs later. |
|
-kill(-k) |
int |
|
|
Kills the job with the specified job number. Permanent jobs
cannot be killed, however, and protected jobs can only be killed if
the -force flag is used in the command. |
|
-killAll(-ka) |
|
|
|
Kills all jobs. Permanent jobs will not be deleted, and
protected jobs will only be deleted if the -force flag is
used. |
|
-listEvents(-le) |
|
|
|
This causes the command to return a string array containing the
names of all existing events. Below is the descriptions for all the
existing events:
- angularToleranceChanged:
- when the tolerance on angular units is changed. This tolerance
can be changed by:
- using the MEL command, "tolerance" with the "-angular"
flag
- changing the pref under Options->GeneralPreferences->
Modeling tab->Tangential Tolerance
- angularUnitChanged:
- when the user changes the angular unit.
- axisAtOriginChanged:
- when the axis changes at the origin.
- axisInViewChanged:
- when the axis changes at a particular view.
- ColorIndexChanged:
- when the color index values change.
- constructionHistoryChanged:
- when construction history is turned on or off.
- currentContainerChanged:
- when the user set or unset the current container.
- currentSoundNodeChanged:
- whenever the sound displayed in the time slider changes due to:
- the sound being removed (or no longer displayed) [RMB in the
time slider]
- a new sound being displayed [RMB in the time slider]
- sound display being toggled [animation options]
- sound display mode being changed [animation options]
- DagObjectCreated:
- when a new DAG object is created.
- deleteAll:
- when a file new occurs
- DisplayColorChanged:
- when the display color changes.
- displayLayerChange:
- when a layer has been created or destroyed.
- displayLayerManagerChange:
- when the display layer manager has changed.
- DisplayRGBColorChanged:
- when the RGB display color changes.
- glFrameTrigger:
- for internal use only.
- gridDisplayChanged:
- for internal use only.
- idle:
- when Maya is idle and there are no high priority idle
tasks
- idleHigh:
- when Maya is idle. This is called before low priority idle
tasks. You should almost always use "idle" instead.
- lightLinkingChanged:
- when any change occurs which modifies light linking
relationships.
- lightLinkingChangedNonSG:
- when any change occurs which modifies light linking
relationships, except when the change is a change of shading
assignment.
- linearToleranceChanged:
- when the linear tolerance has been changed. This tolerance can
be changed by:
- using the MEL command, "tolerance" with the "-linear" flag
- changing the pref under Options->GeneralPreferences->
Modeling tab->Positional Tolerance
- linearUnitChanged:
- when the user changes the linear unit through the Options
menu.
- MenuModeChanged:
- when the user changes the menu set for the menu bar in the main
Maya window (for example, from "Modeling" to "Animation").
- RecentCommandChanged:
- for internal use only.
- NewSceneOpened:
- when a new scene has been opened.
- nurbsToPolygonsPrefsChanged:
- when any of the nurbs-to-polygons prefs have changed. These
prefs can be changed by:
- using the Mel command, "nurbsToPolygonsPref"
- changing the prefs under Polygons->Nurbs To
Polygons->Option Box
- playbackRangeChanged:
- when the playback keyframe range changes.
- playbackRangeSliderChanged:
- when the animation start/end range (i.e. the leftmost or
rightmost entry cells in the time slider range, the inner ones
adjust the playback range) change
- quitApplication:
- when the user has chosen to quit, either through the quit MEL
command, or through the Exit menu item.
- Redo:
- when user has selected redo from the menu and there was
something to redo. This callback can be used for updating UI or
local storage. Do not change the state of the scene or DG during
this callback.
- renderLayerChange:
- when creation or deletion of a render layer node has
occured.
- renderLayerManagerChange:
- when the current render layer has changed.
- RebuildUIValues:
- for internal use only.
- SceneOpened:
- when a scene has been opened.
- SelectionChanged:
- when a new selection is made.
- SelectModeChanged:
- when the selection mode changes.
- SelectPreferenceChanged:
- for internal use only.
- SelectPriorityChanged:
- when the selection priority changes.
- SelectTypeChanged:
- when the selection type changes.
- setEditorChanged:
- obsolete. No longer used.
- SetModified:
- when the set command is used to modify a set
- snapModeChanged:
- when the snap mode changes. E.g. changes to grid snapping.
- timeChanged:
- when the time changes.
- timeUnitChanged:
- when the user changes the time unit.
- ToolChanged:
- when the user changes the tool/context.
- PostToolChanged:
- after the user changes the tool/context.
- NameChanged:
- when the user changes the name of an object with the rename
command.
- Undo:
- when user has selected undo from the menu and there was
something to undo. This callback can be used for updating UI or
local storage. Do not change the state of the scene or DG during
this callback.
|
|
-listConditions(-lc) |
|
|
|
This causes the command to return a string array containing the
names of all existing conditions. Below is the descriptions for all
the existing conditions:
Events Based on Available Maya Features
These events are true when the given feature is available.
Event Name |
Maya Feature |
AnimationExists |
Animation |
AnimationUIExists |
User Interface for Animation |
BaseMayaExists |
Any Basic Maya |
BaseUIExists |
Any Interactive Maya |
DatabaseUIExists |
|
DeformersExists |
Deformer Functions |
DeformersUIExists |
User Interface for Deformers |
DevicesExists |
Device Support |
DimensionsExists |
Dimensioning |
DynamicsExists |
Dynamics |
DynamicsUIExists |
User Interface for Dynamics |
ExplorerExists |
Explorer |
ImageUIExists |
User Interface for Imaging |
KinematicsExists |
Kinematics |
KinematicsUIExists |
User Interface for Kinematics |
ManipsExists |
Manipulators |
ModelExists |
Basic Modeling Tools |
ModelUIExists |
User Interface for Basic Modeling |
NurbsExists |
Nurbs Modeling Tools |
NurbsUIExists |
User Interface for Nurbs Modeling |
PolyCoreExists |
Basic Polygonal Support |
PolygonsExists |
Polygonal Modeling |
PolygonsUIExists |
User Interface for Polygonal Modeling |
PolyTextureExists |
Polygonal Texturing |
RenderingExists |
Built-in Rendering |
RenderingUIExists |
User Interface for Rendering |
Other Events
- autoKeyframeState:
- true when Maya has autoKeyframing enabled
- busy:
- true when Maya is busy.
- deleteAllCondition:
- true when in the middle of a delete-all operation
- flushingScene:
- true while the scene is being flushed out
- GoButtonEnabled:
- true when the Go button in the panel context is enabled.
- hotkeyListChange:
- true when the list of hotkey definitions has changed
- playingBack:
- true when Maya is playing back animation keyframes.
- playbackIconsCondition:
- instance of the playingBack condition used on the time
slider
- readingFile:
- true when Maya is reading a file.
- RedoAvailable:
- true when there are commands available for redo.
- SomethingSelected:
- true when some object(s) is selected.
- UndoAvailable:
- true when there are commands available for undo.
|
|