KeyBinding ([Javadoc]MinecraftForge(forge:1.15.2-31.1.0 / mcp:SS

java.lang.Object
- net.minecraft.client.settings.KeyBinding

すべての実装されたインタフェース:

java.lang.Comparable<KeyBinding>, IForgeKeybinding

直系の既知のサブクラス:

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

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`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)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`bind(InputMappings.Input key)` Binds a new KeyCode to this
`int`	`compareTo(KeyBinding p_compareTo_1_)`
`boolean`	`conflicts(KeyBinding binding)` Returns true if the supplied KeyBinding conflicts with this
`InputMappings.Input`	`getDefault()`
`static java.util.function.Supplier<java.lang.String>`	`getDisplayString(java.lang.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`)
`InputMappings.Input`	`getKey()`
`java.lang.String`	`getKeyCategory()`
`IKeyConflictContext`	`getKeyConflictContext()`
`java.lang.String`	`getKeyDescription()`
`KeyModifier`	`getKeyModifier()`
`KeyModifier`	`getKeyModifierDefault()`
`java.lang.String`	`getLocalizedName()` Returns the localized name of the key and key modifier combo set for this KeyBinding
`java.lang.String`	`getTranslationKey()`
`boolean`	`isDefault()` Returns true if the keybinding is using the default key and key modifier
`boolean`	`isInvalid()`
`boolean`	`isKeyDown()` Returns true if the key is pressed (used for continuous querying).
`boolean`	`isPressed()` Returns true on the initial key press.
`boolean`	`matchesKey(int keysym, int scancode)`
`boolean`	`matchesMouseKey(int key)` Returns true if the KeyBinding is set to a mouse key and the key matches
`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()`
`static void`	`updateKeyBindState()` Completely recalculates whether any keybinds are held, from scratch.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド net.minecraftforge.client.extensions.IForgeKeybinding
getKeyBinding, hasKeyCodeModifierConflict, isActiveAndMatches, setToDefault

コンストラクタの詳細

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.

メソッドの詳細
- onTick
```
public static void onTick(InputMappings.Input key)
```
- setKeyBindState
```
public static void setKeyBindState(InputMappings.Input key,
                                   boolean held)
```
- updateKeyBindState
```
public static void updateKeyBindState()
```
  Completely recalculates whether any keybinds are held, from scratch.
- unPressAllKeys
```
public static void unPressAllKeys()
```
- resetKeyBindingArrayAndHash
```
public static void resetKeyBindingArrayAndHash()
```
- isKeyDown
```
public boolean isKeyDown()
```
  Returns true if the key is pressed (used for continuous querying). Should be used in tickers.
- getKeyCategory
```
public java.lang.String getKeyCategory()
```
- isPressed
```
public boolean isPressed()
```
  Returns true on the initial key press. For continuous querying use isKeyDown(). Should be used in key events.
- getKeyDescription
```
public java.lang.String getKeyDescription()
```
- getDefault
```
public InputMappings.Input getDefault()
```
- bind
```
public void bind(InputMappings.Input key)
```
  Binds a new KeyCode to this
- compareTo
```
public int compareTo(KeyBinding p_compareTo_1_)
```
  定義:
  
  compareTo インタフェース内 java.lang.Comparable<KeyBinding>
- getDisplayString
```
public static java.util.function.Supplier<java.lang.String> getDisplayString(java.lang.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)
- conflicts
```
public boolean conflicts(KeyBinding binding)
```
  Returns true if the supplied KeyBinding conflicts with this
- isInvalid
```
public boolean isInvalid()
```
- matchesKey
```
public boolean matchesKey(int keysym,
                          int scancode)
```
- matchesMouseKey
```
public boolean matchesMouseKey(int key)
```
  Returns true if the KeyBinding is set to a mouse key and the key matches
- getLocalizedName
```
public java.lang.String getLocalizedName()
```
  Returns the localized name of the key and key modifier combo set for this KeyBinding
- isDefault
```
public boolean isDefault()
```
  Returns true if the keybinding is using the default key and key modifier
- getTranslationKey
```
public java.lang.String getTranslationKey()
```
- getKey
```
public InputMappings.Input getKey()
```
  定義:
  
  getKey インタフェース内 IForgeKeybinding
- setKeyConflictContext
```
public void setKeyConflictContext(IKeyConflictContext keyConflictContext)
```
  定義:
  
  setKeyConflictContext インタフェース内 IForgeKeybinding
- getKeyConflictContext
```
public IKeyConflictContext getKeyConflictContext()
```
  定義:
  
  getKeyConflictContext インタフェース内 IForgeKeybinding
- getKeyModifierDefault
```
public KeyModifier getKeyModifierDefault()
```
  定義:
  
  getKeyModifierDefault インタフェース内 IForgeKeybinding
- getKeyModifier
```
public KeyModifier getKeyModifier()
```
  定義:
  
  getKeyModifier インタフェース内 IForgeKeybinding
- setKeyModifierAndCode
```
public void setKeyModifierAndCode(KeyModifier keyModifier,
                                  InputMappings.Input keyCode)
```
  定義:
  
  setKeyModifierAndCode インタフェース内 IForgeKeybinding
- setPressed
```
public void setPressed(boolean valueIn)
```
  Forge End

クラス KeyBinding

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド net.minecraftforge.client.extensions.IForgeKeybinding

コンストラクタの詳細

KeyBinding

KeyBinding

KeyBinding

KeyBinding

KeyBinding

KeyBinding

メソッドの詳細

onTick

setKeyBindState

updateKeyBindState

unPressAllKeys

resetKeyBindingArrayAndHash

isKeyDown

getKeyCategory

isPressed

getKeyDescription

getDefault

bind

compareTo

getDisplayString

conflicts

isInvalid

matchesKey

matchesMouseKey

getLocalizedName

isDefault

getTranslationKey

getKey

setKeyConflictContext

getKeyConflictContext

getKeyModifierDefault

getKeyModifier

setKeyModifierAndCode

setPressed