Record Class WorldFluid

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.world.WorldFluid
Record Components:
source - whether the block is a source block (it can be picked up), not flowing fluid
public record WorldFluid(@NotNull net.kyori.adventure.key.Key fluid, boolean source) extends Record
A fluid in a world block, as the platform names it (e.g. minecraft:water): the core gives these ids no meaning (E5).

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorldFluid(@NotNull net.kyori.adventure.key.Key fluid, boolean source)
    Creates an instance of a WorldFluid record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull net.kyori.adventure.key.Key
    fluid()
    Returns the value of the fluid record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    source()
    Returns the value of the source record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • WorldFluid

      public WorldFluid(@NotNull @NotNull net.kyori.adventure.key.Key fluid, boolean source)
      Creates an instance of a WorldFluid record class.
      Parameters:
      fluid - the value for the fluid record component
      source - the value for the source 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 the compare method from their corresponding wrapper classes.
      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.

    • fluid

      @NotNull public @NotNull net.kyori.adventure.key.Key fluid()
      Returns the value of the fluid record component.
      Returns:
      the value of the fluid record component

    • source

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