Record Class GameOverActionOutcome

java.lang.Object

java.lang.Record

idlab.colonyops.model.events.GameOverActionOutcome

Record Components:

missionEndedOnTurn - the last turn that was played: the state of the world at the end of this turn is the final state

All Implemented Interfaces:

ActionOutcome

public record GameOverActionOutcome(int missionEndedOnTurn)
extends Record
implements ActionOutcome

Outcome of the final MissionEvent of a mission, reported (not caused by a squad member's action) when the mission ends.

It is not about any entity of the world, so the event is exceptional in two ways:

• MissionEvent.subjectEntityId() is the empty string and MissionEvent.subjectLocation() is Location(0, 0): they are placeholders, which must not be looked up or acted on;
• MissionEvent.turnNumber() is the turn after the last completed one (missionEndedOnTurn + 1), so that logic which already has the state of the last turn (and so skips the events of that turn) does not miss this event.

Constructor Summary

Constructors

Constructor	Description
GameOverActionOutcome(int missionEndedOnTurn)	Creates an instance of a GameOverActionOutcome 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.
int	missionEndedOnTurn()	Returns the value of the missionEndedOnTurn record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

GameOverActionOutcome

public GameOverActionOutcome(int missionEndedOnTurn)

Creates an instance of a GameOverActionOutcome record class.

Parameters:

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

missionEndedOnTurn

public int missionEndedOnTurn()

Returns the value of the missionEndedOnTurn record component.

Returns:

the value of the missionEndedOnTurn record component