com.almasb.fxgl.entity.control

Class ExpireCleanControl

java.lang.Object

com.almasb.fxgl.ecs.Module

com.almasb.fxgl.ecs.Control

com.almasb.fxgl.entity.control.ExpireCleanControl

public class ExpireCleanControl
extends Control

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
ExpireCleanControl	animateOpacity() Enables diminishing opacity over time.
void	onAdded(Entity entity)
void	onUpdate(Entity entity, double tpf)

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

isPaused, pause, resume

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

getEntity, onRemoved

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)

Overrides:

onAdded in class Module

onUpdate

public void onUpdate(Entity entity,
                     double tpf)

Specified by:

onUpdate in class Control

animateOpacity

public ExpireCleanControl animateOpacity()

Enables diminishing opacity over time.

Returns:

this control