Package me.hackware.api.setting.impl

Class KeybindSetting

java.lang.Object

me.hackware.api.setting.Setting<Integer>

me.hackware.api.setting.impl.KeybindSetting

public class KeybindSetting
extends Setting<Integer>

A setting that stores a keybind (GLFW key code) and its activation mode.

The value is the GLFW key code (GLFW.GLFW_KEY_UNKNOWN = unbound). The mode determines whether the keybind toggles the module or activates it only while held.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KeybindSetting.KeybindMode

Field Summary

Fields inherited from class me.hackware.api.setting.Setting

value

Constructor Summary

Constructors

Constructor	Description
KeybindSetting(String name)
KeybindSetting(String name, int defaultKey)
KeybindSetting(String name, String description)
KeybindSetting(String name, String description, int defaultKey)

Method Summary

Modifier and Type	Method	Description
void	cycleMode()
KeybindSetting	defaultValue(Integer defaultValue)
KeybindSetting	description(String description)
KeybindSetting	displayName(String displayName)
static int	fromMouseButton(int button)	Encodes a GLFW mouse button (0–7) into the internal code.
String	getKeyName()	Returns a human-readable name for the bound key / mouse button, or "..." if unbound.
KeybindSetting.KeybindMode	getMode()
KeybindSetting	group(String group)
boolean	isBound()
boolean	isDown(long windowHandle)	Polls the current state of this keybind (keyboard key or mouse button).
static boolean	isMouseButton(int code)	Returns true if the stored code represents a mouse button.
static String	keyCodeToGlfwName(int keyCode)	Returns the GLFW constant name for a key code (e.g.
static int	keyNameToCode(String name)	Resolves a key name string (as produced by getKeyName()) back to a GLFW key code.
KeybindSetting	mode(KeybindSetting.KeybindMode mode)
static String	nameForCode(int key)	Human-readable name for any key / mouse-button code, as getKeyName() produces.
void	setMode(KeybindSetting.KeybindMode mode)
void	setWasDown(boolean wasDown)
static int	toMouseButton(int code)	Decodes the internal code back to a GLFW mouse button (0–7).
void	unbind()
KeybindSetting	visible(boolean visible)
KeybindSetting	visible(BooleanSupplier visible)
boolean	wasDown()

Methods inherited from class me.hackware.api.setting.Setting

get, getDefaultValue, getDescription, getDisplayName, getGroup, getName, getOwner, isBulkLoading, isVisible, onChanged, setBulkLoadProbe, setOwner, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

KeybindSetting

public KeybindSetting(String name)

KeybindSetting

public KeybindSetting(String name,
 String description)

KeybindSetting

public KeybindSetting(String name,
 int defaultKey)

KeybindSetting

public KeybindSetting(String name,
 String description,
 int defaultKey)

Method Details

isMouseButton

public static boolean isMouseButton(int code)

Returns true if the stored code represents a mouse button.

fromMouseButton

public static int fromMouseButton(int button)

Encodes a GLFW mouse button (0–7) into the internal code.

toMouseButton

public static int toMouseButton(int code)

Decodes the internal code back to a GLFW mouse button (0–7).

mode

public KeybindSetting mode(KeybindSetting.KeybindMode mode)

displayName

public KeybindSetting displayName(String displayName)

Overrides:

displayName in class Setting<Integer>

defaultValue

public KeybindSetting defaultValue(Integer defaultValue)

Overrides:

defaultValue in class Setting<Integer>

description

public KeybindSetting description(String description)

Overrides:

description in class Setting<Integer>

group

public KeybindSetting group(String group)

Overrides:

group in class Setting<Integer>

visible

public KeybindSetting visible(boolean visible)

Overrides:

visible in class Setting<Integer>

visible

public KeybindSetting visible(BooleanSupplier visible)

Overrides:

visible in class Setting<Integer>

getMode

public KeybindSetting.KeybindMode getMode()

setMode

public void setMode(KeybindSetting.KeybindMode mode)

isBound

public boolean isBound()

unbind

public void unbind()

wasDown

public boolean wasDown()

setWasDown

public void setWasDown(boolean wasDown)

cycleMode

public void cycleMode()

getKeyName

public String getKeyName()

Returns a human-readable name for the bound key / mouse button, or "..." if unbound.

nameForCode

public static String nameForCode(int key)

Human-readable name for any key / mouse-button code, as getKeyName() produces.

keyNameToCode

public static int keyNameToCode(String name)

Resolves a key name string (as produced by getKeyName()) back to a GLFW key code. Returns GLFW.GLFW_KEY_UNKNOWN if the name is unrecognised.

keyCodeToGlfwName

public static String keyCodeToGlfwName(int keyCode)

Returns the GLFW constant name for a key code (e.g. "GLFW_KEY_L"). Falls back to "GLFW_KEY_UNKNOWN" for unmapped codes.

isDown

public boolean isDown(long windowHandle)

Polls the current state of this keybind (keyboard key or mouse button). Returns true if the bound input is currently pressed.