Record Class DepositFoundEvent

java.lang.Object

java.lang.Record

idlab.colonyops.model.DepositFoundEvent

Record Components:

turnNumber - the turn on which the discovery was made

location - the coordinates where the large deposit spawned

resourceType - the type of resource contained in the deposit

public record DepositFoundEvent(int turnNumber, Location location, ResourceType resourceType)
extends Record

Notifies the player's logic service that the colony's orbital scan has discovered a new large resource deposit, via POST /missions/{missionId}/scan-completed.

Large deposits contain substantially more resources than normal deposits found during planet generation. Discovery intel may be intercepted by rival colonies, letting them race to the site as well.

Constructor Summary

Constructors

Constructor	Description
DepositFoundEvent(int turnNumber, Location location, ResourceType resourceType)	Creates an instance of a DepositFoundEvent record class.

Method Summary

Modifier and Type	Method	Description
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.
Location	location()	Returns the value of the location record component.
ResourceType	resourceType()	Returns the value of the resourceType record component.
final String	toString()	Returns a string representation of this record class.
int	turnNumber()	Returns the value of the turnNumber record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DepositFoundEvent

public DepositFoundEvent(int turnNumber,
 Location location,
 ResourceType resourceType)

Creates an instance of a DepositFoundEvent record class.

Parameters:

turnNumber - the value for the turnNumber record component

location - the value for the location record component

resourceType - the value for the resourceType 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.

turnNumber

public int turnNumber()

Returns the value of the turnNumber record component.

Returns:

the value of the turnNumber record component

location

public Location location()

Returns the value of the location record component.

Returns:

the value of the location record component

resourceType

public ResourceType resourceType()

Returns the value of the resourceType record component.

Returns:

the value of the resourceType record component