Particles2D

Inherits: Node2D < CanvasItem < Node < Object

GPU-based 2D particle emitter.

Description

2D particle node used to create a variety of particle systems and effects. Particles2D 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 ShaderMaterial which will be applied to all particles.

Note: Particles2D only work when using the GLES3 renderer. If using the GLES2 renderer, use CPUParticles2D instead. You can convert Particles2D to CPUParticles2D by selecting the node, clicking the Particles menu at the top of the 2D editor viewport then choosing Convert to CPUParticles2D.

Note: After working on a Particles node, remember to update its visibility_rect by selecting it, clicking the Particles menu at the top of the 2D editor viewport then choose Generate Visibility Rect. Otherwise, particles may suddenly disappear depending on the camera position and angle.

Tutorials

Properties

intamount8
DrawOrderdraw_order0
boolemittingtrue
floatexplosiveness0.0
intfixed_fps0
boolfract_deltatrue
floatlifetime1.0
boollocal_coordstrue
Texturenormal_map 
boolone_shotfalse
floatpreprocess0.0
Materialprocess_material 
floatrandomness0.0
floatspeed_scale1.0
Texturetexture 
Rect2visibility_rectRect2( -100, -100, 200, 200 )

Methods

Rect2capture_rect ( ) const
voidrestart ( )

Enumerations

enum DrawOrder:

  • DRAW_ORDER_INDEX = 0 —- Particles are drawn in the order emitted.
  • DRAW_ORDER_LIFETIME = 1 —- Particles are drawn in order of remaining lifetime.

Property Descriptions

Default8
Setterset_amount(value)
Getterget_amount()

The number of particles emitted in one emission cycle (corresponding to the lifetime).

Note: Changing amount will reset the particle emission, therefore removing all particles that were already emitted before changing amount.


Default0
Setterset_draw_order(value)
Getterget_draw_order()

Particle draw order. Uses DrawOrder values.


Defaulttrue
Setterset_emitting(value)
Getteris_emitting()

If true, particles are being emitted.


Default0.0
Setterset_explosiveness_ratio(value)
Getterget_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.


Default0
Setterset_fixed_fps(value)
Getterget_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.


Defaulttrue
Setterset_fractional_delta(value)
Getterget_fractional_delta()

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


Default1.0
Setterset_lifetime(value)
Getterget_lifetime()

The amount of time each particle will exist (in seconds).


Defaulttrue
Setterset_use_local_coordinates(value)
Getterget_use_local_coordinates()

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


Setterset_normal_map(value)
Getterget_normal_map()

Normal map to be used for the texture property.

Note: Godot expects the normal map to use X+, Y-, and Z+ coordinates. See this page for a comparison of normal map coordinates expected by popular engines.


Defaultfalse
Setterset_one_shot(value)
Getterget_one_shot()

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


Default0.0
Setterset_pre_process_time(value)
Getterget_pre_process_time()

Particle system starts as if it had already run for this many seconds.


Setterset_process_material(value)
Getterget_process_material()

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


Default0.0
Setterset_randomness_ratio(value)
Getterget_randomness_ratio()

Emission lifetime randomness ratio.


Default1.0
Setterset_speed_scale(value)
Getterget_speed_scale()

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


Setterset_texture(value)
Getterget_texture()

Particle texture. If null, particles will be squares.


DefaultRect2( -100, -100, 200, 200 )
Setterset_visibility_rect(value)
Getterget_visibility_rect()

Editor visibility helper.

Method Descriptions

  • Rect2 capture_rect ( ) const

Returns a rectangle containing the positions of all existing particles.


  • void restart ( )

Restarts all the existing particles.