Package com.pixelmonmod.pixelmon.api.battles.scene

Record Class BattleSceneWeatherSettings

java.lang.Object
java.lang.Record
com.pixelmonmod.pixelmon.api.battles.scene.BattleSceneWeatherSettings
Record Components:
mode - whether the scene uses fixed weather or mirrors the real client world
weather - fixed weather used when mode is BattleSceneSettingMode.FIXED
public record BattleSceneWeatherSettings(BattleSceneSettingMode mode, BattleSceneWeather weather) extends Record
Weather behavior for a battle scene.

Fixed weather uses the authored weather from the scene definition. World matching mirrors the real client world.

  • Field Details

  • Constructor Details

    • BattleSceneWeatherSettings

      public BattleSceneWeatherSettings(BattleSceneSettingMode mode, BattleSceneWeather weather)
      Creates an instance of a BattleSceneWeatherSettings record class.
      Parameters:
      mode - the value for the mode record component
      weather - the value for the weather record component

  • Method Details

    • decode

      public static BattleSceneWeatherSettings decode(net.minecraft.network.FriendlyByteBuf buffer)
      Decodes weather settings from a battle scene packet.
      Parameters:
      buffer - the packet buffer to read from
      Returns:
      the decoded weather settings

    • encode

      public void encode(net.minecraft.network.FriendlyByteBuf buffer)
      Encodes these weather settings for a battle scene packet.
      Parameters:
      buffer - the packet buffer to write to

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

    • mode

      public BattleSceneSettingMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • weather

      public BattleSceneWeather weather()
      Returns the value of the weather record component.
      Returns:
      the value of the weather record component