Record Class AttributeModifier

java.lang.Object

java.lang.Record

fr.fidorial.attribute.AttributeModifier

Record Components:

attribute - the attribute changed, see AttributeKeys

id - the identifier of the modifier, unique per attribute

amount - the amount applied, interpreted according to operation

operation - how the amount combines with the attribute value

slot - the equipment slots the modifier applies in

public record AttributeModifier(Key attribute, Key id, double amount, AttributeModifier.Operation operation, EquipmentSlotGroup slot)
extends Record

A change applied to an attribute of the entity wearing or holding an item.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AttributeModifier.Operation	How the amount of a modifier combines with the attribute value.

Constructor Summary

Constructors

Constructor	Description
AttributeModifier(Key attribute, Key id, double amount, AttributeModifier.Operation operation, EquipmentSlotGroup slot)	Validates the components.

Method Summary

Modifier and Type	Method	Description
double	amount()	Returns the value of the amount record component.
Key	attribute()	Returns the value of the attribute 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.
Key	id()	Returns the value of the id record component.
static AttributeModifier	of(Key attribute, Key id, double amount, AttributeModifier.Operation operation)	Creates a modifier applying in any slot.
static AttributeModifier	of(Key attribute, Key id, double amount, AttributeModifier.Operation operation, EquipmentSlotGroup slot)	Creates a modifier.
AttributeModifier.Operation	operation()	Returns the value of the operation record component.
EquipmentSlotGroup	slot()	Returns the value of the slot 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

AttributeModifier

public AttributeModifier(Key attribute,
 Key id,
 double amount,
 AttributeModifier.Operation operation,
 EquipmentSlotGroup slot)

Validates the components.

Method Details

of

public static AttributeModifier of(Key attribute,
 Key id,
 double amount,
 AttributeModifier.Operation operation,
 EquipmentSlotGroup slot)

Creates a modifier.

Parameters:

attribute - the attribute changed

id - the identifier of the modifier

amount - the amount applied

operation - how the amount combines with the attribute value

slot - the equipment slots the modifier applies in

Returns:

the modifier

Since:

0.1.0

of

public static AttributeModifier of(Key attribute,
 Key id,
 double amount,
 AttributeModifier.Operation operation)

Creates a modifier applying in any slot.

Parameters:

attribute - the attribute changed

id - the identifier of the modifier

amount - the amount applied

operation - how the amount combines with the attribute value

Returns:

the modifier

Since:

0.1.0

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.

attribute

public Key attribute()

Returns the value of the attribute record component.

Returns:

the value of the attribute record component

id

public Key id()

Returns the value of the id record component.

Returns:

the value of the id record component

amount

public double amount()

Returns the value of the amount record component.

Returns:

the value of the amount record component

operation

public AttributeModifier.Operation operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component

slot

public EquipmentSlotGroup slot()

Returns the value of the slot record component.

Returns:

the value of the slot record component