godot-docs/classes/class_particles2d.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Particles2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Particles2D:

Particles2D
===========

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

2D particle emitter.

Properties
----------

+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`int<class_int>`                        | :ref:`amount<class_Particles2D_property_amount>`                     |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`DrawOrder<enum_Particles2D_DrawOrder>` | :ref:`draw_order<class_Particles2D_property_draw_order>`             |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                      | :ref:`emitting<class_Particles2D_property_emitting>`                 |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>`                    | :ref:`explosiveness<class_Particles2D_property_explosiveness>`       |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`int<class_int>`                        | :ref:`fixed_fps<class_Particles2D_property_fixed_fps>`               |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                      | :ref:`fract_delta<class_Particles2D_property_fract_delta>`           |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>`                    | :ref:`lifetime<class_Particles2D_property_lifetime>`                 |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                      | :ref:`local_coords<class_Particles2D_property_local_coords>`         |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`Texture<class_Texture>`                | :ref:`normal_map<class_Particles2D_property_normal_map>`             |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                      | :ref:`one_shot<class_Particles2D_property_one_shot>`                 |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>`                    | :ref:`preprocess<class_Particles2D_property_preprocess>`             |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`Material<class_Material>`              | :ref:`process_material<class_Particles2D_property_process_material>` |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>`                    | :ref:`randomness<class_Particles2D_property_randomness>`             |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`float<class_float>`                    | :ref:`speed_scale<class_Particles2D_property_speed_scale>`           |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`Texture<class_Texture>`                | :ref:`texture<class_Particles2D_property_texture>`                   |
+----------------------------------------------+----------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>`                    | :ref:`visibility_rect<class_Particles2D_property_visibility_rect>`   |
+----------------------------------------------+----------------------------------------------------------------------+

Methods
-------

+---------------------------+------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`capture_rect<class_Particles2D_method_capture_rect>` **(** **)** const |
+---------------------------+------------------------------------------------------------------------------+
| void                      | :ref:`restart<class_Particles2D_method_restart>` **(** **)**                 |
+---------------------------+------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_Particles2D_DrawOrder:

.. _class_Particles2D_constant_DRAW_ORDER_INDEX:

.. _class_Particles2D_constant_DRAW_ORDER_LIFETIME:

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.

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 :ref:`ParticlesMaterial<class_ParticlesMaterial>` to configure particle appearance and behavior. Alternatively, you can add a :ref:`ShaderMaterial<class_ShaderMaterial>` which will be applied to all particles.

Tutorials
---------

- :doc:`../tutorials/2d/particle_systems_2d`

Property Descriptions
---------------------

.. _class_Particles2D_property_amount:

- :ref:`int<class_int>` **amount**

+----------+-------------------+
| *Setter* | set_amount(value) |
+----------+-------------------+
| *Getter* | get_amount()      |
+----------+-------------------+

Number of particles emitted in one emission cycle.

.. _class_Particles2D_property_draw_order:

- :ref:`DrawOrder<enum_Particles2D_DrawOrder>` **draw_order**

+----------+-----------------------+
| *Setter* | set_draw_order(value) |
+----------+-----------------------+
| *Getter* | get_draw_order()      |
+----------+-----------------------+

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

.. _class_Particles2D_property_emitting:

- :ref:`bool<class_bool>` **emitting**

+----------+---------------------+
| *Setter* | set_emitting(value) |
+----------+---------------------+
| *Getter* | is_emitting()       |
+----------+---------------------+

If ``true``, particles are being emitted. Default value: ``true``.

.. _class_Particles2D_property_explosiveness:

- :ref:`float<class_float>` **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: ``0``.

.. _class_Particles2D_property_fixed_fps:

- :ref:`int<class_int>` **fixed_fps**

+----------+----------------------+
| *Setter* | set_fixed_fps(value) |
+----------+----------------------+
| *Getter* | get_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 particle system itself.

.. _class_Particles2D_property_fract_delta:

- :ref:`bool<class_bool>` **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``

.. _class_Particles2D_property_lifetime:

- :ref:`float<class_float>` **lifetime**

+----------+---------------------+
| *Setter* | set_lifetime(value) |
+----------+---------------------+
| *Getter* | get_lifetime()      |
+----------+---------------------+

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

.. _class_Particles2D_property_local_coords:

- :ref:`bool<class_bool>` **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: ``true``.

.. _class_Particles2D_property_normal_map:

- :ref:`Texture<class_Texture>` **normal_map**

+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map()      |
+----------+-----------------------+

Normal map to be used for the ``texture`` property.

.. _class_Particles2D_property_one_shot:

- :ref:`bool<class_bool>` **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``.

.. _class_Particles2D_property_preprocess:

- :ref:`float<class_float>` **preprocess**

+----------+-----------------------------+
| *Setter* | set_pre_process_time(value) |
+----------+-----------------------------+
| *Getter* | get_pre_process_time()      |
+----------+-----------------------------+

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

.. _class_Particles2D_property_process_material:

- :ref:`Material<class_Material>` **process_material**

+----------+-----------------------------+
| *Setter* | set_process_material(value) |
+----------+-----------------------------+
| *Getter* | get_process_material()      |
+----------+-----------------------------+

:ref:`Material<class_Material>` for processing particles. Can be a :ref:`ParticlesMaterial<class_ParticlesMaterial>` or a :ref:`ShaderMaterial<class_ShaderMaterial>`.

.. _class_Particles2D_property_randomness:

- :ref:`float<class_float>` **randomness**

+----------+-----------------------------+
| *Setter* | set_randomness_ratio(value) |
+----------+-----------------------------+
| *Getter* | get_randomness_ratio()      |
+----------+-----------------------------+

Emission lifetime randomness ratio. Default value: ``0``.

.. _class_Particles2D_property_speed_scale:

- :ref:`float<class_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 ``0`` can be used to pause the particles.

.. _class_Particles2D_property_texture:

- :ref:`Texture<class_Texture>` **texture**

+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture()      |
+----------+--------------------+

Particle texture. If ``null`` particles will be squares.

.. _class_Particles2D_property_visibility_rect:

- :ref:`Rect2<class_Rect2>` **visibility_rect**

+----------+----------------------------+
| *Setter* | set_visibility_rect(value) |
+----------+----------------------------+
| *Getter* | get_visibility_rect()      |
+----------+----------------------------+

Editor visibility helper.

Method Descriptions
-------------------

.. _class_Particles2D_method_capture_rect:

- :ref:`Rect2<class_Rect2>` **capture_rect** **(** **)** const

Returns a rectangle containing the positions of all existing particles.

.. _class_Particles2D_method_restart:

- void **restart** **(** **)**

Restarts all the existing particles.