org.spongepowered.api.event.cause.entity.health

Class HealthFunction

java.lang.Object

org.spongepowered.api.event.cause.entity.health.HealthFunction

All Implemented Interfaces:

ModifierFunction<HealthModifier>

public class HealthFunction
extends Object
implements ModifierFunction<HealthModifier>

Field Summary

Fields

Modifier and Type	Field and Description
static DoubleUnaryOperator	NO_HEALTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
DoubleUnaryOperator	getFunction() Gets the DoubleUnaryOperator for this function.
HealthModifier	getModifier() Gets the HealthModifier for this function.
int	hashCode()
static HealthFunction	of(HealthModifier first, DoubleUnaryOperator second) Constructs a new health function.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_HEALTH

public static final DoubleUnaryOperator NO_HEALTH

Constructor Detail

HealthFunction

public HealthFunction(HealthModifier modifier)

Creates a new HealthFunction with the provided HealthModifier. The caveat is that the provided DoubleUnaryOperator is by default going to provide 0 healing modifications.

Parameters:

modifier - The damage modifier

HealthFunction

public HealthFunction(HealthModifier modifier,
                      DoubleUnaryOperator function)

Creates a new HealthFunction with the provided HealthModifier and function.

Parameters:

modifier - The health modifier to use

function - The double unary operator to use

Method Detail

of

public static HealthFunction of(HealthModifier first,
                                DoubleUnaryOperator second)

Constructs a new health function.

Parameters:

first - The health modifier to use

second - The unary operator to use

Returns:

The resulting health function

getModifier

public HealthModifier getModifier()

Gets the HealthModifier for this function.

Specified by:

getModifier in interface ModifierFunction<HealthModifier>

Returns:

The health modifier

getFunction

public DoubleUnaryOperator getFunction()

Gets the DoubleUnaryOperator for this function.

Specified by:

getFunction in interface ModifierFunction<HealthModifier>

Returns:

The healing function

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object