Class EntityEmitter

java.lang.Object

de.gurkenlabs.litiengine.entities.Entity

de.gurkenlabs.litiengine.graphics.emitters.Emitter

de.gurkenlabs.litiengine.graphics.emitters.EntityEmitter

All Implemented Interfaces:

EntityRenderedListener, EntityRenderListener, IEntity, IRenderable, ITimeToLive, IUpdateable, Tweenable, EventListener

public class EntityEmitter
extends Emitter

A standard implementation for emitters that are bound to IEntity.getLocation().

See Also:

• IEntity.getLocation()

Nested Class Summary

Nested classes/interfaces inherited from class de.gurkenlabs.litiengine.graphics.emitters.Emitter

Emitter.EmitterFinishedListener

Field Summary

Fields inherited from class de.gurkenlabs.litiengine.entities.Entity

ANY_MESSAGE

Constructor Summary

Constructors

Constructor	Description
EntityEmitter(IEntity entity)	Instantiates a new entity emitter that remains at the location where it has been created.
EntityEmitter(IEntity entity, boolean dynamicLocation)	Instantiates a new entity emitter.
EntityEmitter(IEntity entity, EmitterData emitterData)	Constructs a new EntityEmitter with EmitterData that remains at the location where it has been created.
EntityEmitter(IEntity entity, EmitterData emitterData, boolean dynamicLocation)	Constructs a new EntityEmitter with EmitterData that follows an entity's location.
EntityEmitter(IEntity entity, String emitterResourceName)	Constructs a new EntityEmitter from a given emitter resource that remains at the location where it has been created.
EntityEmitter(IEntity entity, String emitterResourceName, boolean dynamicLocation)	Constructs a new EntityEmitter from a given emitter resource that follows an entity's location.

Method Summary

Modifier and Type	Method	Description
IEntity	getEntity()	Get the IEntity to which this emitter is bound.
double	getHeight()	Gets the height of the entity.
Point2D	getLocation()	Gets the location of the entity.
double	getWidth()	Gets the width of the entity.
double	getX()	Gets the X coordinate of the entity.
double	getY()	Gets the Y coordinate of the entity.
boolean	hasDynamicLocation()	Check if the emitter has dynamic location tracking enabled.
void	setDynamicLocation(boolean dynamicLocation)	Toggle dynamic location updates.

Methods inherited from class de.gurkenlabs.litiengine.graphics.emitters.Emitter

activate, addParticle, canTakeNewParticles, createNewParticle, data, deactivate, delete, getAliveTime, getOrigin, getParticles, getRenderable, getTimeToLive, isActivated, isActivateOnInit, isFinished, isPaused, isStopped, onFinished, particleCanBeRemoved, removeFinishedListener, render, setEmitterData, setEmitterData, setPaused, setStopped, spawnParticle, timeToLiveReached, togglePaused, toggleStopped, update, updateOrigin

Methods inherited from class de.gurkenlabs.litiengine.entities.Entity

actions, addController, addEntityRenderListener, addListener, addTag, addTransformListener, animations, attachControllers, behavior, canRender, detachControllers, getAngle, getBoundingBox, getCenter, getController, getControllers, getEnvironment, getMapId, getName, getProperties, getRenderType, getTags, getTweenValues, hasTag, isLoaded, isVisible, loaded, onMessage, onMessage, onRendered, perform, register, removed, removeListener, removeListener, removeListener, removeListener, removeListener, removeTag, rendered, rendering, renderWithLayer, sendMessage, setAngle, setController, setHeight, setLocation, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setSize, setTweenValues, setVisible, setWidth, setX, setY, toString

Methods inherited from class java.lang.Object

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

Constructor Details

EntityEmitter

public EntityEmitter(IEntity entity,
 String emitterResourceName,
 boolean dynamicLocation)

Constructs a new EntityEmitter from a given emitter resource that follows an entity's location.

Parameters:

entity - The IEntity to which this emitter is bound.

emitterResourceName - The name of the configuration for this emitter. If the Emitter has been added to the game resource file, it is loaded from there by name. Otherwise, the EmitterLoader will search the Resource folders for a file with the emitterResourceName.

dynamicLocation - If true, the emitter follows the entity's location; if false, it remains at the location where it has been created.

EntityEmitter

public EntityEmitter(IEntity entity,
 String emitterResourceName)

Constructs a new EntityEmitter from a given emitter resource that remains at the location where it has been created.

Parameters:

entity - The IEntity to which this emitter is bound.

emitterResourceName - The name of the configuration for this emitter. If the Emitter has been added to the game resource file, it is loaded from there by name. Otherwise, the EmitterLoader will search the Resource folders for a file with the emitterResourceName.

EntityEmitter

public EntityEmitter(IEntity entity,
 EmitterData emitterData,
 boolean dynamicLocation)

Constructs a new EntityEmitter with EmitterData that follows an entity's location.

Parameters:

entity - The IEntity to which this emitter is bound.

emitterData - The EmitterData object defining the emitter's behavior.

dynamicLocation - If true, the emitter follows the entity's location; if false, it remains at the location where it has been created.

EntityEmitter

public EntityEmitter(IEntity entity,
 EmitterData emitterData)

Constructs a new EntityEmitter with EmitterData that remains at the location where it has been created.

Parameters:

entity - The IEntity to which this emitter is bound.

emitterData - The EmitterData object defining the emitter's behavior.

EntityEmitter

public EntityEmitter(IEntity entity)

Instantiates a new entity emitter that remains at the location where it has been created.

Parameters:

entity - The IEntity to which this emitter is bound.

EntityEmitter

public EntityEmitter(IEntity entity,
 boolean dynamicLocation)

Instantiates a new entity emitter.

Parameters:

entity - The IEntity to which this emitter is bound.

dynamicLocation - If true, the emitter follows the entity's location; if false, it remains at the location where it has been created.

Method Details

getEntity

public IEntity getEntity()

Get the IEntity to which this emitter is bound.

Returns:

The IEntity to which this emitter is bound.

hasDynamicLocation

public boolean hasDynamicLocation()

Check if the emitter has dynamic location tracking enabled. This determines whether this Emitter's location is updated along its entity's location.

Returns:

True if dynamic location is enabled, false otherwise.

setDynamicLocation

public void setDynamicLocation(boolean dynamicLocation)

Toggle dynamic location updates.

Parameters:

dynamicLocation - If true, the emitter follows its entity's location; if false, it remains at the location where it has been created.

getWidth

public double getWidth()

Description copied from interface: IEntity

Gets the width of the entity.

Specified by:

getWidth in interface IEntity

Overrides:

getWidth in class Entity

Returns:

The width of the entity.

getHeight

public double getHeight()

Description copied from interface: IEntity

Gets the height of the entity.

Specified by:

getHeight in interface IEntity

Overrides:

getHeight in class Entity

Returns:

The height of the entity.

getX

public double getX()

Description copied from interface: IEntity

Gets the X coordinate of the entity.

Specified by:

getX in interface IEntity

Overrides:

getX in class Entity

Returns:

The X coordinate of the entity.

getY

public double getY()

Description copied from interface: IEntity

Gets the Y coordinate of the entity.

Specified by:

getY in interface IEntity

Overrides:

getY in class Entity

Returns:

The Y coordinate of the entity.

getLocation

public Point2D getLocation()

Description copied from interface: IEntity

Gets the location of the entity.

Specified by:

getLocation in interface IEntity

Overrides:

getLocation in class Entity

Returns:

The location of the entity.