Record Class ActionRequest

java.lang.Object

java.lang.Record

idlab.colonyops.model.actions.ActionRequest

Record Components:

turnNumber - the current turn

member - the full state of the squad member to act for (HP, location, weapon, consumable, crate contents)

locationsInView - all tiles within the squad member's vision range, including the entities present at each tile

public record ActionRequest(int turnNumber, SquadMember member, List<EntitiesAtLocation> locationsInView)
extends Record

Sent to POST /missions/{missionId}/request-action when the engine needs an Action for a specific squad member this turn.

Constructor Summary

Constructors

Constructor	Description
ActionRequest(int turnNumber, SquadMember member, List<EntitiesAtLocation> locationsInView)	Creates an instance of a ActionRequest 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.
List<EntitiesAtLocation>	locationsInView()	Returns the value of the locationsInView record component.
SquadMember	member()	Returns the value of the member 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

ActionRequest

public ActionRequest(int turnNumber,
 SquadMember member,
 List<EntitiesAtLocation> locationsInView)

Creates an instance of a ActionRequest record class.

Parameters:

turnNumber - the value for the turnNumber record component

member - the value for the member record component

locationsInView - the value for the locationsInView 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

member

public SquadMember member()

Returns the value of the member record component.

Returns:

the value of the member record component

locationsInView

public List<EntitiesAtLocation> locationsInView()

Returns the value of the locationsInView record component.

Returns:

the value of the locationsInView record component