Package net.minecraft.util

Enum Class ActionResult

java.lang.Object
java.lang.Enum<ActionResult>
net.minecraft.util.ActionResult
All Implemented Interfaces:
Serializable, Comparable<ActionResult>, Constable
public enum ActionResult extends Enum<ActionResult>
An enum indicating the hand interaction's result. Methods called on hand interaction, such as AbstractBlock.onUse(net.minecraft.block.BlockState, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.entity.player.PlayerEntity, net.minecraft.util.Hand, net.minecraft.util.hit.BlockHitResult), return this.
See Also:
Mappings:
Namespace Name
official bcm
intermediary net/minecraft/class_1269
named net/minecraft/util/ActionResult

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONSUME
    Indicates an action is performed but no animation should accompany the performance.
    CONSUME_PARTIAL
    Indicates an action is performed but no animation should accompany the performance and no statistic should be incremented.
    FAIL
    Indicates that an action is not performed and prevents other actions from performing.
    PASS
    Indicates an action is not performed but allows other actions to perform.
    SUCCESS
    Indicates an action is performed and the actor's hand should swing to indicate the performance.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    ActionResult()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAccepted()
    Returns whether an action is performed.
    boolean
    shouldIncrementStat()
    Returns whether action performance should increment an item's "used" statistic.
    boolean
    shouldSwingHand()
    Returns whether an actor should have a hand-swinging animation on action performance.
    static ActionResult
    success(boolean swingHand)
    Returns an action result indicating success.
    static ActionResult
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ActionResult[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SUCCESS

      public static final ActionResult SUCCESS
      Indicates an action is performed and the actor's hand should swing to indicate the performance.
      Mappings:
      Namespace Name Mixin selector
      official a Lbcm;a:Lbcm;
      intermediary field_5812 Lnet/minecraft/class_1269;field_5812:Lnet/minecraft/class_1269;
      named SUCCESS Lnet/minecraft/util/ActionResult;SUCCESS:Lnet/minecraft/util/ActionResult;

    • CONSUME

      public static final ActionResult CONSUME
      Indicates an action is performed but no animation should accompany the performance.
      Mappings:
      Namespace Name Mixin selector
      official b Lbcm;b:Lbcm;
      intermediary field_21466 Lnet/minecraft/class_1269;field_21466:Lnet/minecraft/class_1269;
      named CONSUME Lnet/minecraft/util/ActionResult;CONSUME:Lnet/minecraft/util/ActionResult;

    • CONSUME_PARTIAL

      public static final ActionResult CONSUME_PARTIAL
      Indicates an action is performed but no animation should accompany the performance and no statistic should be incremented.
      Mappings:
      Namespace Name Mixin selector
      official c Lbcm;c:Lbcm;
      intermediary field_33562 Lnet/minecraft/class_1269;field_33562:Lnet/minecraft/class_1269;
      named CONSUME_PARTIAL Lnet/minecraft/util/ActionResult;CONSUME_PARTIAL:Lnet/minecraft/util/ActionResult;

    • PASS

      public static final ActionResult PASS
      Indicates an action is not performed but allows other actions to perform.
      Mappings:
      Namespace Name Mixin selector
      official d Lbcm;d:Lbcm;
      intermediary field_5811 Lnet/minecraft/class_1269;field_5811:Lnet/minecraft/class_1269;
      named PASS Lnet/minecraft/util/ActionResult;PASS:Lnet/minecraft/util/ActionResult;

    • FAIL

      public static final ActionResult FAIL
      Indicates that an action is not performed and prevents other actions from performing.
      Mappings:
      Namespace Name Mixin selector
      official e Lbcm;e:Lbcm;
      intermediary field_5814 Lnet/minecraft/class_1269;field_5814:Lnet/minecraft/class_1269;
      named FAIL Lnet/minecraft/util/ActionResult;FAIL:Lnet/minecraft/util/ActionResult;

  • Constructor Details

    • ActionResult

      private ActionResult()

  • Method Details

    • values

      public static ActionResult[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ActionResult valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isAccepted

      public boolean isAccepted()
      Returns whether an action is performed.
      Returns:
      whether an action is performed
      Mappings:
      Namespace Name Mixin selector
      official a Lbcm;a()Z
      intermediary method_23665 Lnet/minecraft/class_1269;method_23665()Z
      named isAccepted Lnet/minecraft/util/ActionResult;isAccepted()Z

    • shouldSwingHand

      public boolean shouldSwingHand()
      Returns whether an actor should have a hand-swinging animation on action performance.
      Returns:
      whether an actor should have a hand-swinging animation on action performance
      Mappings:
      Namespace Name Mixin selector
      official b Lbcm;b()Z
      intermediary method_23666 Lnet/minecraft/class_1269;method_23666()Z
      named shouldSwingHand Lnet/minecraft/util/ActionResult;shouldSwingHand()Z

    • shouldIncrementStat

      public boolean shouldIncrementStat()
      Returns whether action performance should increment an item's "used" statistic.
      Returns:
      whether action performance should increment an item's "used" statistic
      Mappings:
      Namespace Name Mixin selector
      official c Lbcm;c()Z
      intermediary method_36360 Lnet/minecraft/class_1269;method_36360()Z
      named shouldIncrementStat Lnet/minecraft/util/ActionResult;shouldIncrementStat()Z

    • success

      public static ActionResult success(boolean swingHand)
      Returns an action result indicating success.

      This returns SUCCESS if swingHand is true, otherwise CONSUME.

      Returns:
      an action result indicating success
      Mappings:
      Namespace Name Mixin selector
      official a Lbcm;a(Z)Lbcm;
      intermediary method_29236 Lnet/minecraft/class_1269;method_29236(Z)Lnet/minecraft/class_1269;
      named success Lnet/minecraft/util/ActionResult;success(Z)Lnet/minecraft/util/ActionResult;