Record Class LargeDepositFoundOutcome

java.lang.Object
java.lang.Record
idlab.colonyops.model.events.LargeDepositFoundOutcome
Record Components:
colonyId - the colony whose scan discovered this deposit
deposit - the newly discovered large resource deposit
All Implemented Interfaces:
ActionOutcome
public record LargeDepositFoundOutcome(String colonyId, ResourceDeposit deposit) extends Record implements ActionOutcome
Outcome reported (not caused by a squad member's action) when a colony's orbital scan discovers a large resource deposit. The MissionEvent.subjectEntityId() is the newly discovered deposit's entity ID and MissionEvent.subjectLocation() is the deposit's location.

  • Constructor Details

    • LargeDepositFoundOutcome

      public LargeDepositFoundOutcome(String colonyId, ResourceDeposit deposit)
      Creates an instance of a LargeDepositFoundOutcome record class.
      Parameters:
      colonyId - the value for the colonyId record component
      deposit - the value for the deposit 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.

    • colonyId

      public String colonyId()
      Returns the value of the colonyId record component.
      Returns:
      the value of the colonyId record component

    • deposit

      public ResourceDeposit deposit()
      Returns the value of the deposit record component.
      Returns:
      the value of the deposit record component