Record Class IonStrikeHit

java.lang.Object

java.lang.Record

idlab.colonyops.model.events.IonStrikeHit

Record Components:

entityId - the entity that was hit

damageApplied - the damage actually dealt

hpLeft - the entity's remaining health points

public record IonStrikeHit(String entityId, int damageApplied, int hpLeft)
extends Record

Hit report for a single entity damaged by an ion strike.

Constructor Summary

Constructors

Constructor	Description
IonStrikeHit(String entityId, int damageApplied, int hpLeft)	Creates an instance of a IonStrikeHit record class.

Method Summary

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

IonStrikeHit

public IonStrikeHit(String entityId,
 int damageApplied,
 int hpLeft)

Creates an instance of a IonStrikeHit record class.

Parameters:

entityId - the value for the entityId record component

damageApplied - the value for the damageApplied record component

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

entityId

public String entityId()

Returns the value of the entityId record component.

Returns:

the value of the entityId record component

damageApplied

public int damageApplied()

Returns the value of the damageApplied record component.

Returns:

the value of the damageApplied record component

hpLeft

public int hpLeft()

Returns the value of the hpLeft record component.

Returns:

the value of the hpLeft record component