Package org.spongepowered.api.entity.attribute

Interface AttributeModifier

All Superinterfaces:

Keyed, ResourceKeyed

public interface AttributeModifier
extends ResourceKeyed

Represents a modifier to a value in a Attribute which is transformed by an AttributeOperation.

Modifiers are usually found on ItemStacks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AttributeModifier.Builder	Represents a builder class to create AttributeModifiers.

Method Summary

Modifier and Type	Method	Description
double	amount()	Gets the amount this attribute will be modified by.
static AttributeModifier.Builder	builder()	Creates a new AttributeModifier.Builder to create an AttributeModifier.
static AttributeModifier	of(ResourceKey key, Supplier<? extends AttributeOperation> operation, double amount)	Creates an attribute modifier with the given values.
static AttributeModifier	of(ResourceKey key, AttributeOperation operation, double amount)	Creates an attribute modifier with the given values.
AttributeOperation	operation()	Gets this modifier's operation.

Methods inherited from interface org.spongepowered.api.ResourceKeyed

key

Method Details

of

static AttributeModifier of(ResourceKey key,
 Supplier<? extends AttributeOperation> operation,
 double amount)

Creates an attribute modifier with the given values.

Parameters:

key - The resource key

operation - The attribute operation

amount - The amount

Returns:

The attribute modifier

of

static AttributeModifier of(ResourceKey key,
 AttributeOperation operation,
 double amount)

Creates an attribute modifier with the given values.

Parameters:

key - The resource key

operation - The attribute operation

amount - The amount

Returns:

The attribute modifier

builder

static AttributeModifier.Builder builder()

Creates a new AttributeModifier.Builder to create an AttributeModifier.

Returns:

The new builder

operation

AttributeOperation operation()

Gets this modifier's operation.

Returns:

The operation

amount

double amount()

Gets the amount this attribute will be modified by.

Returns:

The amount