pymel.core.system.undoInfo

undoInfo(*args, **kwargs)

This command controls the undo/redo parameters. In query mode, if invoked without flags (other than the query flag), this command will return the number of items currently on the undo queue.

Flags:

Long Name / Short Name Argument Types Properties
chunkName / cn unicode ../../../_images/create.gif ../../../_images/query.gif
  Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.
closeChunk / cck bool ../../../_images/create.gif
  Closes the chunk that was opened earlier by openChunk. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad state.
infinity / infinity bool ../../../_images/create.gif ../../../_images/query.gif
  Set the queue length to infinity.
length / l int ../../../_images/create.gif ../../../_images/query.gif
  Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.
openChunk / ock bool ../../../_images/create.gif
  Opens a chunk so that all undoable operations after this call will fall into the newly opened chunk, until close chunk is called. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad state.
printQueue / pq bool ../../../_images/query.gif
  Prints to the Script Editor the contents of the undo queue.
redoName / rn unicode ../../../_images/query.gif
  Returns what will be redone (if anything)
redoQueueEmpty / rqe bool ../../../_images/query.gif
  Return true if the redo queue is empty. Return false if there is at least one command in the queue to be redone.
state / st bool ../../../_images/create.gif ../../../_images/query.gif
  Turns undo/redo on or off.
stateWithoutFlush / swf bool ../../../_images/create.gif ../../../_images/query.gif
  Turns undo/redo on or off without flushing the queue. Use with CAUTION!! Note that if you perform destructive operations while stateWithoutFlush is disabled, and you then enable it again, subsequent undo operations that try to go past the destructive operations may be unstable since undo will not be able to properly reconstruct the former state of the scene.
undoName / un unicode ../../../_images/query.gif
  Returns what will be undone (if anything)
undoQueueEmpty / uqe bool ../../../_images/query.gif
  Return true if the undo queue is empty. Return false if there is at least one command in the queue to be undone. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.undoInfo

Example:

import pymel.core as pm

# Turn undo on, with an infinite queue length
pm.undoInfo( state=True, infinity=True )
# Turn undo on, with a queue length of 200
pm.undoInfo( state=True, infinity=False, length=200 )
# Turn undo off
pm.undoInfo( state=False )
# Query the queue length
pm.undoInfo( q=True, length=True )
# Result: 200 #