Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- action() - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Returns the value of the
actionrecord component. - actionID() - Method in record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Returns the value of the
actionIDrecord component. - addKeybind(String, int, String, Optional<DynamicKeybindAction>, Consumer<String>) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Adds a dynamic keybind to the registry with an action.
- AddKeybindPacket - Class in dev.munebase.dynamickeybinds.network
-
Network packet sent from client to server to request adding a new keybind.
- AddKeybindPacket(String, int, String) - Constructor for class dev.munebase.dynamickeybinds.network.AddKeybindPacket
-
Construct a new AddKeybindPacket.
- AddKeybindPacket(String, int, String, Optional<DynamicKeybindAction>) - Constructor for class dev.munebase.dynamickeybinds.network.AddKeybindPacket
-
Construct a new AddKeybindPacket with an optional action.
- applyServerSnapshot(List<StoredKeybind>, Logger) - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- applyServerSnapshot(List<StoredKeybind>, Logger) - Method in interface dev.munebase.dynamickeybinds.client.ServerSynchronizedDynamicKeyRegistry
-
Replaces current client state with a server-authoritative snapshot.
C
- category() - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Returns the value of the
categoryrecord component. - clearLocalState(Logger) - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- clearLocalState(Logger) - Method in interface dev.munebase.dynamickeybinds.client.ServerSynchronizedDynamicKeyRegistry
-
Clears local keybind state without sending removal packets.
- ClientRegistryFactory - Class in dev.munebase.dynamickeybinds.client
-
Shared helper for creating client-side dynamic key registry/provider wiring.
- ClientRegistryNetworkBridge - Interface in dev.munebase.dynamickeybinds.client
-
Loader-provided client networking bridge used by the dynamic key registry.
- CommonClientKeybindPersistence - Class in dev.munebase.dynamickeybinds.client
-
Shared client-side persistence/sync flow used by both Forge and Fabric.
- CommonClientKeybindPersistence(Logger, String, BiConsumer<String, Integer>) - Constructor for class dev.munebase.dynamickeybinds.client.CommonClientKeybindPersistence
- CommonDynamicKeyCommands - Class in dev.munebase.dynamickeybinds.command
-
Common command logic for dynamic keybinds that works across all loaders.
- CommonPacketCodec - Class in dev.munebase.dynamickeybinds.network
-
Shared packet serialization helpers used by both loader networking layers.
- CommonServerKeybindHandler - Class in dev.munebase.dynamickeybinds.server
-
Shared server-side keybind persistence and mutation flow.
- CommonServerKeybindHandler(Logger, String, BiConsumer<ServerPlayer, List<StoredKeybind>>) - Constructor for class dev.munebase.dynamickeybinds.server.CommonServerKeybindHandler
-
Creates a new server keybind handler.
- createDefaultDebugAction(String, CompoundTag) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Builds the default debug action payload used when no explicit action is provided.
- createNetworkedRegistry(ClientRegistryNetworkBridge) - Static method in class dev.munebase.dynamickeybinds.client.ClientRegistryFactory
- createProvider(DynamicKeyRegistry) - Static method in class dev.munebase.dynamickeybinds.client.ClientRegistryFactory
D
- data() - Method in record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Returns the value of the
datarecord component. - decodeAddKeybind(FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Decodes an add keybind packet from the buffer.
- decodeRemoveKeybind(FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Decodes a remove keybind packet from the buffer.
- decodeSyncKeybinds(FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Decodes a sync keybinds packet from the buffer.
- decodeUpdateKeybind(FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Decodes an update keybind packet from the buffer.
- DEFAULT_HANDLER_ACTION_ID - Static variable in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
- dev.munebase.dynamickeybinds - package dev.munebase.dynamickeybinds
- dev.munebase.dynamickeybinds.action - package dev.munebase.dynamickeybinds.action
- dev.munebase.dynamickeybinds.client - package dev.munebase.dynamickeybinds.client
- dev.munebase.dynamickeybinds.command - package dev.munebase.dynamickeybinds.command
- dev.munebase.dynamickeybinds.network - package dev.munebase.dynamickeybinds.network
- dev.munebase.dynamickeybinds.persistence - package dev.munebase.dynamickeybinds.persistence
- dev.munebase.dynamickeybinds.server - package dev.munebase.dynamickeybinds.server
- dev.munebase.dynamickeybinds.util - package dev.munebase.dynamickeybinds.util
- dispatch(String, CompoundTag) - Static method in class dev.munebase.dynamickeybinds.action.DynamicKeybindActionRegistry
-
Dispatch an action to its registered handler.
- DynamicKeybindAction - Record Class in dev.munebase.dynamickeybinds.action
-
Represents a custom action triggered by a dynamic keybind.
- DynamicKeybindAction(String) - Constructor for record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Convenience constructor for actions without data payload.
- DynamicKeybindAction(String, CompoundTag) - Constructor for record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Creates a new DynamicKeybindAction with null-safe data.
- DynamicKeybindActionHandler - Interface in dev.munebase.dynamickeybinds.action
-
Functional interface for handling keybind actions.
- DynamicKeybindActionRegistry - Class in dev.munebase.dynamickeybinds.action
-
Global registry for custom keybind action handlers.
- DynamicKeyRegistry - Interface in dev.munebase.dynamickeybinds
-
Registry for dynamically created keybinds at runtime.
- DynamicKeyRegistryImpl - Class in dev.munebase.dynamickeybinds
-
Thread-safe implementation of DynamicKeyRegistry using concurrent data structures.
- DynamicKeyRegistryImpl() - Constructor for class dev.munebase.dynamickeybinds.DynamicKeyRegistryImpl
- DynamicKeyRegistryProvider - Interface in dev.munebase.dynamickeybinds
-
Provider for accessing the global DynamicKeyRegistry instance.
- DynamicKeyRegistryProvider.Holder - Class in dev.munebase.dynamickeybinds
-
Internal class to hold the provider singleton.
E
- encodeAddKeybind(AddKeybindPacket, FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Encodes an add keybind packet into the buffer.
- encodeRemoveKeybind(RemoveKeybindPacket, FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Encodes a remove keybind packet into the buffer.
- encodeSyncKeybinds(FriendlyByteBuf, List<StoredKeybind>) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Encodes a list of keybinds into the buffer.
- encodeUpdateKeybind(UpdateKeybindPacket, FriendlyByteBuf) - Static method in class dev.munebase.dynamickeybinds.network.CommonPacketCodec
-
Encodes an update keybind packet into the buffer.
- equals(Object) - Method in record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Indicates whether some other object is "equal to" this one.
- executeAdd(String, int, String, Optional<DynamicKeybindAction>, Consumer<String>, Consumer<String>) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Shared command execution helper for add operations.
- executeList(Consumer<String>) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Shared command execution helper for list operations.
- executeRemove(String, Consumer<String>, Consumer<String>) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Shared command execution helper for remove operations.
- extractKeyCode(KeyMapping) - Static method in class dev.munebase.dynamickeybinds.util.KeyMappingUtil
-
Extracts key code from key mapping in a mapping-stable way.
- extractKeycodeFromKeyMapping(KeyMapping) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Extracts keycode from a KeyMapping.
F
- formatAddRequestMessage(String) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
User-facing add request message.
- formatListOutput() - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Formats user-facing lines for the `list` command output.
- formatNetworkingNotInitializedMessage() - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
User-facing networking not initialized message.
- formatRemoveRequestMessage(String) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
User-facing remove request message.
G
- getAction() - Method in class dev.munebase.dynamickeybinds.network.AddKeybindPacket
-
Get the optional action payload.
- getAllDynamicKeys() - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- getAllDynamicKeys() - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistry
-
Get all currently registered dynamic keys.
- getAllDynamicKeys() - Method in class dev.munebase.dynamickeybinds.DynamicKeyRegistryImpl
-
Retrieve all currently registered dynamic keybinds.
- getCategory() - Method in class dev.munebase.dynamickeybinds.network.AddKeybindPacket
-
Get the keybind category.
- getHandler(String) - Static method in class dev.munebase.dynamickeybinds.action.DynamicKeybindActionRegistry
-
Get a registered handler by action ID.
- getId() - Method in class dev.munebase.dynamickeybinds.network.AddKeybindPacket
-
Get the keybind ID.
- getId() - Method in class dev.munebase.dynamickeybinds.network.RemoveKeybindPacket
-
Get the keybind ID to remove.
- getId() - Method in class dev.munebase.dynamickeybinds.network.UpdateKeybindPacket
-
Get the keybind ID to update.
- getKeyBindAction(KeyMapping) - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- getKeyBindAction(KeyMapping) - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistry
-
Get the action associated with a keybind.
- getKeyBindAction(KeyMapping) - Method in class dev.munebase.dynamickeybinds.DynamicKeyRegistryImpl
-
Retrieve the action associated with a keybind.
- getKeyBindById(String) - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- getKeyBindById(String) - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistry
-
Get a specific keybind by its ID.
- getKeyBindById(String) - Method in class dev.munebase.dynamickeybinds.DynamicKeyRegistryImpl
-
Retrieve a specific keybind by its ID.
- getKeybinds() - Method in class dev.munebase.dynamickeybinds.network.SyncKeybindsPacket
-
Gets the keybinds in this packet.
- getKeyCode() - Method in class dev.munebase.dynamickeybinds.network.AddKeybindPacket
-
Get the key code.
- getKeyCode() - Method in class dev.munebase.dynamickeybinds.network.UpdateKeybindPacket
-
Get the new key code.
- getRegistry() - Static method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistryProvider
-
Get the DynamicKeyRegistry instance.
- getRegistryInstance() - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistryProvider
-
Internal method to get the registry instance.
H
- handleAddKeybind(ServerPlayer, AddKeybindPacket) - Method in class dev.munebase.dynamickeybinds.server.CommonServerKeybindHandler
-
Handles adding a new keybind for a player.
- handleRemoveKeybind(ServerPlayer, RemoveKeybindPacket) - Method in class dev.munebase.dynamickeybinds.server.CommonServerKeybindHandler
-
Handles removing a keybind for a player.
- handleServerSync(List<StoredKeybind>) - Method in class dev.munebase.dynamickeybinds.client.CommonClientKeybindPersistence
- handleUpdateKeybind(ServerPlayer, UpdateKeybindPacket) - Method in class dev.munebase.dynamickeybinds.server.CommonServerKeybindHandler
-
Handles updating a keybind for a player.
- hashCode() - Method in record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Returns a hash code value for this object.
- Holder() - Constructor for class dev.munebase.dynamickeybinds.DynamicKeyRegistryProvider.Holder
I
- id() - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Returns the value of the
idrecord component.
K
- keyCode() - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Returns the value of the
keyCoderecord component. - KeyMappingUtil - Class in dev.munebase.dynamickeybinds.util
-
Shared key mapping helpers used across loaders.
L
- listKeybinds() - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Lists all currently registered dynamic keybinds.
- listResultCode(List<String>) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Computes Brigadier result for list output lines.
- loadKeybinds(Path, String) - Static method in class dev.munebase.dynamickeybinds.server.ServerKeybindPersistence
-
Load keybinds for a player from the server world.
N
- NetworkedDynamicKeyRegistry - Class in dev.munebase.dynamickeybinds.client
-
Client-side dynamic key registry that always uses server networking for add/remove operations.
- NetworkedDynamicKeyRegistry(ClientRegistryNetworkBridge) - Constructor for class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- normalizeCategory(String) - Static method in class dev.munebase.dynamickeybinds.util.KeyMappingUtil
-
Normalizes key category for storage.
- normalizeId(String) - Static method in class dev.munebase.dynamickeybinds.util.KeyMappingUtil
-
Converts a key mapping name/id to the canonical keybind id used by persistence.
O
- onAction(String, CompoundTag) - Method in interface dev.munebase.dynamickeybinds.action.DynamicKeybindActionHandler
-
Called when a keybind with this action is pressed.
- onClientLogin() - Method in class dev.munebase.dynamickeybinds.client.CommonClientKeybindPersistence
- onClientLogout() - Method in class dev.munebase.dynamickeybinds.client.CommonClientKeybindPersistence
P
- pollAndSyncDynamicKeyRebinds() - Method in class dev.munebase.dynamickeybinds.client.CommonClientKeybindPersistence
R
- register(String, DynamicKeybindActionHandler) - Static method in class dev.munebase.dynamickeybinds.action.DynamicKeybindActionRegistry
-
Register a handler for a specific action ID.
- registerDynamicKey(String, int, String, Optional<DynamicKeybindAction>) - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- registerDynamicKey(String, int, String, Optional<DynamicKeybindAction>) - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistry
-
Register a new dynamic key at runtime.
- registerDynamicKey(String, int, String, Optional<DynamicKeybindAction>) - Method in class dev.munebase.dynamickeybinds.DynamicKeyRegistryImpl
-
Register a new dynamic keybind at runtime.
- registerRuntimeKey(KeyMapping, Logger) - Static method in class dev.munebase.dynamickeybinds.client.RuntimeKeyMappingManager
-
Adds a runtime key mapping to options if not already present.
- removeKeybind(String, Consumer<String>) - Static method in class dev.munebase.dynamickeybinds.command.CommonDynamicKeyCommands
-
Removes a dynamic keybind from the registry.
- RemoveKeybindPacket - Class in dev.munebase.dynamickeybinds.network
-
Network packet sent from client to server to request removing a keybind.
- RemoveKeybindPacket(String) - Constructor for class dev.munebase.dynamickeybinds.network.RemoveKeybindPacket
-
Construct a new RemoveKeybindPacket.
- RuntimeKeyMappingManager - Class in dev.munebase.dynamickeybinds.client
-
Loader-agnostic runtime key mapping registration helpers.
S
- saveKeybinds(Path, String, List<StoredKeybind>) - Static method in class dev.munebase.dynamickeybinds.server.ServerKeybindPersistence
-
Save keybinds for a player to the server world.
- sendAdd(String, int, String, Optional<DynamicKeybindAction>) - Method in interface dev.munebase.dynamickeybinds.client.ClientRegistryNetworkBridge
-
Sends an add-keybind request to the connected server.
- sendRemove(String) - Method in interface dev.munebase.dynamickeybinds.client.ClientRegistryNetworkBridge
-
Sends a remove-keybind request to the connected server.
- ServerKeybindPersistence - Class in dev.munebase.dynamickeybinds.server
-
Server-side keybind persistence.
- ServerSynchronizedDynamicKeyRegistry - Interface in dev.munebase.dynamickeybinds.client
-
Optional client-side extension for registries backed by server synchronization.
- setRegistryProvider(DynamicKeyRegistryProvider) - Static method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistryProvider
-
Sets the active provider used by
DynamicKeyRegistryProvider.getRegistry(). - StoredKeybind - Record Class in dev.munebase.dynamickeybinds.persistence
-
Immutable record representing a stored keybind that can be persisted to NBT or net sync.
- StoredKeybind(String, int, String) - Constructor for record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Backward-compatible constructor for keybinds without custom actions.
- StoredKeybind(String, int, String, Optional<DynamicKeybindAction>) - Constructor for record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Creates an instance of a
StoredKeybindrecord class. - SyncKeybindsPacket - Class in dev.munebase.dynamickeybinds.network
-
Packet sent from server to client to sync all keybinds for the joining player.
- SyncKeybindsPacket(List<StoredKeybind>) - Constructor for class dev.munebase.dynamickeybinds.network.SyncKeybindsPacket
-
Creates a sync packet with the given keybinds.
- syncKeybindsToPlayer(ServerPlayer) - Method in class dev.munebase.dynamickeybinds.server.CommonServerKeybindHandler
-
Syncs all keybinds for a player from persistent storage.
T
- toString() - Method in record class dev.munebase.dynamickeybinds.action.DynamicKeybindAction
-
Returns a string representation of this record class.
- toString() - Method in record class dev.munebase.dynamickeybinds.persistence.StoredKeybind
-
Returns a string representation of this record class.
U
- unregisterDynamicKey(String) - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistry
-
Unregister an existing dynamic key by ID.
- unregisterDynamicKey(KeyMapping) - Method in class dev.munebase.dynamickeybinds.client.NetworkedDynamicKeyRegistry
- unregisterDynamicKey(KeyMapping) - Method in interface dev.munebase.dynamickeybinds.DynamicKeyRegistry
-
Unregister an existing dynamic key.
- unregisterDynamicKey(KeyMapping) - Method in class dev.munebase.dynamickeybinds.DynamicKeyRegistryImpl
-
Unregister an existing dynamic keybind.
- unregisterRuntimeKey(KeyMapping, Logger) - Static method in class dev.munebase.dynamickeybinds.client.RuntimeKeyMappingManager
-
Removes a runtime key mapping from options.
- UpdateKeybindPacket - Class in dev.munebase.dynamickeybinds.network
-
Network packet sent from client to server to request updating a keybind's key code.
- UpdateKeybindPacket(String, int) - Constructor for class dev.munebase.dynamickeybinds.network.UpdateKeybindPacket
-
Construct a new UpdateKeybindPacket.
All Classes and Interfaces|All Packages|Constant Field Values