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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	KeyMapping.Category

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String,KeyMapping>	ALL
private final KeyMapping.Category	category
private int	clickCount
private final InputConstants.Key	defaultKey
(package private) boolean	isDown
protected 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 pKey, KeyMapping.Category pCategory)
KeyMapping(String pName, InputConstants.Type pType, int pKey, KeyMapping.Category pCategory)
KeyMapping(String name, IKeyConflictContext keyConflictContext, InputConstants.Key keyCode, KeyMapping.Category category)	Convenience constructor for creating KeyMappings with keyConflictContext set.
KeyMapping(String name, IKeyConflictContext keyConflictContext, InputConstants.Type inputType, int keyCode, KeyMapping.Category category)	Convenience constructor for creating KeyMappings with keyConflictContext set.
KeyMapping(String name, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputConstants.Key keyCode, KeyMapping.Category category)	Convenience constructor for creating KeyMappings with keyConflictContext and keyModifier set.
KeyMapping(String name, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputConstants.Type inputType, int keyCode, KeyMapping.Category category)	Convenience constructor for creating KeyMappings 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)
private static void	forAllKeyMappings(InputConstants.Key pKey, Consumer<KeyMapping> pAction)
private static void	forAllKeyMappings(InputConstants.Key pKey, Consumer<KeyMapping> pAction, boolean releasing)
static KeyMapping	get(String pName)
KeyMapping.Category	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(KeyEvent pEvent)
boolean	matchesMouse(MouseButtonEvent pEvent)
private void	registerMapping(InputConstants.Key pKey)
protected void	release()
static void	releaseAll()
static void	resetMapping()
static void	resetToggleKeys()
static void	restoreToggleStatesOnScreenClosed()
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)
protected boolean	shouldSetOnIngameFocus()

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

name

private final String name

defaultKey

private final InputConstants.Key defaultKey

category

private final KeyMapping.Category category

key

protected 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 pKey,
 KeyMapping.Category pCategory)

KeyMapping

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

KeyMapping

public KeyMapping(String name,
 IKeyConflictContext keyConflictContext,
 InputConstants.Type inputType,
 int keyCode,
 KeyMapping.Category category)

Convenience constructor for creating KeyMappings with keyConflictContext set.

KeyMapping

public KeyMapping(String name,
 IKeyConflictContext keyConflictContext,
 InputConstants.Key keyCode,
 KeyMapping.Category category)

Convenience constructor for creating KeyMappings with keyConflictContext set.

KeyMapping

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

Convenience constructor for creating KeyMappings with keyConflictContext and keyModifier set.

KeyMapping

public KeyMapping(String name,
 IKeyConflictContext keyConflictContext,
 KeyModifier keyModifier,
 InputConstants.Key keyCode,
 KeyMapping.Category category)

Convenience constructor for creating KeyMappings 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)

forAllKeyMappings

private static void forAllKeyMappings(InputConstants.Key pKey,
 Consumer<KeyMapping> pAction)

forAllKeyMappings

private static void forAllKeyMappings(InputConstants.Key pKey,
 Consumer<KeyMapping> pAction,
 boolean releasing)

setAll

public static void setAll()

releaseAll

public static void releaseAll()

restoreToggleStatesOnScreenClosed

public static void restoreToggleStatesOnScreenClosed()

resetToggleKeys

public static void resetToggleKeys()

resetMapping

public static void resetMapping()

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

isDown

public boolean isDown()

getCategory

public KeyMapping.Category getCategory()

consumeClick

public boolean consumeClick()

release

protected void release()

shouldSetOnIngameFocus

protected boolean shouldSetOnIngameFocus()

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(KeyEvent pEvent)

matchesMouse

public boolean matchesMouse(MouseButtonEvent pEvent)

getTranslatedKeyMessage

public Component getTranslatedKeyMessage()

isDefault

public boolean isDefault()

saveString

public String saveString()

setDown

public void setDown(boolean pValue)

registerMapping

private void registerMapping(InputConstants.Key pKey)

get

@Nullable
public static KeyMapping get(String pName)