com.almasb.fxgl.ecs

Class AbstractControl

java.lang.Object

com.almasb.fxgl.ecs.AbstractControl

All Implemented Interfaces:

Control

Direct Known Subclasses:

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

public abstract class AbstractControl
extends Object
implements Control

Base class for controls.

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractControl()

Method Summary

Modifier and Type	Method and Description
Entity	getEntity()
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	pause() Pauses execution of this control.
void	resume() Resumes execution of this control.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.almasb.fxgl.ecs.Control

onUpdate

Constructor Detail

AbstractControl

public AbstractControl()

Method Detail

getEntity

public Entity getEntity()

Returns:

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

onAdded

public void onAdded(Entity entity)

Description copied from interface: Control

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.

Specified by:

onAdded in interface Control

Parameters:

entity - the entity to which this control was added

onRemoved

public void onRemoved(Entity entity)

Description copied from interface: Control

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.

Specified by:

onRemoved in interface Control

Parameters:

entity - the entity from which the control was removed

isPaused

public final boolean isPaused()

Specified by:

isPaused in interface Control

Returns:

if execution of this control is paused

pause

public final void pause()

Description copied from interface: Control

Pauses execution of this control.

Specified by:

pause in interface Control

resume

public final void resume()

Description copied from interface: Control

Resumes execution of this control.

Specified by:

resume in interface Control