Record Class Consumable

java.lang.Object
java.lang.Record
idlab.colonyops.model.entities.inventory.Consumable
Record Components:
type - the effect this consumable grants
turnsLeft - turns remaining before the effect expires
public record Consumable(ConsumableType type, int turnsLeft) extends Record
An active consumable effect on a SquadMember. A member can have at most one active consumable at a time; deploying a new one replaces the current one.

  • Constructor Details

    • Consumable

      public Consumable(ConsumableType type, int turnsLeft)
      Creates an instance of a Consumable record class.
      Parameters:
      type - the value for the type record component
      turnsLeft - the value for the turnsLeft 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.

    • type

      public ConsumableType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • turnsLeft

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