Package net.neoforged.neoforge.client.settings

Enum Class KeyModifier

java.lang.Object
java.lang.Enum<KeyModifier>
net.neoforged.neoforge.client.settings.KeyModifier
All Implemented Interfaces:
Serializable, Comparable<KeyModifier>, Constable
public enum KeyModifier extends Enum<KeyModifier>

  • Enum Constant Details

    • CONTROL

      public static final KeyModifier CONTROL
      Always matches the Control Key, even on OSX which normally uses the Command Key for hotkeys. Since 1.21.11, Mojang uses Control on OSX for hotkeys that conflict with OSX global system shortcuts.

      For hotkeys that should use the Command key on OSX (like system hotkeys ⌘C for copy, ⌘P for paste, etc.), use CONTROL_OR_COMMAND instead. For examples of places where Command should be used, see uses of `net.minecraft.client.input.InputWithModifiers#hasControlDownWithQuirk()`.

    • CONTROL_OR_COMMAND

      public static final KeyModifier CONTROL_OR_COMMAND
      On Windows and Linux, this matches the Control Key. On OSX, this matches the Command Key (⌘).

      This is the default behavior expected by OSX players for system hotkeys (like ⌘C for copy, ⌘P for paste, etc.), and this follows the InputQuirks.REPLACE_CTRL_KEY_WITH_CMD_KEY rule. For examples of places where Command should be used, see uses of `net.minecraft.client.input.InputWithModifiers#hasControlDownWithQuirk()`.

      For hotkeys that should use Control even on OSX, use CONTROL instead.

      Since 1.21.11, Mojang uses Control on OSX for hotkeys that conflict with OSX global system shortcuts. Use caution when setting default hotkeys with this modifier, because it's possible to end up minimizing the window or triggering some other system behavior instead of what you intended.

    • SHIFT

      public static final KeyModifier SHIFT

    • ALT

      public static final KeyModifier ALT

    • NONE

      public static final KeyModifier NONE

  • Field Details

    • MODIFIER_VALUES

      public static final KeyModifier[] MODIFIER_VALUES

  • Constructor Details

    • KeyModifier

      private KeyModifier()

  • Method Details

    • values

      public static KeyModifier[] 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 KeyModifier 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

    • getActiveModifiers

      public static List<KeyModifier> getActiveModifiers()

    • getKeyModifier

      public static KeyModifier getKeyModifier(InputConstants.Key key)

    • isKeyCodeModifier

      public static boolean isKeyCodeModifier(InputConstants.Key key)

    • valueFromString

      public static KeyModifier valueFromString(String stringValue)

    • matches

      public abstract boolean matches(InputConstants.Key key)

    • isActive

      public abstract boolean isActive(@Nullable IKeyConflictContext conflictContext)

    • getCombinedName

      public abstract Component getCombinedName(InputConstants.Key key, Supplier<Component> defaultLogic)

    • codes

      public abstract InputConstants.Key[] codes()