Go to: Synopsis. Return value. Related. Flags. Python examples.
autoKeyframe([addAttr=name], [characterOption=string], [listAttr=boolean], [noReset=boolean], [state=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
autoKeyframe is undoable, queryable, and editable.
With no flags, this command will set keyframes on all
attributes that have been modified since an "autoKeyframe -state on"
command was issued. To stop keeping track of modified attributes,
use "autoKeyframe -state off"
autoKeyframe does not create new animation curves. An attribute
must have already been keyframed (with the setKeyframe command)
for autoKeyframe to add new keyframes for modified attributes.
You can also query the current state of autoKeyframing
with "autoKeyframe -query -state".
| int | Number of keyframes set. |
In query mode, return type is based on queried flag.
findKeyframe, setDrivenKeyframe, setKeyPath, setKeyframe
addAttr, characterOption, listAttr, noReset, state
| Long name (short name) |
Argument types |
Properties |
|
addAttr(aa)
|
name
|
|
|
Add to the list of plugs (node.attribute) that autoKeyframe is currently
considering for auto keying. This list is transient and short-lived, and
is reset as soon as autoKeyframe sets the keyframe or decides that no
keyframe is to be set, on completion of the next set attribute.
|
|
characterOption(co)
|
string
|
 
|
|
Valid options are: "standard", "all". Dictates whether
when auto-keying characters the auto-key works as usual or whether
it keys all of the character attributes. Default is "standard".
|
|
listAttr(lsa)
|
boolean
|
|
|
Returns the list of plugs (node.attribute) that autoKeyframe is currently
considering for auto keying. This list is transient and short-lived, and
is reset as soon as autoKeyframe sets the keyframe or decides that no
keyframe is to be set, on completion of the next set attribute.
|
|
noReset(nr)
|
boolean
|
|
|
Must be used in conjunction with the state/st flag.
When noReset/nr is specified, the list of plugs to be autokeyed
is not cleared when the state changes
|
|
state(st)
|
boolean
|
|
|
turns on/off remembering of modified attributes
|
|
|
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
# Start remembering attributes that have changed
#
cmds.autoKeyframe( state=True )
# Set a keyframe for all attributes that have changed
# since the last "autoKeyframe( state=True )
#
cmds.autoKeyframe()
# Stop remembering attributes that have changed.
# Note that Subsequent "autoKeyframe" commands
# (with no flags) will have no effect until an
# autoKeyframe( state=True ) command is executed.
#
cmds.autoKeyframe( state=False )
# List the plugs that will be considered to add a key on completion of the
# next set attribute.
cmds.autoKeyframe(query=True, listAttr=True)
# Add to the list the plugs that will be considered to add a key on
# completion of the next set attribute.
cmds.autoKeyframe(edit=True, addAttr='myNode.myAttr')
# When auto-keying, key all character attributes, not just
# those that have changed.
#
cmds.autoKeyframe( characterOption="all" )