Interface UndoAction

All Known Implementing Classes:
BuilderToolsPlugin.Action
public interface UndoAction
An undoable action type in the builder tools history system. Built-in actions are defined in BuilderToolsPlugin.Action. Register custom actions via UndoActionRegistry and push them with BuilderToolsPlugin.BuilderState#pushHistory.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    id()
    Unique identifier for the action
    default boolean
    marksPrefabDirty()
    Whether this action should dirty active prefab edit sessions.
    Message
    toMessage()
    Localized label shown in undo/redo feedback chat messages

  • Method Details

    • id

      @Nonnull String id()
      Unique identifier for the action

    • toMessage

      @Nonnull Message toMessage()
      Localized label shown in undo/redo feedback chat messages

    • marksPrefabDirty

      default boolean marksPrefabDirty()
      Whether this action should dirty active prefab edit sessions. Defaults to true. Override to false for non-destructive actions (clipboard copies, selection changes, etc.).