net.minecraft.client.settings

Class KeyBinding

java.lang.Object

net.minecraft.client.settings.KeyBinding

All Implemented Interfaces:

java.lang.Comparable<KeyBinding>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(KeyBinding p_compareTo_1_)
boolean	conflicts(KeyBinding other) Returns true when the other keyBinding conflicts with this one
java.lang.String	getDisplayName()
static java.util.function.Supplier<java.lang.String>	getDisplayString(java.lang.String key) Forge End
static java.util.Set<java.lang.String>	getKeybinds()
java.lang.String	getKeyCategory()
int	getKeyCode()
int	getKeyCodeDefault()
IKeyConflictContext	getKeyConflictContext()
java.lang.String	getKeyDescription()
KeyModifier	getKeyModifier()
KeyModifier	getKeyModifierDefault()
boolean	hasKeyCodeModifierConflict(KeyBinding other) Returns true when one of the bindings' key codes conflicts with the other's modifier.
boolean	isActiveAndMatches(int keyCode) Checks that the key conflict context and modifier are active, and that the keyCode matches this binding.
boolean	isKeyDown()
boolean	isPressed()
boolean	isSetToDefaultValue()
static void	onTick(int keyCode)
static void	resetKeyBindingArrayAndHash()
static void	setKeyBindState(int keyCode, boolean pressed)
void	setKeyCode(int keyCode)
void	setKeyConflictContext(IKeyConflictContext keyConflictContext)
void	setKeyModifierAndCode(KeyModifier keyModifier, int keyCode)
void	setToDefault()
static void	unPressAllKeys()
static void	updateKeyBindState()

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyBinding

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

KeyBinding

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

Convenience constructor for creating KeyBindings with keyConflictContext set.

KeyBinding

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

Convenience constructor for creating KeyBindings with keyConflictContext and keyModifier set.

Method Detail

onTick

public static void onTick(int keyCode)

setKeyBindState

public static void setKeyBindState(int keyCode,
                                   boolean pressed)

updateKeyBindState

public static void updateKeyBindState()

unPressAllKeys

public static void unPressAllKeys()

resetKeyBindingArrayAndHash

public static void resetKeyBindingArrayAndHash()

getKeybinds

public static java.util.Set<java.lang.String> getKeybinds()

isKeyDown

public boolean isKeyDown()

getKeyCategory

public java.lang.String getKeyCategory()

isPressed

public boolean isPressed()

getKeyDescription

public java.lang.String getKeyDescription()

getKeyCodeDefault

public int getKeyCodeDefault()

getKeyCode

public int getKeyCode()

setKeyCode

public void setKeyCode(int keyCode)

compareTo

public int compareTo(KeyBinding p_compareTo_1_)

Specified by:

compareTo in interface java.lang.Comparable<KeyBinding>

isActiveAndMatches

public boolean isActiveAndMatches(int keyCode)

Checks that the key conflict context and modifier are active, and that the keyCode matches this binding.

setKeyConflictContext

public void setKeyConflictContext(IKeyConflictContext keyConflictContext)

getKeyConflictContext

public IKeyConflictContext getKeyConflictContext()

getKeyModifierDefault

public KeyModifier getKeyModifierDefault()

getKeyModifier

public KeyModifier getKeyModifier()

setKeyModifierAndCode

public void setKeyModifierAndCode(KeyModifier keyModifier,
                                  int keyCode)

setToDefault

public void setToDefault()

isSetToDefaultValue

public boolean isSetToDefaultValue()

conflicts

public boolean conflicts(KeyBinding other)

Returns true when the other keyBinding conflicts with this one

hasKeyCodeModifierConflict

public boolean hasKeyCodeModifierConflict(KeyBinding other)

Returns true when one of the bindings' key codes conflicts with the other's modifier.

getDisplayName

public java.lang.String getDisplayName()

getDisplayString

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

Forge End