Class UndoBlock
Class that automatically groups a series of object actions together as a single undo-operation
And works in both the editor and player (with player support simply turning off undo-operations)
Mirrors the normal functions you find in the Undo class and collapses them into one operation
when the block is complete
Proper usage of this class is:
using (var undoBlock = new UndoBlock("Desired Undo Message"))
{
undoBlock.yourCodeToUndo()
}
Syntax
public class UndoBlock : IDisposable
Constructors
UndoBlock(String, Boolean)
Declaration
public UndoBlock(string undoLabel, bool testMode = false)
Parameters
Methods
AddComponent<T>(GameObject)
Declaration
public T AddComponent<T>(GameObject gameObject)
where T : Component
Parameters
Type |
Name |
Description |
GameObject |
gameObject |
|
Returns
Type Parameters
Dispose()
Declaration
Dispose(Boolean)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type |
Name |
Description |
Boolean |
disposing |
|
RecordObject(Object)
Declaration
public void RecordObject(Object objectToUndo)
Parameters
Type |
Name |
Description |
UnityEngine.Object |
objectToUndo |
|
RegisterCreatedObject(Object)
Declaration
public void RegisterCreatedObject(Object objectToUndo)
Parameters
Type |
Name |
Description |
UnityEngine.Object |
objectToUndo |
|
Declaration
public void SetTransformParent(Transform transform, Transform newParent)
Parameters
Type |
Name |
Description |
Transform |
transform |
|
Transform |
newParent |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.