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

Interface DamageModifier

@Immutable
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 and Description
static class	DamageModifier.Builder A builder that creates DamageModifiers, for use in both plugin and implementation requirements.

Method Summary

Modifier and Type	Method and Description
static DamageModifier.Builder	builder() Creates a new DamageModifier.Builder for constructing a DamageModifier.
Cause	getCause() Gets the cause of this DamageModifier.
Optional<ItemStackSnapshot>	getContributingItem() Gets the contributing ItemStackSnapshot that provided the "reason" for this DamageModifier to exist.
DamageModifierType	getType() Gets the DamageModifierType for this DamageModifier.

Method Detail

builder

static DamageModifier.Builder builder()

Creates a new DamageModifier.Builder for constructing a DamageModifier.

Returns:

A new builder

getType

DamageModifierType getType()

Gets the DamageModifierType for this DamageModifier.

Returns:

The damage modifier type

getCause

Cause getCause()

Gets the cause of this DamageModifier.

Returns:

The cause of this damage modifier

getContributingItem

Optional<ItemStackSnapshot> getContributingItem()

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