Create Undo Batch (LogiX node)
| Create Undo Batch | ||
|---|---|---|
 | ||
| Inputs | ||
| Impulse | DoCreate | |
| String | Description | |
| Outputs | ||
| Impulse | Create | |
| Impulse | OnCreated | |
The Create Undo Batch node can be used to create a batch of Undo Manager save points, before then making the relevant changes, when an impulse is received at DoCreate.
Usage
The Description input determines the text which is displayed in a user's radial menu next to the Undo button for the relevant undo step. Default is null.
The Create output fires an impulse immediately after one is received at DoCreate. This impulse chain should be used for creating all undo points which should be included in a batch undo step. This does not need to be explicitly finished using End Undo Batch (LogiX node).
The OnCreated output fires an impulse after the impulse chain from Create has finished and the relevant batch undo point created. This impulse chain can be used to make changes to the fields or object transforms for which undo steps were made during the Create impulse chain.
The Undo Manager entry is created for the owner of the impulse received at Create. Unless the Description input has a non-null value, the text displayed around the Undo button in the radial menu is "(batch action)".
The nodes which work best with this method of creating undoable batches are Create Field Undo Step (LogiX node), Create Reference Undo Step (LogiX node), Create Type Field Undo Step (LogiX node), and Create Transform Undo Step (LogiX node). If you need to include Create Spawn Undo Step (LogiX node) or Undoable Destroy (LogiX node) in a batch it is recommended to use Begin Undo Batch (LogiX node) instead.