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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Effect.EffectAppliedListener
static interface	Effect.EffectCeasedListener

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)
protected boolean	customTarget(ICombatEntity entity) Overwrite this method to implement a custom target predicate that determines whether an entity can be affected by this effect.
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()
RelativeEntityComparator	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(Effect.EffectAppliedListener listener)
void	onEffectCeased(Effect.EffectCeasedListener listener)
void	removeEffectAppliedListener(Effect.EffectAppliedListener listener)
void	removeEffectCeasedListener(Effect.EffectCeasedListener listener)
void	setDelay(int delay)
void	setDuration(int duration)
void	setTargetPriorityComparator(RelativeEntityComparator targetPriorityComparator)
void	update() 1.

Methods inherited from class java.lang.Object

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

Constructor Detail

Effect

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

Instantiates a new effect.

Parameters:

ability - the ability

targets - the targets

Method Detail

onEffectApplied

public void onEffectApplied(Effect.EffectAppliedListener listener)

removeEffectAppliedListener

public void removeEffectAppliedListener(Effect.EffectAppliedListener listener)

onEffectCeased

public void onEffectCeased(Effect.EffectCeasedListener listener)

removeEffectCeasedListener

public void removeEffectCeasedListener(Effect.EffectCeasedListener listener)

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 RelativeEntityComparator getTargetPriorityComparator()

isActive

public boolean isActive(ICombatEntity entity)

setDelay

public void setDelay(int delay)

setDuration

public void setDuration(int duration)

setTargetPriorityComparator

public void setTargetPriorityComparator(RelativeEntityComparator 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

See Also:

ClientConfiguration.setMaxFps(int)

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)

customTarget

protected boolean customTarget(ICombatEntity entity)

Overwrite this method to implement a custom target predicate that determines whether an entity can be affected by this effect. The targets of this effect need to include the CUSTOM value in order for this function to be evaluated.

Parameters:

entity - The entity to check against the custom target predicate.

Returns:

True if the entity can be affected by this effect; otherwise false.

See Also:

EffectTarget.CUSTOM