com.almasb.fxgl.ecs

Interface Control

All Known Implementing Classes:

AbstractControl, ActionControl, CircularMovementControl, ExpireCleanControl, JSControl, KeepOnScreenControl, LiftControl, OffscreenCleanControl, ParticleControl, PhysicsControl, ProjectileControl

public interface Control

Defines behavior of an entity. Unlike the "System" in the ECS model, control is attached directly to an entity and is stateful (i.e. it knows about entity to which it is attached).

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Method Summary

Modifier and Type	Method and Description
boolean	isPaused()
void	onAdded(Entity entity) Called when this control is added to entity.
void	onRemoved(Entity entity) Called when this control is removed from entity.
void	onUpdate(Entity entity, double tpf) Called on entity world update tick.
void	pause() Pauses execution of this control.
void	resume() Resumes execution of this control.

Method Detail

onAdded

void onAdded(Entity entity)

Called when this control is added to entity. This is called before any control related listeners are notified. This allows the control to initiliaze properly.

Parameters:

entity - the entity to which this control was added

onUpdate

void onUpdate(Entity entity,
              double tpf)

Called on entity world update tick.

Parameters:

entity - the entity to which this control is attached

tpf - time per frame

onRemoved

void onRemoved(Entity entity)

Called when this control is removed from entity. This is called after any control related listeners are notified. This allows the control to clean up properly.

Parameters:

entity - the entity from which the control was removed

isPaused

boolean isPaused()

Returns:

if execution of this control is paused

pause

void pause()

Pauses execution of this control.

resume

void resume()

Resumes execution of this control.