Method AddState

AddState(UndoStateType)

Saves the current scene state in the undo states stack.

Declaration

public Scene.UndoState AddState(Scene.UndoStateType stateType = UndoStateType.Null)

Parameters

Type	Name	Description
Scene.UndoStateType	stateType	The type of the action which will be carried out after the scene undo state is saved.

Returns

Type	Description
Scene.UndoState	The added undo state. This identifier can be backed up to allow suppression of this undo state later.

Remarks

This method could be called at the beginning of a plugin function that is going to modify the scene in order to allow a later cancellation of the scene modification (either by the user or by the plugin function itself) if the operations undertaken in the function were to fall through.