Package com.blamejared.crafttweaker.api.action.internal

Class CraftTweakerAction

java.lang.Object

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

All Implemented Interfaces:

IAction

Direct Known Subclasses:

ActionAddDataReceiver, ActionBatchReplacement, ActionLootModifier, ActionModifyAttribute, ActionRecipeBase, ActionRegisterEvent, ActionReplaceRecipe, ActionSetBlockProperty, ActionSetBurnTime, ActionSetCauldronInteraction, ActionSetCompostable, ActionSetItemProperty, ActionTag, ActionTooltipBase, ActionTradeBase, ActionWholeRegistryBase

public abstract class CraftTweakerAction
extends Object
implements IAction

Marks an action as being executed by CraftTweaker.

IMPORTANT

This is not for usage outside of CraftTweaker: it should not be considered public API. This class is published as part of it just because actions are considered API. Integration writers should not attempt to extend this class!

Constructor Summary

Constructors

Constructor	Description
CraftTweakerAction()

Method Summary

Modifier and Type	Method	Description
final String	systemName()	Gets the name of the system that is responsible for the execution of the action.

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

Constructor Details

CraftTweakerAction

public CraftTweakerAction()

Method Details

systemName

public final String systemName()

Description copied from interface: IAction

Gets the name of the system that is responsible for the execution of the action.

The system usually corresponds to the name of the mod that created the action and is thus attempting to apply it. For example, adding a recipe is done through CraftTweaker, so the system name is "CraftTweaker". Mods that have various components or would like to separate various integrations from each other can return more complex strings. In other words, if the class that implements this interface belongs to mod Foo, then the system name should be "Foo" (or "Foo-Bar" where Bar is the name of the subsystem) in almost all cases.

Note that the system name will be used for logging, therefore it is suggested to avoid overly verbose names or acronyms that are not widely known. Returning null or an empty name is disallowed.

Specified by:

systemName in interface IAction

Returns:

The name of the system that is responsible for this action.