Record Class LootOutcome

java.lang.Object

java.lang.Record

idlab.colonyops.model.events.LootOutcome

Record Components:

lootedWeapon - copy of the weapon looted from the target; null if no weapon was looted

lootedResources - resources actually transferred from the target's crate, keyed by type

remainingWeapon - weapon still remaining on the target after looting; null if none remains

remainingResources - resources still remaining in the target's crate after looting

All Implemented Interfaces:

ActionOutcome

public record LootOutcome(Weapon lootedWeapon, Map<ResourceType, Integer> lootedResources, Weapon remainingWeapon, Map<ResourceType, Integer> remainingResources)
extends Record
implements ActionOutcome

Outcome for a successfully applied LootAction.

Constructor Summary

Constructors

Constructor	Description
LootOutcome(Weapon lootedWeapon, Map<ResourceType, Integer> lootedResources, Weapon remainingWeapon, Map<ResourceType, Integer> remainingResources)	Creates an instance of a LootOutcome 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.
Map<ResourceType, Integer>	lootedResources()	Returns the value of the lootedResources record component.
Weapon	lootedWeapon()	Returns the value of the lootedWeapon record component.
Map<ResourceType, Integer>	remainingResources()	Returns the value of the remainingResources record component.
Weapon	remainingWeapon()	Returns the value of the remainingWeapon 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

LootOutcome

public LootOutcome(Weapon lootedWeapon,
 Map<ResourceType, Integer> lootedResources,
 Weapon remainingWeapon,
 Map<ResourceType, Integer> remainingResources)

Creates an instance of a LootOutcome record class.

Parameters:

lootedWeapon - the value for the lootedWeapon record component

lootedResources - the value for the lootedResources record component

remainingWeapon - the value for the remainingWeapon record component

remainingResources - the value for the remainingResources 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 Objects::equals(Object,Object).

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.

lootedWeapon

public Weapon lootedWeapon()

Returns the value of the lootedWeapon record component.

Returns:

the value of the lootedWeapon record component

lootedResources

public Map<ResourceType, Integer> lootedResources()

Returns the value of the lootedResources record component.

Returns:

the value of the lootedResources record component

remainingWeapon

public Weapon remainingWeapon()

Returns the value of the remainingWeapon record component.

Returns:

the value of the remainingWeapon record component

remainingResources

public Map<ResourceType, Integer> remainingResources()

Returns the value of the remainingResources record component.

Returns:

the value of the remainingResources record component