Package net.minecraftforge.client
Record Class ConfigScreenHandler.ConfigScreenFactory
java.lang.Object
java.lang.Record
net.minecraftforge.client.ConfigScreenHandler.ConfigScreenFactory
- Record Components:
screenFunction
- A function that takes theMinecraft
client instance and the mods screen as arguments and returns your config screen to show when the player clicks the config button for your mod on the mods screen.You should call
Minecraft.setScreen(Screen)
with the provided client instance and mods screen for the action of your close button.
- All Implemented Interfaces:
IExtensionPoint<ConfigScreenHandler.ConfigScreenFactory>
- Enclosing class:
ConfigScreenHandler
public static record ConfigScreenHandler.ConfigScreenFactory(BiFunction<Minecraft,Screen,Screen> screenFunction)
extends Record
implements IExtensionPoint<ConfigScreenHandler.ConfigScreenFactory>
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraftforge.fml.IExtensionPoint
IExtensionPoint.DisplayTest
-
Field Summary
Modifier and TypeFieldDescriptionprivate final BiFunction
<Minecraft, Screen, Screen> The field for thescreenFunction
record component. -
Constructor Summary
ConstructorDescriptionConfigScreenFactory
(BiFunction<Minecraft, Screen, Screen> screenFunction) Creates an instance of aConfigScreenFactory
record class.ConfigScreenFactory
(Function<Screen, Screen> screenFunction) -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.Returns the value of thescreenFunction
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
screenFunction
The field for thescreenFunction
record component.
-
-
Constructor Details
-
ConfigScreenFactory
- Parameters:
screenFunction
- A function that takes the mods screen as an argument and returns your config screen to show when the player clicks the config button for your mod on the mods screen.You should call
Minecraft.setScreen(Screen)
with the provided mods screen for the action of your close button, usingScreen.minecraft
to get the client instance.
-
ConfigScreenFactory
Creates an instance of aConfigScreenFactory
record class.- Parameters:
screenFunction
- the value for thescreenFunction
record component
-
-
Method Details
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
screenFunction
Returns the value of thescreenFunction
record component.- Returns:
- the value of the
screenFunction
record component
-