java.lang.Object

net.minecraft.client.KeyMapping

All Implemented Interfaces:: Comparable<KeyMapping>, IKeyMappingExtension

Direct Known Subclasses:: ToggleKeyMapping

public class KeyMapping extends Object implements Comparable<KeyMapping>, IKeyMappingExtension

Field Summary

Fields

Modifier and Type

Field

Description

private static final Map<String,KeyMapping>

ALL

private static final Set<String>

CATEGORIES

private final String

category

static final String

CATEGORY_CREATIVE

static final String

CATEGORY_GAMEPLAY

static final String

CATEGORY_INTERFACE

static final String

CATEGORY_INVENTORY

static final String

CATEGORY_MISC

static final String

CATEGORY_MOVEMENT

static final String

CATEGORY_MULTIPLAYER

private static final Map<String,Integer>

CATEGORY_SORT_ORDER

private int

clickCount

private final InputConstants.Key

defaultKey

(package private) boolean

isDown

private InputConstants.Key

key

private IKeyConflictContext

keyConflictContext

private KeyModifier

keyModifier

private KeyModifier

keyModifierDefault

Forge Start

private static final KeyMappingLookup

MAP

private final String

name
Constructor Summary

Constructors

Constructor

Description

KeyMapping(String p_90821_, int p_90822_, String p_90823_)

KeyMapping(String p_90825_, InputConstants.Type p_90826_, int p_90827_, String p_90828_)

KeyMapping(String description, IKeyConflictContext keyConflictContext, InputConstants.Key keyCode, String category)

Convenience constructor for creating KeyBindings with keyConflictContext set.

KeyMapping(String description, IKeyConflictContext keyConflictContext, InputConstants.Type inputType, int keyCode, String category)

Convenience constructor for creating KeyBindings with keyConflictContext set.

KeyMapping(String description, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputConstants.Key keyCode, String category)

Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.

KeyMapping(String description, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputConstants.Type inputType, int keyCode, String category)

Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.
Method Summary

Modifier and Type

Method

Description

static void

click(InputConstants.Key p_90836_)

int

compareTo(KeyMapping p_90841_)

boolean

consumeClick()

static Supplier<Component>

createNameSupplier(String p_90843_)

String

getCategory()

InputConstants.Key

getDefaultKey()

KeyModifier

getDefaultKeyModifier()

InputConstants.Key

getKey()

IKeyConflictContext

getKeyConflictContext()

KeyModifier

getKeyModifier()

String

getName()

Component

getTranslatedKeyMessage()

boolean

isDefault()

boolean

isDown()

boolean

isUnbound()

boolean

matches(int p_90833_, int p_90834_)

boolean

matchesMouse(int p_90831_)

private void

release()

static void

releaseAll()

static void

resetMapping()

static void

resetToggleKeys()

boolean

same(KeyMapping p_90851_)

String

saveString()

static void

set(InputConstants.Key p_90838_, boolean p_90839_)

static void

setAll()

void

setDown(boolean p_90846_)

void

setKey(InputConstants.Key p_90849_)

void

setKeyConflictContext(IKeyConflictContext keyConflictContext)

void

setKeyModifierAndCode(KeyModifier keyModifier, InputConstants.Key keyCode)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.neoforge.client.extensions.IKeyMappingExtension
hasKeyModifierConflict, isActiveAndMatches, isConflictContextAndModifierActive, setToDefault

Field Details
- ALL
  
  private static final Map<String,KeyMapping> ALL
- MAP
  
  private static final KeyMappingLookup MAP
- CATEGORIES
  
  private static final Set<String> CATEGORIES
- CATEGORY_MOVEMENT
  
  public static final String CATEGORY_MOVEMENT
  See Also:
  
  Constant Field Values
- CATEGORY_MISC
  
  public static final String CATEGORY_MISC
  See Also:
  
  Constant Field Values
- CATEGORY_MULTIPLAYER
  
  public static final String CATEGORY_MULTIPLAYER
  See Also:
  
  Constant Field Values
- CATEGORY_GAMEPLAY
  
  public static final String CATEGORY_GAMEPLAY
  See Also:
  
  Constant Field Values
- CATEGORY_INVENTORY
  
  public static final String CATEGORY_INVENTORY
  See Also:
  
  Constant Field Values
- CATEGORY_INTERFACE
  
  public static final String CATEGORY_INTERFACE
  See Also:
  
  Constant Field Values
- CATEGORY_CREATIVE
  
  public static final String CATEGORY_CREATIVE
  See Also:
  
  Constant Field Values
- CATEGORY_SORT_ORDER
  
  private static final Map<String,Integer> CATEGORY_SORT_ORDER
- name
  
  private final String name
- defaultKey
  
  private final InputConstants.Key defaultKey
- category
  
  private final String category
- key
  
  private InputConstants.Key key
- isDown
  
  boolean isDown
- clickCount
  
  private int clickCount
- keyModifierDefault
  
  private KeyModifier keyModifierDefault
  
  Forge Start
- keyModifier
  
  private KeyModifier keyModifier
- keyConflictContext
  
  private IKeyConflictContext keyConflictContext
Constructor Details
- KeyMapping
  
  public KeyMapping(String p_90821_, int p_90822_, String p_90823_)
- KeyMapping
  
  public KeyMapping(String p_90825_, InputConstants.Type p_90826_, int p_90827_, String p_90828_)
- KeyMapping
  
  public KeyMapping(String description, IKeyConflictContext keyConflictContext, InputConstants.Type inputType, int keyCode, String category)
  
  Convenience constructor for creating KeyBindings with keyConflictContext set.
- KeyMapping
  
  public KeyMapping(String description, IKeyConflictContext keyConflictContext, InputConstants.Key keyCode, String category)
  
  Convenience constructor for creating KeyBindings with keyConflictContext set.
- KeyMapping
  
  public KeyMapping(String description, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputConstants.Type inputType, int keyCode, String category)
  
  Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.
- KeyMapping
  
  public KeyMapping(String description, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputConstants.Key keyCode, String category)
  
  Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.
Method Details
- click
  
  public static void click(InputConstants.Key p_90836_)
- set
  
  public static void set(InputConstants.Key p_90838_, boolean p_90839_)
- setAll
  
  public static void setAll()
- releaseAll
  
  public static void releaseAll()
- resetToggleKeys
  
  public static void resetToggleKeys()
- resetMapping
  
  public static void resetMapping()
- isDown
  
  public boolean isDown()
- getCategory
  
  public String getCategory()
- consumeClick
  
  public boolean consumeClick()
- release
  
  private void release()
- getName
  
  public String getName()
- getDefaultKey
  
  public InputConstants.Key getDefaultKey()
- setKey
  
  public void setKey(InputConstants.Key p_90849_)
- compareTo
  
  public int compareTo(KeyMapping p_90841_)
  
  Specified by:
  
  compareTo in interface Comparable<KeyMapping>
- createNameSupplier
  
  public static Supplier<Component> createNameSupplier(String p_90843_)
- same
  
  public boolean same(KeyMapping p_90851_)
- isUnbound
  
  public boolean isUnbound()
- matches
  
  public boolean matches(int p_90833_, int p_90834_)
- matchesMouse
  
  public boolean matchesMouse(int p_90831_)
- getTranslatedKeyMessage
  
  public Component getTranslatedKeyMessage()
- isDefault
  
  public boolean isDefault()
- saveString
  
  public String saveString()
- setDown
  
  public void setDown(boolean p_90846_)
- getKey
  
  public InputConstants.Key getKey()
  
  Specified by:
  
  getKey in interface IKeyMappingExtension
- setKeyConflictContext
  
  public void setKeyConflictContext(IKeyConflictContext keyConflictContext)
  
  Specified by:
  
  setKeyConflictContext in interface IKeyMappingExtension
- getKeyConflictContext
  
  public IKeyConflictContext getKeyConflictContext()
  
  Specified by:
  
  getKeyConflictContext in interface IKeyMappingExtension
- getDefaultKeyModifier
  
  public KeyModifier getDefaultKeyModifier()
  
  Specified by:
  
  getDefaultKeyModifier in interface IKeyMappingExtension
- getKeyModifier
  
  public KeyModifier getKeyModifier()
  
  Specified by:
  
  getKeyModifier in interface IKeyMappingExtension
- setKeyModifierAndCode
  
  public void setKeyModifierAndCode(KeyModifier keyModifier, InputConstants.Key keyCode)
  
  Specified by:
  
  setKeyModifierAndCode in interface IKeyMappingExtension

Class KeyMapping

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.neoforged.neoforge.client.extensions.IKeyMappingExtension

Field Details

ALL

MAP

CATEGORIES

CATEGORY_MOVEMENT

CATEGORY_MISC

CATEGORY_MULTIPLAYER

CATEGORY_GAMEPLAY

CATEGORY_INVENTORY

CATEGORY_INTERFACE

CATEGORY_CREATIVE

CATEGORY_SORT_ORDER

name

defaultKey

category

key

isDown

clickCount

keyModifierDefault

keyModifier

keyConflictContext

Constructor Details

KeyMapping

KeyMapping

KeyMapping

KeyMapping

KeyMapping

KeyMapping

Method Details

click

set

setAll

releaseAll

resetToggleKeys

resetMapping

isDown

getCategory

consumeClick

release

getName

getDefaultKey

setKey

compareTo

createNameSupplier

same

isUnbound

matches

matchesMouse

getTranslatedKeyMessage

isDefault

saveString

setDown

getKey

setKeyConflictContext

getKeyConflictContext

getDefaultKeyModifier

getKeyModifier

setKeyModifierAndCode