Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
BaseSpawner BlockAndTintGetter BlockGetter Clearable CommonLevelAccessor Container CraftTweakerSavedData Difficulty DifficultyInstance Explosion ExplosionBlockInteraction GameType InteractionResult InteractionResultHolder ItemInteractionResult ItemLike Level LevelAccessor LevelEventConstants LevelReader LevelSimulatedRW LevelWriter Nameable SavedData ServerLevel ServerLevelAccessor
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
GameType InteractionResultHolder
Next

InteractionResult

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.api.world.InteractionResult;

Implements

Undocumented Interfaces

Comparable<Enum>

Enum Constants

InteractionResult is an enum with 6 constants. They are accessible like so:

script.zs
// InteractionResult.CONSUME
<constant:minecraft:world/interactionresult:consume>
// InteractionResult.CONSUME_PARTIAL
<constant:minecraft:world/interactionresult:consume_partial>
// InteractionResult.FAIL
<constant:minecraft:world/interactionresult:fail>
// InteractionResult.PASS
<constant:minecraft:world/interactionresult:pass>
// InteractionResult.SUCCESS
<constant:minecraft:world/interactionresult:success>
// InteractionResult.SUCCESS_NO_ITEM_USED
<constant:minecraft:world/interactionresult:success_no_item_used>

Members

consumesAction
Getter
script.zs
// InteractionResult.consumesAction as bool
<constant:minecraft:world/interactionresult:consume>.consumesAction

Return Type: bool

indicateItemUse
Getter
script.zs
// InteractionResult.indicateItemUse as bool
<constant:minecraft:world/interactionresult:consume>.indicateItemUse

Return Type: bool

shouldSwing
Getter
script.zs
// InteractionResult.shouldSwing as bool
<constant:minecraft:world/interactionresult:consume>.shouldSwing

Return Type: bool

sidedSuccess
static sidedSuccess(successSide as bool) as InteractionResult
Returns true if successSide is true, this can be used to return SUCCESS on the client, but CONSUME on the server.

Returns: <constant:minecraft:world/interactionresult:success> if successSide is true, otherwise <constant:minecraft:world/interactionresult:consume>.

script.zs
// InteractionResult.sidedSuccess(successSide as bool) as InteractionResult;
InteractionResult.sidedSuccess(true);

Parameters:

successSide Type: bool - Is the current side the success side.

Return Type: InteractionResult

Previous
GameType InteractionResultHolder
Next