Particles2D

Category: Core

2D particle emitter.

Properties

	capture_rect ( ) const
void	( )

Enumerations

enum DrawOrder:

DRAW_ORDER_INDEX = 0 — Particles are drawn in the order emitted.

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

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

Tutorials

Particle systems (2D)

amount

Setter	set_amount(value)
Getter	get_amount()

Number of particles emitted in one emission cycle.

DrawOrder draw_order

Setter	set_draw_order(value)
Getter	get_draw_order()

Particle draw order. Uses DRAW_ORDER_* values. Default value: .

bool emitting

Setter	set_emitting(value)
Getter	is_emitting()

explosiveness

Setter	set_explosiveness_ratio(value)
Getter	get_explosiveness_ratio()

How rapidly particles in an emission cycle are emitted. If greater than 0, there will be a gap in emissions before the next cycle begins. Default value: .

int fixed_fps

The particle system’s frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself.

fract_delta

Setter	set_fractional_delta(value)
Getter	get_fractional_delta()

If true, results in fractional delta calculation which has a smoother particles display effect. Default value: true

float lifetime

Setter	set_lifetime(value)
Getter	get_lifetime()

Amount of time each particle will exist. Default value: 1.

local_coords

Setter	set_use_local_coordinates(value)
Getter	get_use_local_coordinates()

If true, particles use the parent node’s coordinate space. If false, they use global coordinates. Default value: .

Setter	set_normal_map(value)
Getter	get_normal_map()

Normal map to be used for the texture property.

one_shot

Setter	set_one_shot(value)
Getter	get_one_shot()

If true, only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle’s end. Default value: false.

float preprocess

process_material

Setter	set_process_material(value)
Getter	get_process_material()

Material for processing particles. Can be a or a ShaderMaterial.

randomness

Setter	set_randomness_ratio(value)
Getter	get_randomness_ratio()

Emission lifetime randomness ratio. Default value: 0.

float speed_scale

Setter	set_speed_scale(value)
Getter	get_speed_scale()

Particle system’s running speed scaling ratio. Default value: 1. A value of can be used to pause the particles.

texture

Setter	set_texture(value)
Getter	get_texture()

Particle texture. If null particles will be squares.

Rect2 visibility_rect

Setter	set_visibility_rect(value)
Getter	get_visibility_rect()

Editor visibility helper.

Method Descriptions

capture_rect ( ) const

Returns a rectangle containing the positions of all existing particles.

void restart ( )

Restarts all the existing particles.