Record Class ConsumableDeployCallInOutcome

java.lang.Object
java.lang.Record
idlab.colonyops.model.events.ConsumableDeployCallInOutcome
Record Components:
command - the call-in command that was executed
consumable - the consumable applied to the squad member (type and remaining turns)
healAmount - HP actually restored by OrbitalCallInCommand.DEPLOY_MEDIC_KIT; null for other types
All Implemented Interfaces:
ActionOutcome
public record ConsumableDeployCallInOutcome(OrbitalCallInCommand command, Consumable consumable, Integer healAmount) extends Record implements ActionOutcome
Outcome for consumable deploy call-ins: OrbitalCallInCommand.DEPLOY_JETPACK, OrbitalCallInCommand.DEPLOY_MAGMA_BORE, OrbitalCallInCommand.DEPLOY_MEDIC_KIT and OrbitalCallInCommand.DEPLOY_AMMO_PACK.

  • Constructor Details

    • ConsumableDeployCallInOutcome

      public ConsumableDeployCallInOutcome(OrbitalCallInCommand command, Consumable consumable, Integer healAmount)
      Creates an instance of a ConsumableDeployCallInOutcome record class.
      Parameters:
      command - the value for the command record component
      consumable - the value for the consumable record component
      healAmount - the value for the healAmount 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • command

      public OrbitalCallInCommand command()
      Returns the value of the command record component.
      Returns:
      the value of the command record component

    • consumable

      public Consumable consumable()
      Returns the value of the consumable record component.
      Returns:
      the value of the consumable record component

    • healAmount

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