Go to: Synopsis. Return value. Flags. Python examples.
runup([cache=boolean], [fromPreviousFrame=boolean], [fromStartFrame=boolean], [maxFrame=time], [state=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
runup is undoable, NOT queryable, and NOT editable.
runup plays the scene through a frame of frames, forcing
dynamic objects to evaluate as it does so. If no max frame
is specified, runup runs up to the current time.
cache, fromPreviousFrame, fromStartFrame, maxFrame, state
| Long name (short name) |
Argument types |
Properties |
|
cache(cch)
|
boolean
|
|
|
Cache the state after the runup.
|
|
fromPreviousFrame(fpf)
|
boolean
|
|
|
Run up the animation from the previously evaluated frame.
If no flag is supplied this is the default.
|
|
fromStartFrame(fsf)
|
boolean
|
|
|
Run up the animation from the start frame.
If no flag is supplied -fromPreviousFrame is the default.
|
|
maxFrame(mxf)
|
time
|
|
|
Ending time for runup, in current user time units.
The runup will always start at the
minimum start frame for all dynamic objects.
|
|
state(st)
|
boolean
|
|
|
Turns runup and cache on/off.
|
|
|
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
cmds.runup( mxf=10, cache=True )
# Starts at the minimum start frame of all dynamic objects
# and plays through to frame 10. This guarantees that the system
# is in the same state it would be as if you had rewound and played
# forward from frame 0. The state of the dynamic object(s) will be
# cached after the runup.