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

Interface DamageModifier

public interface DamageModifier

A damage modifier that will create a DamageStep.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DamageModifier.Builder	A builder to create DamageModifiers.
static interface	DamageModifier.Function

Method Summary

Modifier and Type	Method	Description
static DamageModifier.Builder	builder()	Creates a new DamageModifier.Builder to create DamageModifiers.
Optional<DamageModifier.Function>	damageFunction()	Gets the function that will modify the damage.
Optional<Consumer<CauseStackManager.StackFrame>>	frameModifier()	Gets the consumer that will modify the cause frame.
DamageStepType	type()	Gets the DamageStepType of this modifier.

Method Details

type

DamageStepType type()

Gets the DamageStepType of this modifier.

Returns:

the step type

frameModifier

Optional<Consumer<CauseStackManager.StackFrame>> frameModifier()

Gets the consumer that will modify the cause frame.

Returns:

The cause frame modifier

damageFunction

Optional<DamageModifier.Function> damageFunction()

Gets the function that will modify the damage. The function may be absent if the sole purpose of this modifier is to apply children steps.

Returns:

the damage modifier

builder

static DamageModifier.Builder builder()

Creates a new DamageModifier.Builder to create DamageModifiers.

Returns:

The new builder