libgdx-particles

libGDX Particle Effects

Quick reference for libGDX particle systems. Covers 2D ParticleEffect/ParticleEmitter/ParticleEffectPool, AssetManager loading, blend function management, and the 3D particle system (g3d.particles).

2D ParticleEffect

com.badlogic.gdx.graphics.g2d.ParticleEffect implements Disposable.

Loading

ParticleEffect effect = new ParticleEffect();

// From loose image files (images directory):
effect.load(Gdx.files.internal("explosion.p"), Gdx.files.internal("particles"));
//          ^ effect file                       ^ directory containing particle images

// From TextureAtlas:
effect.load(Gdx.files.internal("explosion.p"), myAtlas);

// From TextureAtlas with prefix:
effect.load(Gdx.files.internal("explosion.p"), myAtlas, "fx_");

The second parameter to load(FileHandle, FileHandle) is the images directory, NOT the effect file's parent. A common mistake is passing "" — use Gdx.files.internal("") for project root.

File format is .p (plain text), created by the Particle Editor tool.

Core Lifecycle

effect.start();                      // starts all emitters
effect.setPosition(x, y);           // set position on all emitters

// In render():
effect.update(Gdx.graphics.getDeltaTime());
effect.draw(batch);                  // param type is Batch (interface), not SpriteBatch

// Or combined:
effect.draw(batch, delta);           // calls update(delta) then draw(batch)

if (effect.isComplete()) { ... }     // true when ALL emitters are complete

effect.reset();                      // kills particles, resets scaling, restarts
effect.dispose();                    // only frees textures if loaded from directory (not atlas)

Key Methods

Method	Signature	Notes
start()	void	Starts all emitters. Does NOT kill existing particles.
reset()	void	Kills all particles, resets scale to 1.0, restarts all emitters.
reset(boolean)	void reset(resetScaling)	If false, preserves current scale.
reset(boolean, boolean)	void reset(resetScaling, start)	Full control: reset scale + auto-start.
update(float)	void update(delta)	Must call every frame or particles freeze.
draw(Batch)	void draw(batch)	Draws all emitters.
draw(Batch, float)	void draw(batch, delta)	Combined update + draw.
isComplete()	boolean	True when ALL emitters are complete.
allowCompletion()	void	Tells all continuous emitters to finish gracefully.
setPosition(float, float)	void setPosition(x, y)	Sets on all emitters. Call every frame if following entity.
setFlip(boolean, boolean)	void setFlip(flipX, flipY)	Flips all emitters.
flipY()	void	Convenience for vertical flip.
setDuration(int)	void setDuration(millis)	Sets duration in milliseconds on ALL emitters. Forces continuous=false.
getEmitters()	Array<ParticleEmitter>	Direct access to emitter array.
findEmitter(String)	ParticleEmitter	Returns first emitter with matching name, or null.
preAllocateParticles()	void	Pre-allocates particle arrays in all emitters.
getBoundingBox()	BoundingBox	Enclosing box for all emitters.