de.gurkenlabs.litiengine.abilities.effects

Class Effect

java.lang.Object

de.gurkenlabs.litiengine.abilities.effects.Effect

All Implemented Interfaces:

IUpdateable

Direct Known Subclasses:

AttributeEffect, ForceEffect, SoundEffect

public abstract class Effect
extends java.lang.Object
implements IUpdateable

The Class Effect seeks for affected entities in the game's current environment to apply certain effects to them defined by the overwritten implementation of apply/cease.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_DURATION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Effect(Ability ability, EffectTarget... targets) Instantiates a new effect.

Method Summary

Modifier and Type	Method and Description
protected void	apply(ICombatEntity entity)
void	apply(java.awt.Shape impactArea) Applies the effect in the specified impact area on the specified environment.
protected void	cease(EffectApplication appliance)
void	cease(ICombatEntity entity)
Ability	getAbility()
java.util.List<EffectApplication>	getActiveAppliances()
int	getDelay()
int	getDuration()
EffectTarget[]	getEffectTargets()
protected java.util.Collection<ICombatEntity>	getEntitiesInImpactArea(java.awt.Shape impactArea)
java.util.List<Effect>	getFollowUpEffects()
EntityComparator	getTargetPriorityComparator()
protected long	getTotalDuration()
protected boolean	hasEnded(EffectApplication appliance)
boolean	isActive(ICombatEntity entity)
protected java.util.List<ICombatEntity>	lookForAffectedEntities(java.awt.Shape impactArea)
void	onEffectApplied(java.util.function.Consumer<EffectArgument> consumer)
void	onEffectCeased(java.util.function.Consumer<EffectArgument> consumer)
void	setDelay(int delay)
void	setDuration(int duration)
void	setTargetPriorityComparator(EntityComparator targetPriorityComparator)
void	update() 1.

Methods inherited from class java.lang.Object

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

Field Detail

NO_DURATION

public static final int NO_DURATION

See Also:

Constant Field Values

Constructor Detail

Effect

protected Effect(Ability ability,
                 EffectTarget... targets)

Instantiates a new effect.

Parameters:

ability - the ability

targets - the targets

Method Detail

apply

public void apply(java.awt.Shape impactArea)

Applies the effect in the specified impact area on the specified environment.

Parameters:

impactArea - The impact area

cease

public void cease(ICombatEntity entity)

getAbility

public Ability getAbility()

getActiveAppliances

public java.util.List<EffectApplication> getActiveAppliances()

getDelay

public int getDelay()

getDuration

public int getDuration()

getEffectTargets

public EffectTarget[] getEffectTargets()

getFollowUpEffects

public java.util.List<Effect> getFollowUpEffects()

getTargetPriorityComparator

public EntityComparator getTargetPriorityComparator()

isActive

public boolean isActive(ICombatEntity entity)

onEffectApplied

public void onEffectApplied(java.util.function.Consumer<EffectArgument> consumer)

onEffectCeased

public void onEffectCeased(java.util.function.Consumer<EffectArgument> consumer)

setDelay

public void setDelay(int delay)

setDuration

public void setDuration(int duration)

setTargetPriorityComparator

public void setTargetPriorityComparator(EntityComparator targetPriorityComparator)

update

public void update()

1. Cease the effect after its duration. 2. apply all follow up effects 3. remove appliance 4. unregister from loop if all appliances are done

Specified by:

update in interface IUpdateable

apply

protected void apply(ICombatEntity entity)

cease

protected void cease(EffectApplication appliance)

getEntitiesInImpactArea

protected java.util.Collection<ICombatEntity> getEntitiesInImpactArea(java.awt.Shape impactArea)

getTotalDuration

protected long getTotalDuration()

hasEnded

protected boolean hasEnded(EffectApplication appliance)

lookForAffectedEntities

protected java.util.List<ICombatEntity> lookForAffectedEntities(java.awt.Shape impactArea)