Files
CraftTweaker/src/main/java/minetweaker/IUndoableAction.java
T

73 lines
3.0 KiB
Java

package minetweaker;
/**
* Defines a (possibly) undoable action.
*
* Every modification made by a command must be registered to the Tweaker with the Tweaker.apply method. This enables
* MineTweaker to keep track of actions that have been performed, and enables them to be rolled back later on.
*
* Actions exist in two flavors: undoable and permanent. If an action returns canUndo(), the action is undoable,
* otherwise it is permanent. Permanent actions cannot be used in server scripts.
*
* There also exist semi-permanent actions. Those actions can return an override key; if a newer action has the same
* override key as an old action, the new action is considered to override the old one.
*
* Likewise, actions can implement hashCode and equals methods to indicate that they are equal. If an action is equal to
* a non-undoable stuck action, it will be omitted from execution.
*
* @author Stan Hebben
*/
public interface IUndoableAction {
/**
* Executes what the action is supposed to do. This method can be called again if undo() has been called in between.
*/
public void apply();
/**
* Checks if this action can be undone. If this method returns true, it must implement undo() properly. If this
* method returns false, the action is considered permanent, undo() will never be called, and the action cannot be
* executed as part of a server script. Additionally, the minetweaker.clear() function will not work and
* minetweaker.canClear will return false.
*
* @return undoable status
*/
public boolean canUndo();
/**
* Undoes the action. Will only be called after apply() has been executed. After an undo, apply may be called again.
* They could be done multiple times in certain scenarios.
*/
public void undo();
/**
* Describes, in a single human-readable sentence, what this specific action is doing. Used in logging messages,
* lists, ...
*
* Try to be as descriptive as possible without being too verbose.
*
* Examples: - Adding Peach planks to the woodPlanks ore dictionary entry - Removing a recipe for Iron Ore
*
* @return the description of this action
*/
public String describe();
/**
* Describes what this action does if it is undone. Similar to the describe() method. No implementation is needed if
* the action cannot be undone.
*
* @return the description of this action, when undone
*/
public String describeUndo();
/**
* Returns the override key. Two actions are considered to override each other if their override key is equal. You
* can return null to indicate that an action can never be overridden.
*
* This value only makes sense for recipes that are not undoable. For undoable recipes, you should return null.
*
* @return override key (null for actions that are undoable or which can never be overridden by another action)
*/
public Object getOverrideKey();
}