Record Class AttackOutcome

java.lang.Object

java.lang.Record

idlab.colonyops.model.events.AttackOutcome

Record Components:

damageApplied - the damage actually dealt to the target

targetHpLeft - the target's remaining health points

targetColonyId - colony id of the target if the target belongs to a colony, null otherwise

All Implemented Interfaces:

ActionOutcome

public record AttackOutcome(int damageApplied, int targetHpLeft, String targetColonyId)
extends Record
implements ActionOutcome

Outcome for a successfully applied AttackAction.

Constructor Summary

Constructors

Constructor	Description
AttackOutcome(int damageApplied, int targetHpLeft, String targetColonyId)	Creates an instance of a AttackOutcome record class.

Method Summary

Modifier and Type	Method	Description
int	damageApplied()	Returns the value of the damageApplied record component.
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.
String	targetColonyId()	Returns the value of the targetColonyId record component.
int	targetHpLeft()	Returns the value of the targetHpLeft 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

AttackOutcome

public AttackOutcome(int damageApplied,
 int targetHpLeft,
 String targetColonyId)

Creates an instance of a AttackOutcome record class.

Parameters:

damageApplied - the value for the damageApplied record component

targetHpLeft - the value for the targetHpLeft record component

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

damageApplied

public int damageApplied()

Returns the value of the damageApplied record component.

Returns:

the value of the damageApplied record component

targetHpLeft

public int targetHpLeft()

Returns the value of the targetHpLeft record component.

Returns:

the value of the targetHpLeft record component

targetColonyId

public String targetColonyId()

Returns the value of the targetColonyId record component.

Returns:

the value of the targetColonyId record component