Package org.spongepowered.api.event.cause.entity.damage

Interface DamageModifier

public interface DamageModifier

Represents a modifier that will apply a function on a damage value to deal towards an entity such that the raw damage is the input of a DoubleUnaryOperator such that the output will be the final damage applied to the Entity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DamageModifier.Builder	A builder that creates DamageModifiers, for use in both plugin and implementation requirements.

Method Summary

Modifier and Type	Method	Description
static DamageModifier.Builder	builder()	Creates a new DamageModifier.Builder for constructing a DamageModifier.
Cause	cause()	Gets the cause of this DamageModifier.
Optional<ItemStackSnapshot>	contributingItem()	Gets the contributing ItemStackSnapshot that provided the "reason" for this DamageModifier to exist.
String	group()	Returns the damage modifier group.
DamageModifierType	type()	Gets the DamageModifierType for this DamageModifier.

Method Details

builder

static DamageModifier.Builder builder()

Creates a new DamageModifier.Builder for constructing a DamageModifier.

Returns:

A new builder

type

DamageModifierType type()

Gets the DamageModifierType for this DamageModifier.

Returns:

The damage modifier type

group

String group()

Returns the damage modifier group.

Grouped modifiers calculate their damage independently from each other

Returns:

The damage modifier group

cause

Cause cause()

Gets the cause of this DamageModifier.

Returns:

The cause of this damage modifier

contributingItem

Optional<ItemStackSnapshot> contributingItem()

Gets the contributing ItemStackSnapshot that provided the "reason" for this DamageModifier to exist. An example of a contributing ItemStack is if an ItemTypes.DIAMOND_SWORD provided an Enchantment that provided a DamageModifierTypes.WEAPON_ENCHANTMENT, this modifier would have the ItemStackSnapshot for the weapon used. Some modifiers however, do not require an ItemStack to be the contributing factor for this modifier to exist.

Returns:

The contributing item, if available