Package com.hammy275.immersivemc.client.api_impl

Class ImmersiveMCClientRegistrationImpl

java.lang.Object

com.hammy275.immersivemc.client.api_impl.ImmersiveMCClientRegistrationImpl

All Implemented Interfaces:

ImmersiveMCClientRegistration

public class ImmersiveMCClientRegistrationImpl
extends Object
implements ImmersiveMCClientRegistration

Field Summary

Fields

Modifier and Type	Field	Description
static final ImmersiveMCClientRegistration	INSTANCE

Constructor Summary

Constructors

Constructor	Description
ImmersiveMCClientRegistrationImpl()

Method Summary

Modifier and Type	Method	Description
void	addImmersiveRegistrationHandler(Consumer<ImmersiveMCRegistrationEvent<Immersive<?,?>>> registrationHandler)	Registers an object which, at some point, ImmersiveMC will call to register your Immersivess.
ImmersiveConfigScreenInfo	createConfigScreenInfoMultipleItems(String modID, String optionTranslation, Supplier<Set<net.minecraft.world.item.ItemStack>> optionItem, @Nullable net.minecraft.network.chat.Component optionTooltip, Supplier<Boolean> isEnabledSupplier, Consumer<Boolean> setEnabledConsumer)	Creates an ImmersiveConfigScreenInfo instance.
ImmersiveConfigScreenInfo	createConfigScreenInfoOneItem(String modID, String optionTranslation, Supplier<net.minecraft.world.item.ItemStack> optionItem, @Nullable net.minecraft.network.chat.Component optionTooltip, Supplier<Boolean> isEnabledSupplier, Consumer<Boolean> setEnabledConsumer)	Creates an ImmersiveConfigScreenInfo instance.
static void	doImmersiveRegistration(Consumer<Immersive<?,?>> immersiveConsumer)

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final ImmersiveMCClientRegistration INSTANCE

Constructor Details

ImmersiveMCClientRegistrationImpl

public ImmersiveMCClientRegistrationImpl()

Method Details

doImmersiveRegistration

public static void doImmersiveRegistration(Consumer<Immersive<?,?>> immersiveConsumer)

createConfigScreenInfoOneItem

public ImmersiveConfigScreenInfo createConfigScreenInfoOneItem(String modID,
 String optionTranslation,
 Supplier<net.minecraft.world.item.ItemStack> optionItem,
 @Nullable
 @Nullable net.minecraft.network.chat.Component optionTooltip,
 Supplier<Boolean> isEnabledSupplier,
 Consumer<Boolean> setEnabledConsumer)

Description copied from interface: ImmersiveMCClientRegistration

Creates an ImmersiveConfigScreenInfo instance. See the aforementioned interface for more information.

Specified by:

createConfigScreenInfoOneItem in interface ImmersiveMCClientRegistration

Parameters:

modID - The mod ID as described in the javadoc for ImmersiveConfigScreenInfo.getModID().

optionTranslation - The translation string for the button label as described in the javadoc for ImmersiveConfigScreenInfo.getOptionTranslation().

optionItem - A supplier for the item representing this Immersive as described in the javadoc for ImmersiveConfigScreenInfo.getOptionItems().

optionTooltip - An optional tooltip describing this Immersive and this option as described in the javadoc for ImmersiveConfigScreenInfo.getOptionTooltip().

isEnabledSupplier - A supplier that, when called, returns whether this Immersive is enabled. This method should NOT ever provide null as a value.

setEnabledConsumer - A consumer that will be provided a non-null Boolean denoting a new enabled/disabled state for the Immersive.

Returns:

An ImmersiveConfigScreenInfo instance.

createConfigScreenInfoMultipleItems

public ImmersiveConfigScreenInfo createConfigScreenInfoMultipleItems(String modID,
 String optionTranslation,
 Supplier<Set<net.minecraft.world.item.ItemStack>> optionItem,
 @Nullable
 @Nullable net.minecraft.network.chat.Component optionTooltip,
 Supplier<Boolean> isEnabledSupplier,
 Consumer<Boolean> setEnabledConsumer)

Description copied from interface: ImmersiveMCClientRegistration

Creates an ImmersiveConfigScreenInfo instance. See the aforementioned interface for more information.

Specified by:

createConfigScreenInfoMultipleItems in interface ImmersiveMCClientRegistration

Parameters:

modID - The mod ID as described in the javadoc for ImmersiveConfigScreenInfo.getModID().

optionTranslation - The translation string for the button label as described in the javadoc for ImmersiveConfigScreenInfo.getOptionTranslation().

optionItem - A supplier for the items representing this Immersive as described in the javadoc for ImmersiveConfigScreenInfo.getOptionItems().

optionTooltip - An optional tooltip describing this Immersive and this option as described in the javadoc for ImmersiveConfigScreenInfo.getOptionTooltip().

isEnabledSupplier - A supplier that, when called, returns whether this Immersive is enabled. This method should NOT ever provide null as a value.

setEnabledConsumer - A consumer that will be provided a non-null Boolean denoting a new enabled/disabled state for the Immersive.

Returns:

An ImmersiveConfigScreenInfo instance.

addImmersiveRegistrationHandler

public void addImmersiveRegistrationHandler(Consumer<ImmersiveMCRegistrationEvent<Immersive<?,?>>> registrationHandler)
                                     throws IllegalStateException

Description copied from interface: ImmersiveMCClientRegistration

Registers an object which, at some point, ImmersiveMC will call to register your Immersivess. The time at which registration occurs is only guaranteed to be some time after mods are initially constructed, so handlers should be added here as early as possible, and be prepared for a lack of registry availability.

Specified by:

addImmersiveRegistrationHandler in interface ImmersiveMCClientRegistration

Parameters:

registrationHandler - Your object that will register Immersives when called.

Throws:

IllegalStateException - This method was called after registration.