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
named net/minecraft/client/option/KeyBinding
intermediary net/minecraft/class_304
official fzx

  • Field Details

    • KEYS_BY_ID

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

    • KEY_TO_BINDINGS

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

    • id

      private final String id
      Mappings:
      Namespace Name Mixin selector
      named id Lnet/minecraft/client/option/KeyBinding;id:Ljava/lang/String;
      intermediary field_1660 Lnet/minecraft/class_304;field_1660:Ljava/lang/String;
      official d Lfzx;d:Ljava/lang/String;

    • defaultKey

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

    • category

      private final KeyBinding.Category category
      Mappings:
      Namespace Name Mixin selector
      named category Lnet/minecraft/client/option/KeyBinding;category:Lnet/minecraft/client/option/KeyBinding$Category;
      intermediary field_1659 Lnet/minecraft/class_304;field_1659:Lnet/minecraft/class_304$class_11900;
      official f Lfzx;f:Lfzx$a;

    • boundKey

      protected InputUtil.Key boundKey
      Mappings:
      Namespace Name Mixin selector
      named boundKey Lnet/minecraft/client/option/KeyBinding;boundKey:Lnet/minecraft/client/util/InputUtil$Key;
      intermediary field_1655 Lnet/minecraft/class_304;field_1655:Lnet/minecraft/class_3675$class_306;
      official a Lfzx;a:Lfst$a;

    • pressed

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

    • timesPressed

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

  • Constructor Details

    • KeyBinding

      public KeyBinding(String id, int code, KeyBinding.Category category)
      Mappings:
      Namespace Name Mixin selector
      named <init> Lnet/minecraft/client/option/KeyBinding;<init>(Ljava/lang/String;ILnet/minecraft/client/option/KeyBinding$Category;)V
      intermediary <init> Lnet/minecraft/class_304;<init>(Ljava/lang/String;ILnet/minecraft/class_304$class_11900;)V
      official <init> Lfzx;<init>(Ljava/lang/String;ILfzx$a;)V

    • KeyBinding

      public KeyBinding(String id, InputUtil.Type type, int code, KeyBinding.Category category)
      Mappings:
      Namespace Name Mixin selector
      named <init> Lnet/minecraft/client/option/KeyBinding;<init>(Ljava/lang/String;Lnet/minecraft/client/util/InputUtil$Type;ILnet/minecraft/client/option/KeyBinding$Category;)V
      intermediary <init> Lnet/minecraft/class_304;<init>(Ljava/lang/String;Lnet/minecraft/class_3675$class_307;ILnet/minecraft/class_304$class_11900;)V
      official <init> Lfzx;<init>(Ljava/lang/String;Lfst$b;ILfzx$a;)V

  • Method Details

    • onKeyPressed

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

    • setKeyPressed

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

    • forAllKeyBinds

      private static void forAllKeyBinds(InputUtil.Key key, Consumer<KeyBinding> keyConsumer)
      Mappings:
      Namespace Name Mixin selector
      named forAllKeyBinds Lnet/minecraft/client/option/KeyBinding;forAllKeyBinds(Lnet/minecraft/client/util/InputUtil$Key;Ljava/util/function/Consumer;)V
      intermediary method_74179 Lnet/minecraft/class_304;method_74179(Lnet/minecraft/class_3675$class_306;Ljava/util/function/Consumer;)V
      official a Lfzx;a(Lfst$a;Ljava/util/function/Consumer;)V

    • updatePressedStates

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

    • unpressAll

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

    • restoreToggleStates

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

    • untoggleStickyKeys

      public static void untoggleStickyKeys()
      Mappings:
      Namespace Name Mixin selector
      named untoggleStickyKeys Lnet/minecraft/client/option/KeyBinding;untoggleStickyKeys()V
      intermediary method_52231 Lnet/minecraft/class_304;method_52231()V
      official d Lfzx;d()V

    • updateKeysByCode

      public static void updateKeysByCode()
      Mappings:
      Namespace Name Mixin selector
      named updateKeysByCode Lnet/minecraft/client/option/KeyBinding;updateKeysByCode()V
      intermediary method_1426 Lnet/minecraft/class_304;method_1426()V
      official e Lfzx;e()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
      named isPressed Lnet/minecraft/client/option/KeyBinding;isPressed()Z
      intermediary method_1434 Lnet/minecraft/class_304;method_1434()Z
      official f Lfzx;f()Z

    • getCategory

      public KeyBinding.Category getCategory()
      Mappings:
      Namespace Name Mixin selector
      named getCategory Lnet/minecraft/client/option/KeyBinding;getCategory()Lnet/minecraft/client/option/KeyBinding$Category;
      intermediary method_1423 Lnet/minecraft/class_304;method_1423()Lnet/minecraft/class_304$class_11900;
      official g Lfzx;g()Lfzx$a;

    • 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
      named wasPressed Lnet/minecraft/client/option/KeyBinding;wasPressed()Z
      intermediary method_1436 Lnet/minecraft/class_304;method_1436()Z
      official h Lfzx;h()Z

    • reset

      protected void reset()
      Mappings:
      Namespace Name Mixin selector
      named reset Lnet/minecraft/client/option/KeyBinding;reset()V
      intermediary method_1425 Lnet/minecraft/class_304;method_1425()V
      official i Lfzx;i()V

    • shouldSetOnGameFocus

      protected boolean shouldSetOnGameFocus()
      Mappings:
      Namespace Name Mixin selector
      named shouldSetOnGameFocus Lnet/minecraft/client/option/KeyBinding;shouldSetOnGameFocus()Z
      intermediary method_72701 Lnet/minecraft/class_304;method_72701()Z
      official j Lfzx;j()Z

    • getId

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

    • getDefaultKey

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

    • setBoundKey

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

    • compareTo

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

    • getLocalizedName

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

    • equals

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

    • isUnbound

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

    • matchesKey

      public boolean matchesKey(KeyInput key)
      Mappings:
      Namespace Name Mixin selector
      named matchesKey Lnet/minecraft/client/option/KeyBinding;matchesKey(Lnet/minecraft/client/input/KeyInput;)Z
      intermediary method_1417 Lnet/minecraft/class_304;method_1417(Lnet/minecraft/class_11908;)Z
      official a Lfzx;a(Lgth;)Z

    • matchesMouse

      public boolean matchesMouse(Click click)
      Mappings:
      Namespace Name Mixin selector
      named matchesMouse Lnet/minecraft/client/option/KeyBinding;matchesMouse(Lnet/minecraft/client/gui/Click;)Z
      intermediary method_1433 Lnet/minecraft/class_304;method_1433(Lnet/minecraft/class_11909;)Z
      official a Lfzx;a(Lgti;)Z

    • getBoundKeyLocalizedText

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

    • isDefault

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

    • getBoundKeyTranslationKey

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

    • setPressed

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

    • registerBinding

      private void registerBinding(InputUtil.Key key)
      Mappings:
      Namespace Name Mixin selector
      named registerBinding Lnet/minecraft/client/option/KeyBinding;registerBinding(Lnet/minecraft/client/util/InputUtil$Key;)V
      intermediary method_74181 Lnet/minecraft/class_304;method_74181(Lnet/minecraft/class_3675$class_306;)V
      official c Lfzx;c(Lfst$a;)V

    • byId

      @Nullable public static @Nullable KeyBinding byId(String id)
      Mappings:
      Namespace Name Mixin selector
      named byId Lnet/minecraft/client/option/KeyBinding;byId(Ljava/lang/String;)Lnet/minecraft/client/option/KeyBinding;
      intermediary method_65807 Lnet/minecraft/class_304;method_65807(Ljava/lang/String;)Lnet/minecraft/class_304;
      official b Lfzx;b(Ljava/lang/String;)Lfzx;