undoInfo

Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

undoInfo [-chunkName string] [-closeChunk] [-infinity boolean] [-length uint] [-openChunk] [-printQueue] [-printRedoQueue] [-redoName string] [-redoQueueEmpty] [-state boolean] [-stateWithoutFlush boolean] [-undoName string] [-undoQueueEmpty]

undoInfo is undoable, queryable, and NOT editable.

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.

Return value

In query mode, return type is based on queried flag.

Related

Flags

Long name (short name)	Argument types	Properties
-chunkName(-cn)	string
Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.
-closeChunk(-cck)
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(-in)	boolean
Set the queue length to infinity.
-length(-l)	uint
Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.
-openChunk(-ock)
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)
Prints to the Script Editor the contents of the undo queue.
-printRedoQueue(-prq)
Prints to the Script Editor the contents of the redo queue.
-redoName(-rn)	string
Returns what will be redone (if anything)
-redoQueueEmpty(-rqe)
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)	boolean
Turns undo/redo on or off.
-stateWithoutFlush(-swf)	boolean
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)	string
Returns what will be undone (if anything)
-undoQueueEmpty(-uqe)
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 appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Turn undo on, with an infinite queue length
undoInfo -state on -infinity on;
// Turn undo on, with a queue length of 200
undoInfo -state on -infinity off -length 200;
// Turn undo off
undoInfo -state off;
// Query the queue length
undoInfo -q -length;
// Print the contents of the undo queue.
undoInfo -q -pq;
// Query the number of items currently on the queue.
undoInfo -q;