de.verygame.surface.util.modifier.base

Class AbstractModifier

java.lang.Object

de.verygame.surface.util.modifier.base.AbstractModifier

All Implemented Interfaces:

Modifier

Direct Known Subclasses:

SingleValueModifier

public abstract class AbstractModifier
extends java.lang.Object
implements Modifier

Base class for a modifier.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	currentDuration remaining duration
protected float	duration estimated duration
protected boolean	finished true if currentDuration leq 0
protected java.util.List<FinishListener>	finishListenerList list of FinishListener
protected ModifierCallback	target target which the modifier will affect

Constructor Summary

Constructors

Constructor and Description
AbstractModifier(ModifierCallback target, float duration) Constructs an EntityModifier using given target and duration.

Method Summary

Modifier and Type	Method and Description
void	addFinishListener(FinishListener finishListener) You can add a FinishListener which will be called in Modifier.onFinish().
boolean	hasFinished() Returns whether the modifier has finished
void	kill() Forces the modifier to stop
void	onFinish() Describes what happens on finish (last tick)
void	reset() Resets the modifier
void	update() Updates the modifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.verygame.surface.util.modifier.base.Modifier

onInit, tick

Field Detail

duration

protected final float duration

estimated duration

currentDuration

protected float currentDuration

remaining duration

target

protected final ModifierCallback target

target which the modifier will affect

finished

protected boolean finished

true if currentDuration leq 0

finishListenerList

protected java.util.List<FinishListener> finishListenerList

list of FinishListener

Constructor Detail

AbstractModifier

public AbstractModifier(ModifierCallback target,
                        float duration)

Constructs an EntityModifier using given target and duration.

Parameters:

target - target

duration - estimated duration

Method Detail

update

public void update()

Description copied from interface: Modifier

Updates the modifier

Specified by:

update in interface Modifier

addFinishListener

public void addFinishListener(FinishListener finishListener)

Description copied from interface: Modifier

You can add a FinishListener which will be called in Modifier.onFinish().

Specified by:

addFinishListener in interface Modifier

Parameters:

finishListener - FinishListener

hasFinished

public boolean hasFinished()

Description copied from interface: Modifier

Returns whether the modifier has finished

Specified by:

hasFinished in interface Modifier

onFinish

public void onFinish()

Description copied from interface: Modifier

Describes what happens on finish (last tick)

Specified by:

onFinish in interface Modifier

kill

public void kill()

Description copied from interface: Modifier

Forces the modifier to stop

Specified by:

kill in interface Modifier

reset

public void reset()

Description copied from interface: Modifier

Resets the modifier

Specified by:

reset in interface Modifier