Package forestry.api.fuels

Record Class RainSubstrate

java.lang.Object
java.lang.Record
forestry.api.fuels.RainSubstrate
Record Components:
item - Rain substrate capable of activating the rainmaker.
duration - Duration of the rain shower triggered by this substrate in Minecraft ticks.
speed - Speed of activation sequence triggered.
reverse - Whether the substrate stops rain instead of creating rain.
public record RainSubstrate(net.minecraft.world.item.ItemStack item, int duration, float speed, boolean reverse) extends Record
todo data driven

  • Constructor Summary

    Constructors
    Constructor
    Description
    RainSubstrate(net.minecraft.world.item.ItemStack item, float speed)
     
    RainSubstrate(net.minecraft.world.item.ItemStack item, int duration, float speed)
     
    RainSubstrate(net.minecraft.world.item.ItemStack item, int duration, float speed, boolean reverse)
    Creates an instance of a RainSubstrate record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    duration()
    Returns the value of the duration record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.minecraft.world.item.ItemStack
    item()
    Returns the value of the item record component.
    boolean
    reverse()
    Returns the value of the reverse record component.
    float
    speed()
    Returns the value of the speed record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RainSubstrate

      public RainSubstrate(net.minecraft.world.item.ItemStack item, float speed)

    • RainSubstrate

      public RainSubstrate(net.minecraft.world.item.ItemStack item, int duration, float speed)

    • RainSubstrate

      public RainSubstrate(net.minecraft.world.item.ItemStack item, int duration, float speed, boolean reverse)
      Creates an instance of a RainSubstrate record class.
      Parameters:
      item - the value for the item record component
      duration - the value for the duration record component
      speed - the value for the speed record component
      reverse - the value for the reverse 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • item

      public net.minecraft.world.item.ItemStack item()
      Returns the value of the item record component.
      Returns:
      the value of the item record component

    • duration

      public int duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component

    • speed

      public float speed()
      Returns the value of the speed record component.
      Returns:
      the value of the speed record component

    • reverse

      public boolean reverse()
      Returns the value of the reverse record component.
      Returns:
      the value of the reverse record component