Package com.blamejared.crafttweaker.api.action.item.tooltip

Class ActionModifyShiftedTooltip

java.lang.Object

com.blamejared.crafttweaker.api.action.item.tooltip.ActionTooltipBase

com.blamejared.crafttweaker.api.action.item.tooltip.ActionModifyShiftedTooltip

All Implemented Interfaces:

IAction, IRuntimeAction, IUndoableAction

public class ActionModifyShiftedTooltip
extends ActionTooltipBase

Field Summary

Fields inherited from class com.blamejared.crafttweaker.api.action.item.tooltip.ActionTooltipBase

stack

Constructor Summary

Constructors

Constructor	Description
ActionModifyShiftedTooltip(IIngredient stack, ITooltipFunction shiftedFunction, ITooltipFunction unshiftedFunction)

Method Summary

Modifier and Type	Method	Description
void	apply()	Applies the action, executing all code necessary.
String	describe()	Gets a human-readable description of the action.
String	describeUndo()	Gets a human-readable description of the action rollback.
void	undo()	Undoes all changes carried out by the action.

Methods inherited from class com.blamejared.crafttweaker.api.action.item.tooltip.ActionTooltipBase

getTooltip, shouldApplyOn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.blamejared.crafttweaker.api.action.base.IAction

assertLoader, getDeclaredScriptPosition, validate

Constructor Details

ActionModifyShiftedTooltip

public ActionModifyShiftedTooltip(IIngredient stack,
 ITooltipFunction shiftedFunction,
 ITooltipFunction unshiftedFunction)

Method Details

apply

public void apply()

Description copied from interface: IAction

Applies the action, executing all code necessary.

undo

public void undo()

Description copied from interface: IUndoableAction

Undoes all changes carried out by the action.

describe

public String describe()

Description copied from interface: IAction

Gets a human-readable description of the action.

This message is used for logging and to surface information to the user when something goes wrong. It is thus customary to describe the action as accurately as possible without being too verbose.

It is not allowed to return a null or otherwise empty description for the action: doing so will raise an error at runtime.

Returns:

A description of the current action.

describeUndo

public String describeUndo()

Description copied from interface: IUndoableAction

Gets a human-readable description of the action rollback.

This message is used for logging and to surface information to the user when something goes wrong. It is thus customary to describe the rollback as accurately as possible without being too verbose.

It is not allowed to return a null or otherwise empty description for the rollback: doing so will raise an error at runtime.

Returns:

A description of the current action rollback.