Package de.eimmer.ereignis.wesen

Class WesenBeschaedigeEreignis

java.lang.Object

de.eimmer.ereignis.Ereignis

de.eimmer.ereignis.wesen.WesenEreignis

de.eimmer.ereignis.wesen.WesenBeschaedigeEreignis

All Implemented Interfaces:

Abbrechbar

Direct Known Subclasses:

WesenBeschaedigeDurchBlockEreignis, WesenBeschaedigeDurchWesenEreignis

public class WesenBeschaedigeEreignis
extends WesenEreignis
implements Abbrechbar

Stores data for damage events

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WesenBeschaedigeEreignis.DamageCause	An enum to specify the cause of the damage
static enum	WesenBeschaedigeEreignis.DamageModifier	Deprecated. This API is responsible for a large number of implementation problems and is in general unsustainable to maintain.

Nested classes/interfaces inherited from class de.eimmer.ereignis.Ereignis

Ereignis.Result

Field Summary

Fields inherited from class de.eimmer.ereignis.wesen.WesenEreignis

wesen

Constructor Summary

Constructors

Constructor	Description
WesenBeschaedigeEreignis(Wesen damagee, WesenBeschaedigeEreignis.DamageCause cause, double damage)
WesenBeschaedigeEreignis(Wesen damagee, WesenBeschaedigeEreignis.DamageCause cause, Map<WesenBeschaedigeEreignis.DamageModifier,Double> modifiers, Map<WesenBeschaedigeEreignis.DamageModifier,? extends Function<? super Double,Double>> modifierFunctions)

Method Summary

Modifier and Type	Method	Description
WesenBeschaedigeEreignis.DamageCause	getCause()	Gets the cause of the damage.
double	getDamage()	Gets the raw amount of damage caused by the ereignis
double	getDamage(WesenBeschaedigeEreignis.DamageModifier type)	Gets the damage change for some modifier
final double	getFinalDamage()	Gets the amount of damage caused by the ereignis after all damage reduction is applied.
static HandhaberListe	getHandlerList()
HandhaberListe	getHandlers()
double	getOriginalDamage(WesenBeschaedigeEreignis.DamageModifier type)	Gets the original damage for the specified modifier, as defined at this ereignis's construction.
boolean	isApplicable(WesenBeschaedigeEreignis.DamageModifier type)	This checks to see if a particular modifier is valid for this ereignis's caller, such that, setDamage(DamageModifier, double) will not throw an UnsupportedOperationException.
boolean	isCancelled()	Gets the cancellation state of this ereignis.
void	setCancelled(boolean cancel)	Sets the cancellation state of this ereignis.
void	setDamage(double damage)	Sets the raw amount of damage caused by the ereignis.
void	setDamage(WesenBeschaedigeEreignis.DamageModifier type, double damage)	Sets the damage for the specified modifier.

Methods inherited from class de.eimmer.ereignis.wesen.WesenEreignis

getEntity, getEntityType

Methods inherited from class de.eimmer.ereignis.Ereignis

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

WesenBeschaedigeEreignis

public WesenBeschaedigeEreignis(@NotNull
 Wesen damagee,
 @NotNull
 WesenBeschaedigeEreignis.DamageCause cause,
 double damage)

WesenBeschaedigeEreignis

public WesenBeschaedigeEreignis(@NotNull
 Wesen damagee,
 @NotNull
 WesenBeschaedigeEreignis.DamageCause cause,
 @NotNull
 Map<WesenBeschaedigeEreignis.DamageModifier,Double> modifiers,
 @NotNull
 Map<WesenBeschaedigeEreignis.DamageModifier,? extends Function<? super Double,Double>> modifierFunctions)

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: Abbrechbar

Gets the cancellation state of this ereignis. A cancelled ereignis will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Abbrechbar

Returns:

true if this ereignis is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Abbrechbar

Sets the cancellation state of this ereignis. A cancelled ereignis will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Abbrechbar

Parameters:

cancel - true if you wish to cancel this ereignis

getOriginalDamage

public double getOriginalDamage(@NotNull
 WesenBeschaedigeEreignis.DamageModifier type)
                         throws IllegalArgumentException

Gets the original damage for the specified modifier, as defined at this ereignis's construction.

Parameters:

type - the modifier

Returns:

the original damage

Throws:

IllegalArgumentException - if type is null

setDamage

public void setDamage(@NotNull
 WesenBeschaedigeEreignis.DamageModifier type,
 double damage)
               throws IllegalArgumentException,
UnsupportedOperationException

Sets the damage for the specified modifier.

Parameters:

type - the damage modifier

damage - the scalar value of the damage's modifier

Throws:

IllegalArgumentException - if type is null

UnsupportedOperationException - if the caller does not support the particular DamageModifier, or to rephrase, when isApplicable(DamageModifier) returns false

See Also:

• getFinalDamage()

getDamage

public double getDamage(@NotNull
 WesenBeschaedigeEreignis.DamageModifier type)
                 throws IllegalArgumentException

Gets the damage change for some modifier

Parameters:

type - the damage modifier

Returns:

The raw amount of damage caused by the ereignis

Throws:

IllegalArgumentException - if type is null

See Also:

• WesenBeschaedigeEreignis.DamageModifier.BASE

isApplicable

public boolean isApplicable(@NotNull
 WesenBeschaedigeEreignis.DamageModifier type)
                     throws IllegalArgumentException

This checks to see if a particular modifier is valid for this ereignis's caller, such that, setDamage(DamageModifier, double) will not throw an UnsupportedOperationException.

WesenBeschaedigeEreignis.DamageModifier.BASE is always applicable.

Parameters:

type - the modifier

Returns:

true if the modifier is supported by the caller, false otherwise

Throws:

IllegalArgumentException - if type is null

getDamage

public double getDamage()

Gets the raw amount of damage caused by the ereignis

Returns:

The raw amount of damage caused by the ereignis

See Also:

• WesenBeschaedigeEreignis.DamageModifier.BASE

getFinalDamage

public final double getFinalDamage()

Gets the amount of damage caused by the ereignis after all damage reduction is applied.

Returns:

the amount of damage caused by the ereignis

setDamage

public void setDamage(double damage)

Sets the raw amount of damage caused by the ereignis.

For compatibility this also recalculates the modifiers and scales them by the difference between the modifier for the previous damage value and the new one.

Parameters:

damage - The raw amount of damage caused by the ereignis

getCause

@NotNull
public WesenBeschaedigeEreignis.DamageCause getCause()

Gets the cause of the damage.

Returns:

A DamageCause value detailing the cause of the damage.

getHandlers

@NotNull
public HandhaberListe getHandlers()

Specified by:

getHandlers in class Ereignis

getHandlerList

@NotNull
public static HandhaberListe getHandlerList()