Package net.neoforged.neoforge.network.configuration

Record Class ModdedConfigurationPhaseStarted

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.configuration.ModdedConfigurationPhaseStarted
Record Components:
listener - The listener that is handling the configuration.
All Implemented Interfaces:
ConfigurationTask, ICustomConfigurationTask
@Internal public record ModdedConfigurationPhaseStarted(ServerConfigurationPacketListenerImpl listener) extends Record implements ICustomConfigurationTask
Custom configuration task that is run to indicate that the modded configuration phase has started.

  • Field Details

  • Constructor Details

    • ModdedConfigurationPhaseStarted

      public ModdedConfigurationPhaseStarted(ServerConfigurationPacketListenerImpl listener)
      Creates an instance of a ModdedConfigurationPhaseStarted record class.
      Parameters:
      listener - the value for the listener record component

  • Method Details

    • run

      public void run(Consumer<CustomPacketPayload> sender)
      Description copied from interface: ICustomConfigurationTask
      Invoked when it is time for this configuration to run.
      Specified by:
      run in interface ICustomConfigurationTask
      Parameters:
      sender - A consumer that accepts a CustomPacketPayload to send to the client.

    • type

      public ConfigurationTask.Type type()
      Specified by:
      type in interface ConfigurationTask

    • 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.

    • listener

      public ServerConfigurationPacketListenerImpl listener()
      Returns the value of the listener record component.
      Returns:
      the value of the listener record component