Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

GPUParticles2D

Inherits: Node2D < CanvasItem < Node < Object

A 2D particle emitter.

Description

2D particle node used to create a variety of particle systems and effects. GPUParticles2D features an emitter that generates some number of particles at a given rate.

Use the process_material property to add a ParticleProcessMaterial to configure particle appearance and behavior. Alternatively, you can add a ShaderMaterial which will be applied to all particles.

2D particles can optionally collide with LightOccluder2D, but they don't collide with PhysicsBody2D nodes.

Tutorials

• Particle systems (2D)

• 2D Particles Demo

• 2D Dodge The Creeps Demo (uses GPUParticles2D for the trail behind the player)

Properties

int	amount	8
float	collision_base_size	1.0
DrawOrder	draw_order	1
bool	emitting	true
float	explosiveness	0.0
int	fixed_fps	30
bool	fract_delta	true
bool	interpolate	true
float	lifetime	1.0
bool	local_coords	false
bool	one_shot	false
float	preprocess	0.0
Material	process_material
float	randomness	0.0
float	speed_scale	1.0
NodePath	sub_emitter	NodePath("")
Texture2D	texture
bool	trail_enabled	false
float	trail_lifetime	0.3
int	trail_section_subdivisions	4
int	trail_sections	8
Rect2	visibility_rect	Rect2(-100, -100, 200, 200)

Methods

Rect2	capture_rect ( ) const
void	convert_from_particles ( Node particles )
void	emit_particle ( Transform2D xform, Vector2 velocity, Color color, Color custom, int flags )
void	restart ( )

---

Signals

finished ( )

Emitted when all active particles have finished processing. When one_shot is disabled, particles will process continuously, so this is never emitted.

Note: Due to the particles being computed on the GPU there might be a delay before the signal gets emitted.

---

Enumerations

enum DrawOrder:

DrawOrder DRAW_ORDER_INDEX = 0

Particles are drawn in the order emitted.

DrawOrder DRAW_ORDER_LIFETIME = 1

Particles are drawn in order of remaining lifetime.

DrawOrder DRAW_ORDER_REVERSE_LIFETIME = 2

---

enum EmitFlags: