net.minecraft.client.settings

Class KeyBinding

java.lang.Object

net.minecraft.client.settings.KeyBinding

All Implemented Interfaces:

java.lang.Comparable<KeyBinding>, IForgeKeybinding

Direct Known Subclasses:

ToggleableKeyBinding

public class KeyBinding
extends java.lang.Object
implements java.lang.Comparable<KeyBinding>, IForgeKeybinding

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,java.lang.Integer>	CATEGORY_ORDER
private static KeyBindingMap	HASH
private static java.util.Map<java.lang.String,KeyBinding>	KEYBIND_ARRAY
private static java.util.Set<java.lang.String>	KEYBIND_SET
private java.lang.String	keyCategory
private InputMappings.Input	keyCode
private InputMappings.Input	keyCodeDefault
private IKeyConflictContext	keyConflictContext
private java.lang.String	keyDescription
private KeyModifier	keyModifier
private KeyModifier	keyModifierDefault Forge Start
private boolean	pressed
private int	pressTime

Constructor Summary

Constructors

Constructor and Description
KeyBinding(java.lang.String description, IKeyConflictContext keyConflictContext, InputMappings.Input keyCode, java.lang.String category) Convenience constructor for creating KeyBindings with keyConflictContext set.
KeyBinding(java.lang.String description, IKeyConflictContext keyConflictContext, InputMappings.Type inputType, int keyCode, java.lang.String category) Convenience constructor for creating KeyBindings with keyConflictContext set.
KeyBinding(java.lang.String description, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputMappings.Input keyCode, java.lang.String category) Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.
KeyBinding(java.lang.String description, IKeyConflictContext keyConflictContext, KeyModifier keyModifier, InputMappings.Type inputType, int keyCode, java.lang.String category) Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.
KeyBinding(java.lang.String description, InputMappings.Type type, int code, java.lang.String category)
KeyBinding(java.lang.String description, int keyCode, java.lang.String category)

Method Summary

Modifier and Type	Method and Description
void	bind(InputMappings.Input key)
int	compareTo(KeyBinding p_compareTo_1_)
boolean	conflicts(KeyBinding binding)
InputMappings.Input	getDefault()
static java.util.function.Supplier<java.lang.String>	getDisplayString(java.lang.String key)
InputMappings.Input	getKey()
java.lang.String	getKeyCategory()
IKeyConflictContext	getKeyConflictContext()
java.lang.String	getKeyDescription()
KeyModifier	getKeyModifier()
KeyModifier	getKeyModifierDefault()
java.lang.String	getLocalizedName()
java.lang.String	getTranslationKey()
boolean	isDefault()
boolean	isInvalid()
boolean	isKeyDown()
boolean	isPressed()
boolean	matchesKey(int keysym, int scancode)
boolean	matchesMouseKey(int key)
static void	onTick(InputMappings.Input key)
static void	resetKeyBindingArrayAndHash()
static void	setKeyBindState(InputMappings.Input key, boolean held)
void	setKeyConflictContext(IKeyConflictContext keyConflictContext)
void	setKeyModifierAndCode(KeyModifier keyModifier, InputMappings.Input keyCode)
void	setPressed(boolean valueIn) Forge End
static void	unPressAllKeys()
private void	unpressKey()
static void	updateKeyBindState()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.client.extensions.IForgeKeybinding

getKeyBinding, hasKeyCodeModifierConflict, isActiveAndMatches, setToDefault

Field Detail

KEYBIND_ARRAY

private static final java.util.Map<java.lang.String,KeyBinding> KEYBIND_ARRAY

HASH

private static final KeyBindingMap HASH

KEYBIND_SET

private static final java.util.Set<java.lang.String> KEYBIND_SET

CATEGORY_ORDER

private static final java.util.Map<java.lang.String,java.lang.Integer> CATEGORY_ORDER

keyDescription

private final java.lang.String keyDescription

keyCodeDefault

private final InputMappings.Input keyCodeDefault

keyCategory

private final java.lang.String keyCategory

keyCode

private InputMappings.Input keyCode

pressed

private boolean pressed

pressTime

private int pressTime

keyModifierDefault

private KeyModifier keyModifierDefault

Forge Start

keyModifier

private KeyModifier keyModifier

keyConflictContext

private IKeyConflictContext keyConflictContext

Constructor Detail

KeyBinding

public KeyBinding(java.lang.String description,
                  int keyCode,
                  java.lang.String category)

KeyBinding

public KeyBinding(java.lang.String description,
                  InputMappings.Type type,
                  int code,
                  java.lang.String category)

KeyBinding

public KeyBinding(java.lang.String description,
                  IKeyConflictContext keyConflictContext,
                  InputMappings.Type inputType,
                  int keyCode,
                  java.lang.String category)

Convenience constructor for creating KeyBindings with keyConflictContext set.

KeyBinding

public KeyBinding(java.lang.String description,
                  IKeyConflictContext keyConflictContext,
                  InputMappings.Input keyCode,
                  java.lang.String category)

Convenience constructor for creating KeyBindings with keyConflictContext set.

KeyBinding

public KeyBinding(java.lang.String description,
                  IKeyConflictContext keyConflictContext,
                  KeyModifier keyModifier,
                  InputMappings.Type inputType,
                  int keyCode,
                  java.lang.String category)

Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.

KeyBinding

public KeyBinding(java.lang.String description,
                  IKeyConflictContext keyConflictContext,
                  KeyModifier keyModifier,
                  InputMappings.Input keyCode,
                  java.lang.String category)

Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.

Method Detail

onTick

public static void onTick(InputMappings.Input key)

setKeyBindState

public static void setKeyBindState(InputMappings.Input key,
                                   boolean held)

updateKeyBindState

public static void updateKeyBindState()

unPressAllKeys

public static void unPressAllKeys()

resetKeyBindingArrayAndHash

public static void resetKeyBindingArrayAndHash()

isKeyDown

public boolean isKeyDown()

getKeyCategory

public java.lang.String getKeyCategory()

isPressed

public boolean isPressed()

unpressKey

private void unpressKey()

getKeyDescription

public java.lang.String getKeyDescription()

getDefault

public InputMappings.Input getDefault()

bind

public void bind(InputMappings.Input key)

compareTo

public int compareTo(KeyBinding p_compareTo_1_)

Specified by:

compareTo in interface java.lang.Comparable<KeyBinding>

getDisplayString

public static java.util.function.Supplier<java.lang.String> getDisplayString(java.lang.String key)

conflicts

public boolean conflicts(KeyBinding binding)

isInvalid

public boolean isInvalid()

matchesKey

public boolean matchesKey(int keysym,
                          int scancode)

matchesMouseKey

public boolean matchesMouseKey(int key)

getLocalizedName

public java.lang.String getLocalizedName()

isDefault

public boolean isDefault()

getTranslationKey

public java.lang.String getTranslationKey()

getKey

public InputMappings.Input getKey()

Specified by:

getKey in interface IForgeKeybinding

setKeyConflictContext

public void setKeyConflictContext(IKeyConflictContext keyConflictContext)

Specified by:

setKeyConflictContext in interface IForgeKeybinding

getKeyConflictContext

public IKeyConflictContext getKeyConflictContext()

Specified by:

getKeyConflictContext in interface IForgeKeybinding

getKeyModifierDefault

public KeyModifier getKeyModifierDefault()

Specified by:

getKeyModifierDefault in interface IForgeKeybinding

getKeyModifier

public KeyModifier getKeyModifier()

Specified by:

getKeyModifier in interface IForgeKeybinding

setKeyModifierAndCode

public void setKeyModifierAndCode(KeyModifier keyModifier,
                                  InputMappings.Input keyCode)

Specified by:

setKeyModifierAndCode in interface IForgeKeybinding

setPressed

public void setPressed(boolean valueIn)

Forge End