Class RegisterKeyMappingsEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterKeyMappingsEvent

All Implemented Interfaces:

IModBusEvent

public class RegisterKeyMappingsEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Allows users to register custom key mappings and key mapping categories.

This event is not cancellable.

This event is fired on the mod-specific event bus, only on the logical client.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<Identifier, KeyMapping.Category>	moddedCategories
private final Options	options

Constructor Summary

Constructors

Constructor	Description
RegisterKeyMappingsEvent(Options options)

Method Summary

Modifier and Type	Method	Description
void	register(KeyMapping key)	Register a new key mapping.
void	registerCategory(KeyMapping.Category category)	Register a new key mapping category.
void	sortAndStoreCategories(List<KeyMapping.Category> categories)

Methods inherited from class Object

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

Field Details

options

private final Options options

moddedCategories

private final Map<Identifier, KeyMapping.Category> moddedCategories

Constructor Details

RegisterKeyMappingsEvent

@Internal
public RegisterKeyMappingsEvent(Options options)

Method Details

register

public void register(KeyMapping key)

Register a new key mapping.

registerCategory

public void registerCategory(KeyMapping.Category category)

Register a new key mapping category.

sortAndStoreCategories

@Internal
public void sortAndStoreCategories(List<KeyMapping.Category> categories)