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 the Minecraft 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>

  • Field Details

  • Constructor Details

    • ConfigScreenFactory

      public ConfigScreenFactory(Function<Screen,Screen> screenFunction)
      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, using Screen.minecraft to get the client instance.

    • ConfigScreenFactory

      public ConfigScreenFactory(BiFunction<Minecraft,Screen,Screen> screenFunction)
      Creates an instance of a ConfigScreenFactory record class.
      Parameters:
      screenFunction - the value for the screenFunction record component

  • Method Details

    • toString

      public final String 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.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • 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.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      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 with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • screenFunction

      public BiFunction<Minecraft,Screen,Screen> screenFunction()
      Returns the value of the screenFunction record component.
      Returns:
      the value of the screenFunction record component