com.almasb.fxgl.ecs.action

Class Action<T extends Entity>

java.lang.Object

com.almasb.fxgl.ecs.action.Action<T>

public abstract class Action<T extends Entity>
extends Object

A single entity action. Unlike a Control the action is finished after its execution, a control is active during the entity lifetime (or until removed).

Author:

Almas Baimagambetov (almaslvl@gmail.com)

Constructor Summary

Constructors

Constructor and Description
Action()

Method Summary

Modifier and Type	Method and Description
T	getEntity()
abstract boolean	isComplete()
protected void	onAdded(T entity)
protected void	onRemoved(T entity)
protected abstract void	onUpdate(T entity, double tpf) Called on entity world update tick.

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

public Action()

Method Detail

getEntity

public final T getEntity()

Returns:

entity to which the action is attached, or null if action is not attached

onAdded

protected void onAdded(T entity)

onRemoved

protected void onRemoved(T entity)

isComplete

public abstract boolean isComplete()

Returns:

true if this action is complete and does not require further execution

onUpdate

protected abstract void onUpdate(T entity,
                                 double tpf)

Called on entity world update tick.

Parameters:

entity - the entity to which this action is attached

tpf - time per frame