org.spongepowered.api.event.entity

Interface HealEntityEvent

All Superinterfaces:

Cancellable, Event, TargetEntityEvent

All Known Implementing Classes:

AbstractHealEntityEvent

public interface HealEntityEvent
extends TargetEntityEvent, Cancellable

An event where an Entity is "healed". This can usually mean that after a certain amount of "heal amount" the entity is destroyed. Similar to the DamageEntityEvent, this event uses various modifiers

Method Summary

Modifier and Type	Method and Description
double	getBaseHealAmount() Gets the "base" healing amount to apply to the targeted Entity.
double	getFinalHealAmount() Gets the final heal amount that will be applied to the entity.
double	getHealAmount(HealthModifier healthModifier) Gets the heal amount for the provided HealthModifier.
List<HealthFunction>	getModifiers() Gets a list of simple HealthFunctions.
double	getOriginalFinalHealAmount() Gets the original "final" amount of healing after all original HealthModifiers are applied to getOriginalHealAmount().
List<HealthFunction>	getOriginalFunctions() Gets the original List of HealthFunctions that was originally passed into the event.
double	getOriginalHealAmount() Gets the original amount to "heal" the targeted Entity.
Map<HealthModifier,Double>	getOriginalHealingAmounts() Gets an Map of all original HealthModifiers and their associated "modified" heal amount.
double	getOriginalHealingModifierAmount(HealthModifier healthModifier) Gets the original healing amount for the provided HealthModifier.
boolean	isModifierApplicable(HealthModifier healthModifier) Checks whether the provided HealthModifier is applicable to the current available HealthModifiers.
void	setBaseHealAmount(double healAmount) Sets the "base" healing amount to apply to the targeted Entity.
void	setHealAmount(HealthModifier healthModifier, DoubleUnaryOperator function) Sets the provided DoubleUnaryOperator to be used for the given HealthModifier.

Methods inherited from interface org.spongepowered.api.event.entity.TargetEntityEvent

getTargetEntity

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getOriginalHealAmount

double getOriginalHealAmount()

Gets the original amount to "heal" the targeted Entity.

Returns:

The original heal amount

getOriginalFinalHealAmount

double getOriginalFinalHealAmount()

Gets the original "final" amount of healing after all original HealthModifiers are applied to getOriginalHealAmount(). The "final" heal amount is considered the amount gained by the Entity, if health is tracked.

Returns:

The final amount of healing to originally deal

getOriginalHealingAmounts

Map<HealthModifier,Double> getOriginalHealingAmounts()

Gets an Map of all original HealthModifiers and their associated "modified" heal amount. Note that ordering is not retained.

Returns:

An immutable map of the original modified heal amounts

getFinalHealAmount

double getFinalHealAmount()

Gets the final heal amount that will be applied to the entity. The final heal amount is the end result of the getBaseHealAmount() being applied in DoubleUnaryOperator.applyAsDouble(double) available from all the Tuples of HealthModifier to DoubleUnaryOperator in getOriginalFunctions().

Returns:

The final heal amount to deal

getOriginalHealingModifierAmount

double getOriginalHealingModifierAmount(HealthModifier healthModifier)

Gets the original healing amount for the provided HealthModifier. If the provided HealthModifier was not included in getOriginalHealingAmounts(), an IllegalArgumentException is thrown.

Parameters:

healthModifier - The original healing modifier

Returns:

The original healing change

getOriginalFunctions

List<HealthFunction> getOriginalFunctions()

Gets the original List of HealthFunctions that was originally passed into the event.

Returns:

The list of heal amount modifier functions

getBaseHealAmount

double getBaseHealAmount()

Gets the "base" healing amount to apply to the targeted Entity. The "base" heal amount is the original value before passing along the chain of DoubleUnaryOperators for all known HealthModifiers.

Returns:

The base heal amount

setBaseHealAmount

void setBaseHealAmount(double healAmount)

Sets the "base" healing amount to apply to the targeted Entity. The "base" heal amount is the original value passed along the chain of DoubleUnaryOperators for all known HealthModifiers.

Parameters:

healAmount - The base heal amount

isModifierApplicable

boolean isModifierApplicable(HealthModifier healthModifier)

Checks whether the provided HealthModifier is applicable to the current available HealthModifiers.

Parameters:

healthModifier - The health modifier to check

Returns:

True if the health modifier is relevant to this event

getHealAmount

double getHealAmount(HealthModifier healthModifier)

Gets the heal amount for the provided HealthModifier. Providing that isModifierApplicable(HealthModifier) returns true, the cached "heal amount" for the HealthModifier is returned.

Parameters:

healthModifier - The heal amount modifier to get the heal amount for

Returns:

The modifier

setHealAmount

void setHealAmount(HealthModifier healthModifier,
                   DoubleUnaryOperator function)

Sets the provided DoubleUnaryOperator to be used for the given HealthModifier. If the HealthModifier is already included in getModifiers(), the DoubleUnaryOperator replaces the existing function. If there is no HealthFunction for the HealthModifier, a new one is created and added to the end of the list of DoubleUnaryOperators to be applied to the getBaseHealAmount().

If needing to create a custom HealthModifier is required, usage of the HealthModifier.Builder is recommended.

Parameters:

healthModifier - The heal amount modifier

function - The function to map to the modifier

getModifiers

List<HealthFunction> getModifiers()

Gets a list of simple HealthFunctions. All HealthModifier s are applicable to the entity based on the HealingSource and any possible invulnerabilities due to the HealingSource.

Returns:

A list of heal amount modifiers to functions