Package net.neoforged.neoforge.client.gamerules

Class RegisterGameRuleEntryFactoryEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.gamerules.RegisterGameRuleEntryFactoryEvent

All Implemented Interfaces:

IModBusEvent

public final class RegisterGameRuleEntryFactoryEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Fired to allow modders to register custom EditGameRulesScreen.RuleEntry factories.

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

While you are not required to register a custom factory for your GameRuleType, it is recommended to do so if your game rule requires more than a simple EditBox. For example a togglable type similar to Boolean would register a new factory which makes use of a CycleButton insead of a EditBox.

When no factory exists for a given type the generic entry will be used instead.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<GameRuleType,GameRuleEntryFactory<?>>	factories

Constructor Summary

Constructors

Constructor	Description
RegisterGameRuleEntryFactoryEvent(Map<GameRuleType,GameRuleEntryFactory<?>> factories)

Method Summary

Modifier and Type	Method	Description
<T> void	register(GameRuleType gameRuleType, GameRuleEntryFactory<T> factory)

Methods inherited from class java.lang.Object

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

Field Details

factories

private final Map<GameRuleType,GameRuleEntryFactory<?>> factories

Constructor Details

RegisterGameRuleEntryFactoryEvent

@Internal
RegisterGameRuleEntryFactoryEvent(Map<GameRuleType,GameRuleEntryFactory<?>> factories)

Method Details

register

public <T> void register(GameRuleType gameRuleType,
 GameRuleEntryFactory<T> factory)