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

Class ActionTooltipBase

java.lang.Object

com.blamejared.crafttweaker.api.action.internal.CraftTweakerAction

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

All Implemented Interfaces:

IAction, IRuntimeAction, IUndoableAction

Direct Known Subclasses:

ActionAddShiftedTooltip, ActionAddTooltip, ActionClearTooltip, ActionModifyShiftedTooltip, ActionModifyTooltip, ActionRemoveRegexTooltip

public abstract class ActionTooltipBase
extends CraftTweakerAction
implements IUndoableAction

Field Summary

Fields

Modifier and Type	Field	Description
protected final IIngredient	stack

Constructor Summary

Constructors

Constructor	Description
ActionTooltipBase(IIngredient stack)

Method Summary

Modifier and Type	Method	Description
LinkedList<ITooltipFunction>	getTooltip()
protected void	pruneTooltips()
boolean	shouldApplyOn(IScriptLoadSource source, org.apache.logging.log4j.Logger logger)	Determines whether an action should be applied for scripts loading in the given IScriptLoadSource.

Methods inherited from class com.blamejared.crafttweaker.api.action.internal.CraftTweakerAction

systemName

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

apply, assertLoader, describe, getDeclaredScriptPosition, logger, systemName, validate

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

describeUndo, undo

Field Details

stack

protected final IIngredient stack

Constructor Details

ActionTooltipBase

public ActionTooltipBase(IIngredient stack)

Method Details

getTooltip

public LinkedList<ITooltipFunction> getTooltip()

pruneTooltips

protected void pruneTooltips()

shouldApplyOn

public boolean shouldApplyOn(IScriptLoadSource source,
 org.apache.logging.log4j.Logger logger)

Description copied from interface: IAction

Determines whether an action should be applied for scripts loading in the given IScriptLoadSource.

Specified by:

shouldApplyOn in interface IAction

Parameters:

source - The IScriptLoadSource responsible for loading the scripts.

logger - The Logger instance that should be used to log error messages if needed.

Returns:

If the action should be applied.