org.spongepowered.api.event.impl

Class AbstractHealEntityEvent

java.lang.Object

org.spongepowered.api.event.impl.AbstractEvent

org.spongepowered.api.event.impl.AbstractModifierEvent<HealthFunction,HealthModifier>

org.spongepowered.api.event.impl.AbstractHealEntityEvent

All Implemented Interfaces:

Cancellable, HealEntityEvent, TargetEntityEvent, Event

public abstract class AbstractHealEntityEvent
extends AbstractModifierEvent<HealthFunction,HealthModifier>
implements HealEntityEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected double	baseHealAmount
protected List<HealthFunction>	originalFunctions
protected double	originalHealAmount

Fields inherited from class org.spongepowered.api.event.impl.AbstractModifierEvent

modifierFunctions, modifiers, originalFinalAmount, originalModifierMap, originalModifiers

Fields inherited from class org.spongepowered.api.event.impl.AbstractEvent

currentOrder

Constructor Summary

Constructors

Constructor and Description
AbstractHealEntityEvent()

Method Summary

Modifier and Type	Method and Description
protected HealthFunction	convertTuple(HealthModifier obj, DoubleUnaryOperator function)
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.
double	getOriginalFinalHealAmount() Gets the original "final" amount of healing after all original HealthModifiers are applied to HealEntityEvent.getOriginalHealAmount().
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.
protected void	init() Called once all fields have been set by the generated constructor in a subclass.
boolean	isModifierApplicable(HealthModifier healthModifier) Checks whether the provided HealthModifier is applicable to the current available HealthModifiers.
void	setBaseHealAmount(double baseHealAmount) 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 class org.spongepowered.api.event.impl.AbstractModifierEvent

getFinalAmount, getModifiers, init, recalculateDamages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getModifiers, getOriginalFunctions, getOriginalHealAmount

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

Field Detail

originalHealAmount

protected double originalHealAmount

originalFunctions

protected List<HealthFunction> originalFunctions

baseHealAmount

protected double baseHealAmount

Constructor Detail

AbstractHealEntityEvent

public AbstractHealEntityEvent()

Method Detail

init

protected final void init()

Description copied from class: AbstractEvent

Called once all fields have been set by the generated constructor in a subclass.

This method should be used to initialize any fields that depend on parameters passed to the constructor.

Overrides:

init in class AbstractEvent

getOriginalHealingModifierAmount

public final double getOriginalHealingModifierAmount(HealthModifier healthModifier)

Description copied from interface: HealEntityEvent

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

Specified by:

getOriginalHealingModifierAmount in interface HealEntityEvent

Parameters:

healthModifier - The original healing modifier

Returns:

The original healing change

getOriginalFinalHealAmount

public final double getOriginalFinalHealAmount()

Description copied from interface: HealEntityEvent

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

Specified by:

getOriginalFinalHealAmount in interface HealEntityEvent

Returns:

The final amount of healing to originally deal

getOriginalHealingAmounts

public final Map<HealthModifier,Double> getOriginalHealingAmounts()

Description copied from interface: HealEntityEvent

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

Specified by:

getOriginalHealingAmounts in interface HealEntityEvent

Returns:

An immutable map of the original modified heal amounts

getFinalHealAmount

public final double getFinalHealAmount()

Description copied from interface: HealEntityEvent

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

Specified by:

getFinalHealAmount in interface HealEntityEvent

Returns:

The final heal amount to deal

isModifierApplicable

public final boolean isModifierApplicable(HealthModifier healthModifier)

Description copied from interface: HealEntityEvent

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

Specified by:

isModifierApplicable in interface HealEntityEvent

Parameters:

healthModifier - The health modifier to check

Returns:

True if the health modifier is relevant to this event

getHealAmount

public final double getHealAmount(HealthModifier healthModifier)

Description copied from interface: HealEntityEvent

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

Specified by:

getHealAmount in interface HealEntityEvent

Parameters:

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

Returns:

The modifier

setHealAmount

public final void setHealAmount(HealthModifier healthModifier,
                                DoubleUnaryOperator function)

Description copied from interface: HealEntityEvent

Sets the provided DoubleUnaryOperator to be used for the given HealthModifier. If the HealthModifier is already included in HealEntityEvent.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 HealEntityEvent.getBaseHealAmount().

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

Specified by:

setHealAmount in interface HealEntityEvent

Parameters:

healthModifier - The heal amount modifier

function - The function to map to the modifier

getBaseHealAmount

public double getBaseHealAmount()

Description copied from interface: HealEntityEvent

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.

Specified by:

getBaseHealAmount in interface HealEntityEvent

Returns:

The base heal amount

setBaseHealAmount

public final void setBaseHealAmount(double baseHealAmount)

Description copied from interface: HealEntityEvent

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.

Specified by:

setBaseHealAmount in interface HealEntityEvent

Parameters:

baseHealAmount - The base heal amount

convertTuple

protected HealthFunction convertTuple(HealthModifier obj,
                                      DoubleUnaryOperator function)

Specified by:

convertTuple in class AbstractModifierEvent<HealthFunction,HealthModifier>