Package net.minecraft.client.option

Class KeyBinding

java.lang.Object
net.minecraft.client.option.KeyBinding
All Implemented Interfaces:
Comparable<KeyBinding>
Direct Known Subclasses:
StickyKeyBinding
@Environment(CLIENT) public class KeyBinding extends Object implements Comparable<KeyBinding>
Mappings:
Namespace Name
official end
intermediary net/minecraft/class_304
named net/minecraft/client/option/KeyBinding

  • Field Details

    • KEYS_BY_ID

      private static final Map<String,KeyBinding> KEYS_BY_ID
      Mappings:
      Namespace Name Mixin selector
      official h Lend;h:Ljava/util/Map;
      intermediary field_1657 Lnet/minecraft/class_304;field_1657:Ljava/util/Map;
      named KEYS_BY_ID Lnet/minecraft/client/option/KeyBinding;KEYS_BY_ID:Ljava/util/Map;

    • KEY_TO_BINDINGS

      private static final Map<InputUtil.Key,KeyBinding> KEY_TO_BINDINGS
      Mappings:
      Namespace Name Mixin selector
      official i Lend;i:Ljava/util/Map;
      intermediary field_1658 Lnet/minecraft/class_304;field_1658:Ljava/util/Map;
      named KEY_TO_BINDINGS Lnet/minecraft/client/option/KeyBinding;KEY_TO_BINDINGS:Ljava/util/Map;

    • KEY_CATEGORIES

      private static final Set<String> KEY_CATEGORIES
      Mappings:
      Namespace Name Mixin selector
      official j Lend;j:Ljava/util/Set;
      intermediary field_1652 Lnet/minecraft/class_304;field_1652:Ljava/util/Set;
      named KEY_CATEGORIES Lnet/minecraft/client/option/KeyBinding;KEY_CATEGORIES:Ljava/util/Set;

    • MOVEMENT_CATEGORY

      public static final String MOVEMENT_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a:Ljava/lang/String;
      intermediary field_32136 Lnet/minecraft/class_304;field_32136:Ljava/lang/String;
      named MOVEMENT_CATEGORY Lnet/minecraft/client/option/KeyBinding;MOVEMENT_CATEGORY:Ljava/lang/String;

    • MISC_CATEGORY

      public static final String MISC_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official b Lend;b:Ljava/lang/String;
      intermediary field_32137 Lnet/minecraft/class_304;field_32137:Ljava/lang/String;
      named MISC_CATEGORY Lnet/minecraft/client/option/KeyBinding;MISC_CATEGORY:Ljava/lang/String;

    • MULTIPLAYER_CATEGORY

      public static final String MULTIPLAYER_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official c Lend;c:Ljava/lang/String;
      intermediary field_32138 Lnet/minecraft/class_304;field_32138:Ljava/lang/String;
      named MULTIPLAYER_CATEGORY Lnet/minecraft/client/option/KeyBinding;MULTIPLAYER_CATEGORY:Ljava/lang/String;

    • GAMEPLAY_CATEGORY

      public static final String GAMEPLAY_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official d Lend;d:Ljava/lang/String;
      intermediary field_32139 Lnet/minecraft/class_304;field_32139:Ljava/lang/String;
      named GAMEPLAY_CATEGORY Lnet/minecraft/client/option/KeyBinding;GAMEPLAY_CATEGORY:Ljava/lang/String;

    • INVENTORY_CATEGORY

      public static final String INVENTORY_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official e Lend;e:Ljava/lang/String;
      intermediary field_32140 Lnet/minecraft/class_304;field_32140:Ljava/lang/String;
      named INVENTORY_CATEGORY Lnet/minecraft/client/option/KeyBinding;INVENTORY_CATEGORY:Ljava/lang/String;

    • UI_CATEGORY

      public static final String UI_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official f Lend;f:Ljava/lang/String;
      intermediary field_32141 Lnet/minecraft/class_304;field_32141:Ljava/lang/String;
      named UI_CATEGORY Lnet/minecraft/client/option/KeyBinding;UI_CATEGORY:Ljava/lang/String;

    • CREATIVE_CATEGORY

      public static final String CREATIVE_CATEGORY
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official g Lend;g:Ljava/lang/String;
      intermediary field_32142 Lnet/minecraft/class_304;field_32142:Ljava/lang/String;
      named CREATIVE_CATEGORY Lnet/minecraft/client/option/KeyBinding;CREATIVE_CATEGORY:Ljava/lang/String;

    • CATEGORY_ORDER_MAP

      private static final Map<String,Integer> CATEGORY_ORDER_MAP
      Mappings:
      Namespace Name Mixin selector
      official k Lend;k:Ljava/util/Map;
      intermediary field_1656 Lnet/minecraft/class_304;field_1656:Ljava/util/Map;
      named CATEGORY_ORDER_MAP Lnet/minecraft/client/option/KeyBinding;CATEGORY_ORDER_MAP:Ljava/util/Map;

    • translationKey

      private final String translationKey
      Mappings:
      Namespace Name Mixin selector
      official l Lend;l:Ljava/lang/String;
      intermediary field_1660 Lnet/minecraft/class_304;field_1660:Ljava/lang/String;
      named translationKey Lnet/minecraft/client/option/KeyBinding;translationKey:Ljava/lang/String;

    • defaultKey

      private final InputUtil.Key defaultKey
      Mappings:
      Namespace Name Mixin selector
      official m Lend;m:Legw$a;
      intermediary field_1654 Lnet/minecraft/class_304;field_1654:Lnet/minecraft/class_3675$class_306;
      named defaultKey Lnet/minecraft/client/option/KeyBinding;defaultKey:Lnet/minecraft/client/util/InputUtil$Key;

    • category

      private final String category
      Mappings:
      Namespace Name Mixin selector
      official n Lend;n:Ljava/lang/String;
      intermediary field_1659 Lnet/minecraft/class_304;field_1659:Ljava/lang/String;
      named category Lnet/minecraft/client/option/KeyBinding;category:Ljava/lang/String;

    • boundKey

      private InputUtil.Key boundKey
      Mappings:
      Namespace Name Mixin selector
      official o Lend;o:Legw$a;
      intermediary field_1655 Lnet/minecraft/class_304;field_1655:Lnet/minecraft/class_3675$class_306;
      named boundKey Lnet/minecraft/client/option/KeyBinding;boundKey:Lnet/minecraft/client/util/InputUtil$Key;

    • pressed

      private boolean pressed
      Mappings:
      Namespace Name Mixin selector
      official p Lend;p:Z
      intermediary field_1653 Lnet/minecraft/class_304;field_1653:Z
      named pressed Lnet/minecraft/client/option/KeyBinding;pressed:Z

    • timesPressed

      private int timesPressed
      Mappings:
      Namespace Name Mixin selector
      official q Lend;q:I
      intermediary field_1661 Lnet/minecraft/class_304;field_1661:I
      named timesPressed Lnet/minecraft/client/option/KeyBinding;timesPressed:I

  • Constructor Details

    • KeyBinding

      public KeyBinding(String translationKey, int code, String category)
      Mappings:
      Namespace Name Mixin selector
      official <init> Lend;<init>(Ljava/lang/String;ILjava/lang/String;)V
      intermediary <init> Lnet/minecraft/class_304;<init>(Ljava/lang/String;ILjava/lang/String;)V
      named <init> Lnet/minecraft/client/option/KeyBinding;<init>(Ljava/lang/String;ILjava/lang/String;)V

    • KeyBinding

      public KeyBinding(String translationKey, InputUtil.Type type, int code, String category)
      Mappings:
      Namespace Name Mixin selector
      official <init> Lend;<init>(Ljava/lang/String;Legw$b;ILjava/lang/String;)V
      intermediary <init> Lnet/minecraft/class_304;<init>(Ljava/lang/String;Lnet/minecraft/class_3675$class_307;ILjava/lang/String;)V
      named <init> Lnet/minecraft/client/option/KeyBinding;<init>(Ljava/lang/String;Lnet/minecraft/client/util/InputUtil$Type;ILjava/lang/String;)V

  • Method Details

    • onKeyPressed

      public static void onKeyPressed(InputUtil.Key key)
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(Legw$a;)V
      intermediary method_1420 Lnet/minecraft/class_304;method_1420(Lnet/minecraft/class_3675$class_306;)V
      named onKeyPressed Lnet/minecraft/client/option/KeyBinding;onKeyPressed(Lnet/minecraft/client/util/InputUtil$Key;)V

    • setKeyPressed

      public static void setKeyPressed(InputUtil.Key key, boolean pressed)
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(Legw$a;Z)V
      intermediary method_1416 Lnet/minecraft/class_304;method_1416(Lnet/minecraft/class_3675$class_306;Z)V
      named setKeyPressed Lnet/minecraft/client/option/KeyBinding;setKeyPressed(Lnet/minecraft/client/util/InputUtil$Key;Z)V

    • updatePressedStates

      public static void updatePressedStates()
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a()V
      intermediary method_1424 Lnet/minecraft/class_304;method_1424()V
      named updatePressedStates Lnet/minecraft/client/option/KeyBinding;updatePressedStates()V

    • unpressAll

      public static void unpressAll()
      Mappings:
      Namespace Name Mixin selector
      official b Lend;b()V
      intermediary method_1437 Lnet/minecraft/class_304;method_1437()V
      named unpressAll Lnet/minecraft/client/option/KeyBinding;unpressAll()V

    • updateKeysByCode

      public static void updateKeysByCode()
      Mappings:
      Namespace Name Mixin selector
      official c Lend;c()V
      intermediary method_1426 Lnet/minecraft/class_304;method_1426()V
      named updateKeysByCode Lnet/minecraft/client/option/KeyBinding;updateKeysByCode()V

    • isPressed

      public boolean isPressed()
      Returns if the key is being held down.

      Note that if you are continuously calling this method (like every tick), it doesn't always catch all key presses. This is because the key can be pressed and released before the next check.

      Returns:
      if the key is being held down
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official d Lend;d()Z
      intermediary method_1434 Lnet/minecraft/class_304;method_1434()Z
      named isPressed Lnet/minecraft/client/option/KeyBinding;isPressed()Z

    • getCategory

      public String getCategory()
      Mappings:
      Namespace Name Mixin selector
      official e Lend;e()Ljava/lang/String;
      intermediary method_1423 Lnet/minecraft/class_304;method_1423()Ljava/lang/String;
      named getCategory Lnet/minecraft/client/option/KeyBinding;getCategory()Ljava/lang/String;

    • wasPressed

      public boolean wasPressed()
      Returns if the key was pressed.

      A key binding counts the number of times the key is pressed. This method "consumes" it and returns true as many times as the key is pressed.

      To consume all remaining key presses, while-loop idiom can be used: 

       
 while(keyBinding.wasPressed()) {
   // do your action
 }
      Returns:
      if the key was pressed
      See Also:
      Mappings:
      Namespace Name Mixin selector
      official f Lend;f()Z
      intermediary method_1436 Lnet/minecraft/class_304;method_1436()Z
      named wasPressed Lnet/minecraft/client/option/KeyBinding;wasPressed()Z

    • reset

      private void reset()
      Mappings:
      Namespace Name Mixin selector
      official m Lend;m()V
      intermediary method_1425 Lnet/minecraft/class_304;method_1425()V
      named reset Lnet/minecraft/client/option/KeyBinding;reset()V

    • getTranslationKey

      public String getTranslationKey()
      Mappings:
      Namespace Name Mixin selector
      official g Lend;g()Ljava/lang/String;
      intermediary method_1431 Lnet/minecraft/class_304;method_1431()Ljava/lang/String;
      named getTranslationKey Lnet/minecraft/client/option/KeyBinding;getTranslationKey()Ljava/lang/String;

    • getDefaultKey

      public InputUtil.Key getDefaultKey()
      Mappings:
      Namespace Name Mixin selector
      official h Lend;h()Legw$a;
      intermediary method_1429 Lnet/minecraft/class_304;method_1429()Lnet/minecraft/class_3675$class_306;
      named getDefaultKey Lnet/minecraft/client/option/KeyBinding;getDefaultKey()Lnet/minecraft/client/util/InputUtil$Key;

    • setBoundKey

      public void setBoundKey(InputUtil.Key boundKey)
      Mappings:
      Namespace Name Mixin selector
      official b Lend;b(Legw$a;)V
      intermediary method_1422 Lnet/minecraft/class_304;method_1422(Lnet/minecraft/class_3675$class_306;)V
      named setBoundKey Lnet/minecraft/client/option/KeyBinding;setBoundKey(Lnet/minecraft/client/util/InputUtil$Key;)V

    • compareTo

      public int compareTo(KeyBinding keyBinding)
      Specified by:
      compareTo in interface Comparable<KeyBinding>
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(Lend;)I
      intermediary method_1430 Lnet/minecraft/class_304;method_1430(Lnet/minecraft/class_304;)I
      named compareTo Lnet/minecraft/client/option/KeyBinding;compareTo(Lnet/minecraft/client/option/KeyBinding;)I

    • getLocalizedName

      public static Supplier<Text> getLocalizedName(String id)
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(Ljava/lang/String;)Ljava/util/function/Supplier;
      intermediary method_1419 Lnet/minecraft/class_304;method_1419(Ljava/lang/String;)Ljava/util/function/Supplier;
      named getLocalizedName Lnet/minecraft/client/option/KeyBinding;getLocalizedName(Ljava/lang/String;)Ljava/util/function/Supplier;

    • equals

      public boolean equals(KeyBinding other)
      Mappings:
      Namespace Name Mixin selector
      official b Lend;b(Lend;)Z
      intermediary method_1435 Lnet/minecraft/class_304;method_1435(Lnet/minecraft/class_304;)Z
      named equals Lnet/minecraft/client/option/KeyBinding;equals(Lnet/minecraft/client/option/KeyBinding;)Z

    • isUnbound

      public boolean isUnbound()
      Mappings:
      Namespace Name Mixin selector
      official i Lend;i()Z
      intermediary method_1415 Lnet/minecraft/class_304;method_1415()Z
      named isUnbound Lnet/minecraft/client/option/KeyBinding;isUnbound()Z

    • matchesKey

      public boolean matchesKey(int keyCode, int scanCode)
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(II)Z
      intermediary method_1417 Lnet/minecraft/class_304;method_1417(II)Z
      named matchesKey Lnet/minecraft/client/option/KeyBinding;matchesKey(II)Z

    • matchesMouse

      public boolean matchesMouse(int code)
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(I)Z
      intermediary method_1433 Lnet/minecraft/class_304;method_1433(I)Z
      named matchesMouse Lnet/minecraft/client/option/KeyBinding;matchesMouse(I)Z

    • getBoundKeyLocalizedText

      public Text getBoundKeyLocalizedText()
      Mappings:
      Namespace Name Mixin selector
      official j Lend;j()Lsw;
      intermediary method_16007 Lnet/minecraft/class_304;method_16007()Lnet/minecraft/class_2561;
      named getBoundKeyLocalizedText Lnet/minecraft/client/option/KeyBinding;getBoundKeyLocalizedText()Lnet/minecraft/text/Text;

    • isDefault

      public boolean isDefault()
      Mappings:
      Namespace Name Mixin selector
      official k Lend;k()Z
      intermediary method_1427 Lnet/minecraft/class_304;method_1427()Z
      named isDefault Lnet/minecraft/client/option/KeyBinding;isDefault()Z

    • getBoundKeyTranslationKey

      public String getBoundKeyTranslationKey()
      Mappings:
      Namespace Name Mixin selector
      official l Lend;l()Ljava/lang/String;
      intermediary method_1428 Lnet/minecraft/class_304;method_1428()Ljava/lang/String;
      named getBoundKeyTranslationKey Lnet/minecraft/client/option/KeyBinding;getBoundKeyTranslationKey()Ljava/lang/String;

    • setPressed

      public void setPressed(boolean pressed)
      Mappings:
      Namespace Name Mixin selector
      official a Lend;a(Z)V
      intermediary method_23481 Lnet/minecraft/class_304;method_23481(Z)V
      named setPressed Lnet/minecraft/client/option/KeyBinding;setPressed(Z)V