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

Class DamageFunction

java.lang.Object

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

All Implemented Interfaces:

ModifierFunction<DamageModifier>

public class DamageFunction
extends Object
implements ModifierFunction<DamageModifier>

Field Summary

Fields

Modifier and Type	Field	Description
static DoubleUnaryOperator	ZERO_DAMAGE

Constructor Summary

Constructors

Constructor	Description
DamageFunction(DamageModifier modifier)	Creates a new DamageFunction with the provided DamageModifier.
DamageFunction(DamageModifier modifier, DoubleUnaryOperator function)	Creates a new DamageFunction with the provided DamageModifier and DoubleUnaryOperator.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
DoubleUnaryOperator	function()	Gets the DoubleUnaryOperator for this function.
int	hashCode()
DamageModifier	modifier()	Gets the DamageModifier for this function.
static DamageFunction	of(DamageModifier first, DoubleUnaryOperator second)	Constructs a new damage function.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO_DAMAGE

public static final DoubleUnaryOperator ZERO_DAMAGE

Constructor Detail

DamageFunction

public DamageFunction(DamageModifier modifier)

Creates a new DamageFunction with the provided DamageModifier. The caveat is that the provided DamageFunction is by default going to provide 0 damage modifications.

Parameters:

modifier - The damage modifier

DamageFunction

public DamageFunction(DamageModifier modifier,
                      DoubleUnaryOperator function)

Creates a new DamageFunction with the provided DamageModifier and DoubleUnaryOperator.

Parameters:

modifier - The modifier

function - The function

Method Detail

of

public static DamageFunction of(DamageModifier first,
                                DoubleUnaryOperator second)

Constructs a new damage function.

Parameters:

first - The damage modifier to use

second - The unary operator to use

Returns:

The resulting damage function

modifier

public DamageModifier modifier()

Gets the DamageModifier for this function.

Specified by:

modifier in interface ModifierFunction<DamageModifier>

Returns:

The damage modifier

function

public DoubleUnaryOperator function()

Gets the DoubleUnaryOperator for this function.

Specified by:

function in interface ModifierFunction<DamageModifier>

Returns:

The damage function

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object