Package net.minecraft.client

Class KeyMapping

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
private static final KeyMappingLookup	MAP
private final String	name

Constructor Summary

Constructors

Constructor	Description
KeyMapping(String pName, int pKeyCode, String pCategory)
KeyMapping(String pName, InputConstants.Type pType, int pKeyCode, String pCategory)
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 pKey)
int	compareTo(KeyMapping pOther)
boolean	consumeClick()
static Supplier<Component>	createNameSupplier(String pKey)	Returns a supplier which gets a keybind's current binding (eg, key.forward returns W by default), or the keybind's name if no such keybind exists (eg, key.invalid returns key.invalid)
static KeyMapping	get(String pName)
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 pKeysym, int pScancode)
boolean	matchesMouse(int pKey)	Returns true if the KeyMapping is set to a mouse key and the key matches.
private void	release()
static void	releaseAll()
static void	resetMapping()
static void	resetToggleKeys()
boolean	same(KeyMapping pBinding)	Returns true if the supplied KeyMapping conflicts with this
String	saveString()
static void	set(InputConstants.Key pKey, boolean pHeld)
static void	setAll()
void	setDown(boolean pValue)
void	setKey(InputConstants.Key pKey)	Binds a new KeyCode to this
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

getDisplayName, 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

keyModifier

private KeyModifier keyModifier

keyConflictContext

private IKeyConflictContext keyConflictContext

Constructor Details

KeyMapping

public KeyMapping(String pName,
 int pKeyCode,
 String pCategory)

KeyMapping

public KeyMapping(String pName,
 InputConstants.Type pType,
 int pKeyCode,
 String pCategory)

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 pKey)

set

public static void set(InputConstants.Key pKey,
 boolean pHeld)

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 pKey)

Binds a new KeyCode to this

compareTo

public int compareTo(KeyMapping pOther)

Specified by:

compareTo in interface Comparable<KeyMapping>

createNameSupplier

public static Supplier<Component> createNameSupplier(String pKey)

Returns a supplier which gets a keybind's current binding (eg, key.forward returns W by default), or the keybind's name if no such keybind exists (eg, key.invalid returns key.invalid)

same

public boolean same(KeyMapping pBinding)

Returns true if the supplied KeyMapping conflicts with this

isUnbound

public boolean isUnbound()

matches

public boolean matches(int pKeysym,
 int pScancode)

matchesMouse

public boolean matchesMouse(int pKey)

Returns true if the KeyMapping is set to a mouse key and the key matches.

getTranslatedKeyMessage

public Component getTranslatedKeyMessage()

isDefault

public boolean isDefault()

saveString

public String saveString()

setDown

public void setDown(boolean pValue)

get

@Nullable
public static KeyMapping get(String pName)

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