de.gurkenlabs.litiengine.abilities

Class Ability

java.lang.Object

de.gurkenlabs.litiengine.abilities.Ability

All Implemented Interfaces:

IRenderable

public abstract class Ability
extends java.lang.Object
implements IRenderable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Ability.AbilityCastListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Ability(Creature executor) Instantiates a new ability.

Method Summary

Modifier and Type	Method and Description
void	addEffect(Effect effect)
java.awt.Shape	calculateImpactArea()
java.awt.geom.Ellipse2D	calculatePotentialImpactArea()
boolean	canCast()
AbilityExecution	cast() Casts the ability by the temporal conditions of the specified game loop and the spatial circumstances of the specified environment.
AbilityAttributes	getAttributes()
CastType	getCastType()
float	getCooldownInSeconds()
AbilityExecution	getCurrentExecution()
java.lang.String	getDescription()
protected java.util.List<Effect>	getEffects()
Creature	getExecutor()
java.lang.String	getName()
java.awt.geom.Point2D	getOrigin()
AbilityOrigin	getOriginType()
float	getRemainingCooldownInSeconds()
protected java.awt.Shape	internalCalculateImpactArea(double angle)
boolean	isActive()
boolean	isMultiTarget()
void	onCast(Ability.AbilityCastListener listener)
void	onEffectApplied(Effect.EffectAppliedListener listener)
void	onEffectCeased(Effect.EffectCeasedListener listener)
void	removeAbilityCastListener(Ability.AbilityCastListener listener)
void	render(java.awt.Graphics2D g) Renders the visual contents of this instance onto the provided graphics context.
void	setCastType(CastType castType)
protected void	setCurrentExecution(AbilityExecution ae)
void	setDescription(java.lang.String description)
void	setMultiTarget(boolean multiTarget)
void	setName(java.lang.String name)
void	setOrigin(java.awt.geom.Point2D origin) Sets a custom offset from the executors map location as origin of this ability.
void	setOriginType(AbilityOrigin originType)

Methods inherited from class java.lang.Object

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

Constructor Detail

Ability

protected Ability(Creature executor)

Instantiates a new ability.

Parameters:

executor - the executing entity

Method Detail

onCast

public void onCast(Ability.AbilityCastListener listener)

removeAbilityCastListener

public void removeAbilityCastListener(Ability.AbilityCastListener listener)

onEffectApplied

public void onEffectApplied(Effect.EffectAppliedListener listener)

onEffectCeased

public void onEffectCeased(Effect.EffectCeasedListener listener)

addEffect

public void addEffect(Effect effect)

calculateImpactArea

public java.awt.Shape calculateImpactArea()

calculatePotentialImpactArea

public java.awt.geom.Ellipse2D calculatePotentialImpactArea()

canCast

public boolean canCast()

cast

public AbilityExecution cast()

Casts the ability by the temporal conditions of the specified game loop and the spatial circumstances of the specified environment. An ability execution will be taken out that start applying all the effects of this ability.

Returns:

An AbilityExecution object that wraps all information about this execution of the ability.

getAttributes

public AbilityAttributes getAttributes()

getCastType

public CastType getCastType()

getCooldownInSeconds

public float getCooldownInSeconds()

getCurrentExecution

public AbilityExecution getCurrentExecution()

getDescription

public java.lang.String getDescription()

getExecutor

public Creature getExecutor()

getName

public java.lang.String getName()

getOriginType

public AbilityOrigin getOriginType()

getOrigin

public java.awt.geom.Point2D getOrigin()

getRemainingCooldownInSeconds

public float getRemainingCooldownInSeconds()

isActive

public boolean isActive()

isMultiTarget

public boolean isMultiTarget()

render

public void render(java.awt.Graphics2D g)

Description copied from interface: IRenderable

Renders the visual contents of this instance onto the provided graphics context.

If an Entity implements this interface, this method will be called right after the entity was rendered from the environment. Allowing for a custom rendering mechanism.

This interface can be implemented in general by anything that should be rendered to the game's screen.

Specified by:

render in interface IRenderable

Parameters:

g - The current graphics object onto which this instance will render its visual contents.

See Also:

RenderEngine.renderEntity(Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)

setOrigin

public void setOrigin(java.awt.geom.Point2D origin)

Sets a custom offset from the executors map location as origin of this ability.

Parameters:

origin - The origin that defines the execution offset for this Ability.

setOriginType

public void setOriginType(AbilityOrigin originType)

setName

public void setName(java.lang.String name)

setDescription

public void setDescription(java.lang.String description)

setMultiTarget

public void setMultiTarget(boolean multiTarget)

setCastType

public void setCastType(CastType castType)

setCurrentExecution

protected void setCurrentExecution(AbilityExecution ae)

getEffects

protected java.util.List<Effect> getEffects()

internalCalculateImpactArea

protected java.awt.Shape internalCalculateImpactArea(double angle)