Package org.spongepowered.api.event.impl.entity

Class AbstractDamageEntityEvent

java.lang.Object

org.spongepowered.api.event.impl.AbstractEvent

org.spongepowered.api.event.impl.entity.AbstractModifierEvent<DamageFunction,DamageModifier>

org.spongepowered.api.event.impl.entity.AbstractDamageEntityEvent

All Implemented Interfaces:

Cancellable, DamageEntityEvent, Event

public abstract class AbstractDamageEntityEvent
extends AbstractModifierEvent<DamageFunction,DamageModifier>
implements DamageEntityEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected double	baseDamage
protected double	originalDamage
protected List<DamageFunction>	originalFunctions

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

modifierFunctions, modifiers, originalFinalAmount, originalModifierMap, originalModifiers

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

currentOrder

Constructor Summary

Constructors

Constructor	Description
AbstractDamageEntityEvent()

Method Summary

Modifier and Type	Method	Description
void	addDamageModifierBefore(DamageModifier damageModifier, DoubleUnaryOperator function, Set<DamageModifierType> before)	Adds the provided DamageModifier and DoubleUnaryOperator to the list of modifiers, such that the Set containing DamageModifierTypes provided in before will appear after the provided damage modifier.
void	addModifierAfter(DamageModifier damageModifier, DoubleUnaryOperator function, Set<DamageModifierType> after)	Adds the provided DamageModifier and DoubleUnaryOperator to the list of modifiers, such that the modifier will appear in order after any current modifiers whose type are included in the provided Set of DamageModifierTypes.
double	baseDamage()	Gets the "base" damage to deal to the targeted Entity.
protected DamageFunction	convertTuple(DamageModifier obj, DoubleUnaryOperator function)
final Tuple<Double,Double>	damage(DamageModifier damageModifier)	Gets the damage for the provided DamageModifier.
final double	finalDamage()	Gets the final damage that will be passed into the proceeding DamageEntityEvent.
protected final void	init()	Called once all fields have been set by the generated constructor in a subclass.
final boolean	isModifierApplicable(DamageModifier damageModifier)	Checks whether the provided DamageModifier is applicable to the current available DamageModifiers.
List<DamageFunction>	modifiers()	Gets the modifiers affecting this event.
final Map<DamageModifier,Tuple<Double,Double>>	originalDamages()	Gets an immutable Map of all original DamageModifiers and their associated "modified" damage.
final double	originalFinalDamage()	Gets the original "final" amount of damage after all original DamageModifiers are applied to DamageEntityEvent.originalDamage().
final Tuple<Double,Double>	originalModifierDamage(DamageModifier damageModifier)	Gets the original damage for the provided DamageModifier.
final void	setBaseDamage(double baseDamage)	Sets the "base" damage to deal to the targeted Entity.
final void	setDamage(DamageModifier damageModifier, DoubleUnaryOperator function)	Sets the provided DamageFunction to be used for the given DamageModifier.
boolean	willCauseDeath()	Returns whether or not this event will cause the entity to die if the event is not cancelled.

Methods inherited from class org.spongepowered.api.event.impl.entity.AbstractModifierEvent

finalAmount, finalAmounts, init, recalculate

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.Cancellable

isCancelled, setCancelled

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

entity, originalDamage, originalFunctions

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

cause, context, source

Field Details

originalDamage

protected double originalDamage

originalFunctions

protected List<DamageFunction> originalFunctions

baseDamage

protected double baseDamage

Constructor Details

AbstractDamageEntityEvent

public AbstractDamageEntityEvent()

Method Details

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

originalModifierDamage

public final Tuple<Double,Double> originalModifierDamage(DamageModifier damageModifier)

Description copied from interface: DamageEntityEvent

Gets the original damage for the provided DamageModifier. If the provided DamageModifier was not included in DamageEntityEvent.originalDamages(), an IllegalArgumentException is thrown.

Specified by:

originalModifierDamage in interface DamageEntityEvent

Parameters:

damageModifier - The original damage modifier

Returns:

The original damage change

originalFinalDamage

public final double originalFinalDamage()

Description copied from interface: DamageEntityEvent

Gets the original "final" amount of damage after all original DamageModifiers are applied to DamageEntityEvent.originalDamage(). The "final" damage is considered the amount of health being lost by the Entity, if health is tracked.

Specified by:

originalFinalDamage in interface DamageEntityEvent

Returns:

The final amount of damage to originally deal

originalDamages

public final Map<DamageModifier,Tuple<Double,Double>> originalDamages()

Description copied from interface: DamageEntityEvent

Gets an immutable Map of all original DamageModifiers and their associated "modified" damage. Note that ordering is not retained.

Specified by:

originalDamages in interface DamageEntityEvent

Returns:

An immutable map of the original modified damages

finalDamage

public final double finalDamage()

Description copied from interface: DamageEntityEvent

Gets the final damage that will be passed into the proceeding DamageEntityEvent. The final damage is the end result of the DamageEntityEvent.baseDamage() being applied in DoubleUnaryOperator.applyAsDouble(double) available from all the Tuples of DamageModifier to DamageFunction in DamageEntityEvent.originalFunctions().

Specified by:

finalDamage in interface DamageEntityEvent

Returns:

The final damage to deal

isModifierApplicable

public final boolean isModifierApplicable(DamageModifier damageModifier)

Description copied from interface: DamageEntityEvent

Checks whether the provided DamageModifier is applicable to the current available DamageModifiers.

Specified by:

isModifierApplicable in interface DamageEntityEvent

Parameters:

damageModifier - The damage modifier to check

Returns:

True if the damage modifier is relevant to this event

damage

public final Tuple<Double,Double> damage(DamageModifier damageModifier)

Description copied from interface: DamageEntityEvent

Gets the damage for the provided DamageModifier. Providing that DamageEntityEvent.isModifierApplicable(DamageModifier) returns true, the cached "damage" for the DamageModifier is returned.

Specified by:

damage in interface DamageEntityEvent

Parameters:

damageModifier - The damage modifier to get the damage for

Returns:

The modifier

setDamage

public final void setDamage(DamageModifier damageModifier,
 DoubleUnaryOperator function)

Description copied from interface: DamageEntityEvent

Sets the provided DamageFunction to be used for the given DamageModifier. If the DamageModifier is already included in DamageEntityEvent.modifiers(), the DoubleUnaryOperator replaces the existing function. If there is no Tuple for the DamageModifier, a new one is created and added to the end of the list of DoubleUnaryOperators to be applied to the DamageEntityEvent.baseDamage().

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

Specified by:

setDamage in interface DamageEntityEvent

Parameters:

damageModifier - The damage modifier

function - The function to map to the modifier

addDamageModifierBefore

public void addDamageModifierBefore(DamageModifier damageModifier,
 DoubleUnaryOperator function,
 Set<DamageModifierType> before)

Description copied from interface: DamageEntityEvent

Adds the provided DamageModifier and DoubleUnaryOperator to the list of modifiers, such that the Set containing DamageModifierTypes provided in before will appear after the provided damage modifier.

Specified by:

addDamageModifierBefore in interface DamageEntityEvent

Parameters:

damageModifier - The damage modifier to add

function - The associated function

before - The set containing the modifier types to come after the provided modifier

addModifierAfter

public void addModifierAfter(DamageModifier damageModifier,
 DoubleUnaryOperator function,
 Set<DamageModifierType> after)

Description copied from interface: DamageEntityEvent

Adds the provided DamageModifier and DoubleUnaryOperator to the list of modifiers, such that the modifier will appear in order after any current modifiers whose type are included in the provided Set of DamageModifierTypes.

Specified by:

addModifierAfter in interface DamageEntityEvent

Parameters:

damageModifier - The damage modifier to add

function - The associated function

after - The set of modifier types to come before the new modifier

convertTuple

protected DamageFunction convertTuple(DamageModifier obj,
 DoubleUnaryOperator function)

Specified by:

convertTuple in class AbstractModifierEvent<DamageFunction,DamageModifier>

modifiers

public List<DamageFunction> modifiers()

Description copied from class: AbstractModifierEvent

Gets the modifiers affecting this event.

Specified by:

modifiers in interface DamageEntityEvent

Overrides:

modifiers in class AbstractModifierEvent<DamageFunction,DamageModifier>

Returns:

The list of modifiers

baseDamage

public double baseDamage()

Description copied from interface: DamageEntityEvent

Gets the "base" damage to deal to the targeted Entity. The "base" damage is the original value before passing along the chain of DamageFunctions for all known DamageModifiers.

Specified by:

baseDamage in interface DamageEntityEvent

Returns:

The base damage

setBaseDamage

public final void setBaseDamage(double baseDamage)

Description copied from interface: DamageEntityEvent

Sets the "base" damage to deal to the targeted Entity. The "base" damage is the original value before passing along the chain of DamageFunctions for all known DamageModifiers.

Specified by:

setBaseDamage in interface DamageEntityEvent

Parameters:

baseDamage - The base damage

willCauseDeath

public boolean willCauseDeath()

Description copied from interface: DamageEntityEvent

Returns whether or not this event will cause the entity to die if the event is not cancelled. Only supported for living entities, returns false if DamageEntityEvent.entity() is not a living entity.

Specified by:

willCauseDeath in interface DamageEntityEvent

Returns:

Whether the entity will die