Package dev.munebase.dynamickeybinds.network

Class AddKeybindPacket

java.lang.Object

dev.munebase.dynamickeybinds.network.AddKeybindPacket

public class AddKeybindPacket
extends Object

Network packet sent from client to server to request adding a new keybind. This packet allows clients to register new dynamic keybinds on the server side, which are then persisted and synchronized to all players. It carries the keybind ID, key code, category, action, and display metadata.

Direction: Client -> Server

Handler: Server-side keybind handler (ForgeServerKeybindHandler or FabricServerKeybindHandler)

Constructor Summary

Constructors

Constructor	Description
AddKeybindPacket(String id, int keyCode, String category)	Construct a new AddKeybindPacket.
AddKeybindPacket(String id, int keyCode, String category, Optional<DynamicKeybindAction> action)	Construct a new AddKeybindPacket with an optional action.
AddKeybindPacket(String id, int keyCode, String category, Optional<DynamicKeybindAction> action, DisplaySpec displaySpec)	Construct a new AddKeybindPacket with action and display metadata.

Method Summary

Modifier and Type	Method	Description
Optional<DynamicKeybindAction>	getAction()	Get the optional action payload.
String	getCategory()	Get the keybind category.
DisplaySpec	getDisplaySpec()	Get the display metadata.
String	getId()	Get the keybind ID.
int	getKeyCode()	Get the key code.

Methods inherited from class java.lang.Object

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

Constructor Details

AddKeybindPacket

public AddKeybindPacket(String id,
 int keyCode,
 String category)

Construct a new AddKeybindPacket.

Parameters:

id - unique keybind identifier

keyCode - the GLFW key code

category - the keybind category

AddKeybindPacket

public AddKeybindPacket(String id,
 int keyCode,
 String category,
 Optional<DynamicKeybindAction> action)

Construct a new AddKeybindPacket with an optional action.

Parameters:

id - unique keybind identifier

keyCode - the GLFW key code

category - the keybind category

action - optional action payload

AddKeybindPacket

public AddKeybindPacket(String id,
 int keyCode,
 String category,
 Optional<DynamicKeybindAction> action,
 DisplaySpec displaySpec)

Construct a new AddKeybindPacket with action and display metadata.

Parameters:

id - unique keybind identifier

keyCode - the GLFW key code

category - the keybind category

action - optional action payload

displaySpec - optional display metadata

Method Details

getId

public String getId()

Get the keybind ID.

Returns:

the unique identifier

getKeyCode

public int getKeyCode()

Get the key code.

Returns:

the GLFW key code

getCategory

public String getCategory()

Get the keybind category.

Returns:

the category string

getAction

public Optional<DynamicKeybindAction> getAction()

Get the optional action payload.

Returns:

optional action

getDisplaySpec

public DisplaySpec getDisplaySpec()

Get the display metadata.

Returns:

display spec