Record Class SpawnCost

java.lang.Object
java.lang.Record
dev.wyck.wrapper.entity.data.SpawnCost
Record Components:
charge - the amount of energy required to spawn the entity
energyBudget - the maximum amount of energy that can be used to spawn the entity
@NullMarked @AsOf("2.3.0") public record SpawnCost(double charge, double energyBudget) extends Record
Represents the cost of spawning an entity.
Since:
2.3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpawnCost(double charge, double energyBudget)
    Creates an instance of a SpawnCost record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    charge()
    Returns the value of the charge record component.
    double
    energyBudget()
    Returns the value of the energyBudget 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.
    static SpawnCost
    of(double charge, double energyBudget)
     
    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

    • SpawnCost

      public SpawnCost(double charge, double energyBudget)
      Creates an instance of a SpawnCost record class.
      Parameters:
      charge - the value for the charge record component
      energyBudget - the value for the energyBudget record component

  • Method Details

    • of

      @AsOf("2.3.0") public static SpawnCost of(double charge, double energyBudget)

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

    • charge

      public double charge()
      Returns the value of the charge record component.
      Returns:
      the value of the charge record component

    • energyBudget

      public double energyBudget()
      Returns the value of the energyBudget record component.
      Returns:
      the value of the energyBudget record component