com.almasb.fxgl.entity.control

Class ExpireCleanControl

java.lang.Object

com.almasb.fxgl.ecs.AbstractControl

com.almasb.fxgl.entity.control.ExpireCleanControl

All Implemented Interfaces:

Control

public class ExpireCleanControl
extends AbstractControl

Removes an entity from the world after a certain duration. Useful for special effects or temporary entities.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ExpireCleanControl(javafx.util.Duration expire) The expire duration timer starts when the entity is attached to the world, so it does not start immediately when this control is created.

Method Summary

Modifier and Type	Method and Description
void	onAdded(Entity entity) Called when this control is added to entity.
void	onUpdate(Entity entity, double tpf) Called on entity world update tick.

Methods inherited from class com.almasb.fxgl.ecs.AbstractControl

getEntity, isPaused, onRemoved, pause, resume

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpireCleanControl

public ExpireCleanControl(javafx.util.Duration expire)

The expire duration timer starts when the entity is attached to the world, so it does not start immediately when this control is created.

Parameters:

expire - the duration after entity is removed from the world

Method Detail

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

Overrides:

onAdded in class AbstractControl

Parameters:

entity - the entity to which this control was added

onUpdate

public void onUpdate(Entity entity,
                     double tpf)

Description copied from interface: Control

Called on entity world update tick.

Parameters:

entity - the entity to which this control is attached

tpf - time per frame