Record Class ConsumableEffectOutcome

java.lang.Object
java.lang.Record
idlab.colonyops.model.events.ConsumableEffectOutcome
Record Components:
consumableType - the type of consumable that fired
turnsLeft - remaining turns of the consumable after this tick (0 = expired this turn)
healAmount - HP restored this tick; only present for ConsumableType.MEDIC_KIT
usesRestored - uses restored to the weapon this tick; only present for ConsumableType.AMMO_PACK
weaponUsesLeft - total uses left on the weapon after the restore; only present for ConsumableType.AMMO_PACK
All Implemented Interfaces:
ActionOutcome
public record ConsumableEffectOutcome(ConsumableType consumableType, int turnsLeft, Integer healAmount, Integer usesRestored, Integer weaponUsesLeft) extends Record implements ActionOutcome
Outcome for a passive per-turn consumable effect.

Reported every turn for ConsumableType.MEDIC_KIT and ConsumableType.AMMO_PACK. JETPACK and MAGMA_BORE are not reported this way; their effect applies at the point of use.

  • Constructor Details

    • ConsumableEffectOutcome

      public ConsumableEffectOutcome(ConsumableType consumableType, int turnsLeft, Integer healAmount, Integer usesRestored, Integer weaponUsesLeft)
      Creates an instance of a ConsumableEffectOutcome record class.
      Parameters:
      consumableType - the value for the consumableType record component
      turnsLeft - the value for the turnsLeft record component
      healAmount - the value for the healAmount record component
      usesRestored - the value for the usesRestored record component
      weaponUsesLeft - the value for the weaponUsesLeft 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.

    • consumableType

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

    • turnsLeft

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

    • healAmount

      public Integer healAmount()
      Returns the value of the healAmount record component.
      Returns:
      the value of the healAmount record component

    • usesRestored

      public Integer usesRestored()
      Returns the value of the usesRestored record component.
      Returns:
      the value of the usesRestored record component

    • weaponUsesLeft

      public Integer weaponUsesLeft()
      Returns the value of the weaponUsesLeft record component.
      Returns:
      the value of the weaponUsesLeft record component