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

Class AbstractAttackEntityEvent

java.lang.Object

org.spongepowered.api.event.impl.AbstractEvent

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

org.spongepowered.api.event.impl.entity.AbstractAttackEntityEvent

All Implemented Interfaces:

Cancellable, AttackEntityEvent, Event

public abstract class AbstractAttackEntityEvent
extends AbstractModifierEvent<DamageFunction,DamageModifier>
implements AttackEntityEvent

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

Fields inherited from interface org.spongepowered.api.event.entity.AttackEntityEvent

ABSORPTION, BOOTS, CHESTPLATE, CREATOR, GENERAL_ARMOR, HARD_HAT_ARMOR, HELMET, LEGGINGS, NOTIFIER, RESISTANCE, SHIELD, SOURCE

Constructor Summary

Constructors

Constructor	Description
AbstractAttackEntityEvent()

Method Summary

Modifier and Type	Method	Description
void	addDamageModifierAfter(DamageModifier damageModifier, DoubleUnaryOperator function, Set<DamageModifierType> after)	Adds the provided DamageModifier and Function 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.
void	addDamageModifierBefore(DamageModifier damageModifier, DoubleUnaryOperator function, Set<DamageModifierType> before)	Adds the provided DamageModifier and Function to the list of modifiers, such that the Set containing DamageModifierTypes provided in before will appear after the provided damage modifier.
double	baseOutputDamage()	Gets the "base" damage to deal to the targeted Entity.
protected DamageFunction	convertTuple(DamageModifier obj, DoubleUnaryOperator function)
final double	finalOutputDamage()	Gets the final damage that will be passed into the proceeding AttackEntityEvent.
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 AttackEntityEvent.originalDamage().
final Tuple<Double,Double>	originalModifierDamage(DamageModifier damageModifier)	Gets the original damage for the provided DamageModifier.
final Tuple<Double,Double>	outputDamage(DamageModifier damageModifier)	Gets the damage for the provided DamageModifier.
final void	setBaseOutputDamage(double baseDamage)	Sets the "base" damage to deal to the targeted Entity.
final void	setOutputDamage(DamageModifier damageModifier, DoubleUnaryOperator function)	Sets the provided Function to be used for the given DamageModifier.

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.entity.AttackEntityEvent

entity, knockbackModifier, originalDamage, originalFunctions, setKnockbackModifier

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

isCancelled, setCancelled

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

AbstractAttackEntityEvent

public AbstractAttackEntityEvent()

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: AttackEntityEvent

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

Specified by:

originalModifierDamage in interface AttackEntityEvent

Parameters:

damageModifier - The original damage modifier

Returns:

The original damage change

originalFinalDamage

public final double originalFinalDamage()

Description copied from interface: AttackEntityEvent

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

Specified by:

originalFinalDamage in interface AttackEntityEvent

Returns:

The final amount of damage to originally deal

originalDamages

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

Description copied from interface: AttackEntityEvent

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

Specified by:

originalDamages in interface AttackEntityEvent

Returns:

An immutable map of the original modified damages

finalOutputDamage

public final double finalOutputDamage()

Description copied from interface: AttackEntityEvent

Gets the final damage that will be passed into the proceeding AttackEntityEvent. The final damage is the end result of the AttackEntityEvent.baseOutputDamage() being applied in Function.apply(Object) available from all the Tuples of DamageModifier to Function in AttackEntityEvent.originalFunctions().

Specified by:

finalOutputDamage in interface AttackEntityEvent

Returns:

The final damage to deal

isModifierApplicable

public final boolean isModifierApplicable(DamageModifier damageModifier)

Description copied from interface: AttackEntityEvent

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

Specified by:

isModifierApplicable in interface AttackEntityEvent

Parameters:

damageModifier - The damage modifier to check

Returns:

True if the damage modifier is relevant to this event

outputDamage

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

Description copied from interface: AttackEntityEvent

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

Specified by:

outputDamage in interface AttackEntityEvent

Parameters:

damageModifier - The damage modifier to get the damage for

Returns:

The modifier

setOutputDamage

public final void setOutputDamage(DamageModifier damageModifier,
 DoubleUnaryOperator function)

Description copied from interface: AttackEntityEvent

Sets the provided Function to be used for the given DamageModifier. If the DamageModifier is already included in AttackEntityEvent.modifiers(), the Function 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 Functions to be applied to the AttackEntityEvent.baseOutputDamage().

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

Specified by:

setOutputDamage in interface AttackEntityEvent

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: AttackEntityEvent

Adds the provided DamageModifier and Function 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 AttackEntityEvent

Parameters:

damageModifier - The damage modifier to add

function - The associated function

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

addDamageModifierAfter

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

Description copied from interface: AttackEntityEvent

Adds the provided DamageModifier and Function 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:

addDamageModifierAfter in interface AttackEntityEvent

Parameters:

damageModifier - The damage modifier to add

function - The associated function

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

baseOutputDamage

public double baseOutputDamage()

Description copied from interface: AttackEntityEvent

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

Specified by:

baseOutputDamage in interface AttackEntityEvent

Returns:

The base damage

setBaseOutputDamage

public final void setBaseOutputDamage(double baseDamage)

Description copied from interface: AttackEntityEvent

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

Specified by:

setBaseOutputDamage in interface AttackEntityEvent

Parameters:

baseDamage - The base damage

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 AttackEntityEvent

Overrides:

modifiers in class AbstractModifierEvent<DamageFunction,DamageModifier>

Returns:

The list of modifiers