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
private final int	order

Constructor Summary

Constructors

Constructor	Description
KeyMapping(String name, int keysym, KeyMapping.Category category)
KeyMapping(String name, InputConstants.Type type, int value, KeyMapping.Category category)
KeyMapping(String name, InputConstants.Type type, int value, KeyMapping.Category category, int order)
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 key)
int	compareTo(KeyMapping o)
boolean	consumeClick()
static Supplier<Component>	createNameSupplier(String key)	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 key, Consumer<KeyMapping> operation)
private static void	forAllKeyMappings(InputConstants.Key key, Consumer<KeyMapping> operation, boolean releasing)
static @Nullable KeyMapping	get(String name)
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 event)
boolean	matchesMouse(MouseButtonEvent event)
private void	registerMapping(InputConstants.Key key)
protected void	release()
static void	releaseAll()
static void	resetMapping()
static void	resetToggleKeys()
static void	restoreToggleStatesOnScreenClosed()
boolean	same(KeyMapping that)	Returns true if the supplied KeyMapping conflicts with this
String	saveString()
static void	set(InputConstants.Key key, boolean state)
static void	setAll()
void	setDown(boolean down)
void	setKey(InputConstants.Key key)	Binds a new KeyCode to this
void	setKeyConflictContext(IKeyConflictContext keyConflictContext)
void	setKeyModifierAndCode(KeyModifier keyModifier, InputConstants.Key keyCode)
protected boolean	shouldSetOnIngameFocus()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface 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

order

private final int order

keyModifierDefault

private KeyModifier keyModifierDefault

keyModifier

private KeyModifier keyModifier

keyConflictContext

private IKeyConflictContext keyConflictContext

Constructor Details

KeyMapping

public KeyMapping(String name,
 int keysym,
 KeyMapping.Category category)

KeyMapping

public KeyMapping(String name,
 InputConstants.Type type,
 int value,
 KeyMapping.Category category)

KeyMapping

public KeyMapping(String name,
 InputConstants.Type type,
 int value,
 KeyMapping.Category category,
 int order)

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

set

public static void set(InputConstants.Key key,
 boolean state)

forAllKeyMappings

private static void forAllKeyMappings(InputConstants.Key key,
 Consumer<KeyMapping> operation)

forAllKeyMappings

private static void forAllKeyMappings(InputConstants.Key key,
 Consumer<KeyMapping> operation,
 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 key)

Binds a new KeyCode to this

compareTo

public int compareTo(KeyMapping o)

Specified by:

compareTo in interface Comparable<KeyMapping>

createNameSupplier

public static Supplier<Component> createNameSupplier(String key)

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

Returns true if the supplied KeyMapping conflicts with this

isUnbound

public boolean isUnbound()

matches

public boolean matches(KeyEvent event)

matchesMouse

public boolean matchesMouse(MouseButtonEvent event)

getTranslatedKeyMessage

public Component getTranslatedKeyMessage()

isDefault

public boolean isDefault()

saveString

public String saveString()

setDown

public void setDown(boolean down)

registerMapping

private void registerMapping(InputConstants.Key key)

get

public static @Nullable KeyMapping get(String name)