Package com.blamejared.crafttweaker.api.action.recipe.replace

Class ReplacerAction

java.lang.Object

com.blamejared.crafttweaker.api.action.recipe.replace.ReplacerAction

All Implemented Interfaces:

IAction, IRuntimeAction

public final class ReplacerAction
extends Object
implements IRuntimeAction

Constructor Summary

Constructors

Constructor	Description
ReplacerAction(ITargetingRule targetingRule, boolean isSimple, List<IReplacementRule> replacementRules, Collection<net.minecraft.resources.ResourceLocation> defaultExclusions, Function<net.minecraft.resources.ResourceLocation,net.minecraft.resources.ResourceLocation> generatorFunction, boolean suppressWarnings)

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.
boolean	validate(org.apache.logging.log4j.Logger logger)	Validates the action, ensuring no erroneous information is present.

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, shouldApplyOn

Constructor Details

ReplacerAction

public ReplacerAction(ITargetingRule targetingRule,
 boolean isSimple,
 List<IReplacementRule> replacementRules,
 Collection<net.minecraft.resources.ResourceLocation> defaultExclusions,
 Function<net.minecraft.resources.ResourceLocation,net.minecraft.resources.ResourceLocation> generatorFunction,
 boolean suppressWarnings)

Method Details

apply

public void apply()

Description copied from interface: IAction

Applies the action, executing all code necessary.

Specified by:

apply in interface IAction

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.

Specified by:

describe in interface IAction

Returns:

A description of the current action.

validate

public boolean validate(org.apache.logging.log4j.Logger logger)

Description copied from interface: IAction

Validates the action, ensuring no erroneous information is present.

Implementations should validate all action information and log errors using the provided Logger if anything is incorrect. It is highly suggested to specify exactly what is wrong in the most precise yet brief way possible, to ensure script writers know why their actions are not being applied.

If validation fails for whatever reason, IAction.apply() will not be called.

Specified by:

validate in interface IAction

Parameters:

logger - Logger object on which to log errors or warnings.

Returns:

Whether the action is valid (true) or not (false).