godot-docs/classes/class_cpuparticles.rst

:github_url: hide

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

.. _class_CPUParticles:

CPUParticles
============

**Inherits:** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

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

CPU-based 3D particle emitter.

Properties
----------

+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                                 | :ref:`amount<class_CPUParticles_property_amount>`                                   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`angle<class_CPUParticles_property_angle>`                                     |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`angle_curve<class_CPUParticles_property_angle_curve>`                         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`angle_random<class_CPUParticles_property_angle_random>`                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`angular_velocity<class_CPUParticles_property_angular_velocity>`               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`angular_velocity_curve<class_CPUParticles_property_angular_velocity_curve>`   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`angular_velocity_random<class_CPUParticles_property_angular_velocity_random>` |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`anim_offset<class_CPUParticles_property_anim_offset>`                         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`anim_offset_curve<class_CPUParticles_property_anim_offset_curve>`             |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`anim_offset_random<class_CPUParticles_property_anim_offset_random>`           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`anim_speed<class_CPUParticles_property_anim_speed>`                           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`anim_speed_curve<class_CPUParticles_property_anim_speed_curve>`               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`anim_speed_random<class_CPUParticles_property_anim_speed_random>`             |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`                             | :ref:`color<class_CPUParticles_property_color>`                                     |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Gradient<class_Gradient>`                       | :ref:`color_ramp<class_CPUParticles_property_color_ramp>`                           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`damping<class_CPUParticles_property_damping>`                                 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`damping_curve<class_CPUParticles_property_damping_curve>`                     |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`damping_random<class_CPUParticles_property_damping_random>`                   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`DrawOrder<enum_CPUParticles_DrawOrder>`         | :ref:`draw_order<class_CPUParticles_property_draw_order>`                           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                         | :ref:`emission_box_extents<class_CPUParticles_property_emission_box_extents>`       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`PoolColorArray<class_PoolColorArray>`           | :ref:`emission_colors<class_CPUParticles_property_emission_colors>`                 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>`       | :ref:`emission_normals<class_CPUParticles_property_emission_normals>`               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>`       | :ref:`emission_points<class_CPUParticles_property_emission_points>`                 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_property_emission_shape>`                   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`emission_sphere_radius<class_CPUParticles_property_emission_sphere_radius>`   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`emitting<class_CPUParticles_property_emitting>`                               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`explosiveness<class_CPUParticles_property_explosiveness>`                     |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                                 | :ref:`fixed_fps<class_CPUParticles_property_fixed_fps>`                             |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>`                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>`                   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>`                     |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`flatness<class_CPUParticles_property_flatness>`                               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`fract_delta<class_CPUParticles_property_fract_delta>`                         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                         | :ref:`gravity<class_CPUParticles_property_gravity>`                                 |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`hue_variation<class_CPUParticles_property_hue_variation>`                     |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`hue_variation_curve<class_CPUParticles_property_hue_variation_curve>`         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`hue_variation_random<class_CPUParticles_property_hue_variation_random>`       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`initial_velocity<class_CPUParticles_property_initial_velocity>`               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`initial_velocity_random<class_CPUParticles_property_initial_velocity_random>` |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`lifetime<class_CPUParticles_property_lifetime>`                               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`linear_accel<class_CPUParticles_property_linear_accel>`                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`linear_accel_curve<class_CPUParticles_property_linear_accel_curve>`           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`linear_accel_random<class_CPUParticles_property_linear_accel_random>`         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`local_coords<class_CPUParticles_property_local_coords>`                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>`                               | :ref:`mesh<class_CPUParticles_property_mesh>`                                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`one_shot<class_CPUParticles_property_one_shot>`                               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`preprocess<class_CPUParticles_property_preprocess>`                           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`radial_accel<class_CPUParticles_property_radial_accel>`                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`radial_accel_curve<class_CPUParticles_property_radial_accel_curve>`           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`radial_accel_random<class_CPUParticles_property_radial_accel_random>`         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`randomness<class_CPUParticles_property_randomness>`                           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`scale_amount<class_CPUParticles_property_scale_amount>`                       |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`scale_amount_curve<class_CPUParticles_property_scale_amount_curve>`           |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`scale_amount_random<class_CPUParticles_property_scale_amount_random>`         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`speed_scale<class_CPUParticles_property_speed_scale>`                         |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`spread<class_CPUParticles_property_spread>`                                   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`tangential_accel<class_CPUParticles_property_tangential_accel>`               |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>`                             | :ref:`tangential_accel_curve<class_CPUParticles_property_tangential_accel_curve>`   |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`tangential_accel_random<class_CPUParticles_property_tangential_accel_random>` |
+-------------------------------------------------------+-------------------------------------------------------------------------------------+

Methods
-------

+------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_CPUParticles_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_CPUParticles_method_restart>` **(** **)**                                                                 |
+------+-------------------------------------------------------------------------------------------------------------------------------+

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

.. _enum_CPUParticles_DrawOrder:

.. _class_CPUParticles_constant_DRAW_ORDER_INDEX:

.. _class_CPUParticles_constant_DRAW_ORDER_LIFETIME:

.. _class_CPUParticles_constant_DRAW_ORDER_VIEW_DEPTH:

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.

- **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth.

----

.. _enum_CPUParticles_Parameter:

.. _class_CPUParticles_constant_PARAM_INITIAL_LINEAR_VELOCITY:

.. _class_CPUParticles_constant_PARAM_ANGULAR_VELOCITY:

.. _class_CPUParticles_constant_PARAM_LINEAR_ACCEL:

.. _class_CPUParticles_constant_PARAM_RADIAL_ACCEL:

.. _class_CPUParticles_constant_PARAM_TANGENTIAL_ACCEL:

.. _class_CPUParticles_constant_PARAM_DAMPING:

.. _class_CPUParticles_constant_PARAM_ANGLE:

.. _class_CPUParticles_constant_PARAM_SCALE:

.. _class_CPUParticles_constant_PARAM_HUE_VARIATION:

.. _class_CPUParticles_constant_PARAM_ANIM_SPEED:

.. _class_CPUParticles_constant_PARAM_ANIM_OFFSET:

.. _class_CPUParticles_constant_PARAM_MAX:

enum **Parameter**:

- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set initial velocity properties.

- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set angular velocity properties.

- **PARAM_LINEAR_ACCEL** = **2** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set linear acceleration properties.

- **PARAM_RADIAL_ACCEL** = **3** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set radial acceleration properties.

- **PARAM_TANGENTIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set tangential acceleration properties.

- **PARAM_DAMPING** = **5** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set damping properties.

- **PARAM_ANGLE** = **6** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set angle properties.

- **PARAM_SCALE** = **7** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set scale properties.

- **PARAM_HUE_VARIATION** = **8** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set hue variation properties.

- **PARAM_ANIM_SPEED** = **9** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set animation speed properties.

- **PARAM_ANIM_OFFSET** = **10** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set animation offset properties.

- **PARAM_MAX** = **11** --- Represents the size of the :ref:`Parameter<enum_CPUParticles_Parameter>` enum.

----

.. _enum_CPUParticles_Flags:

.. _class_CPUParticles_constant_FLAG_ALIGN_Y_TO_VELOCITY:

.. _class_CPUParticles_constant_FLAG_ROTATE_Y:

.. _class_CPUParticles_constant_FLAG_MAX:

enum **Flags**:

- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>`.

- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>`.

- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_CPUParticles_Flags>` enum.

----

.. _enum_CPUParticles_EmissionShape:

.. _class_CPUParticles_constant_EMISSION_SHAPE_POINT:

.. _class_CPUParticles_constant_EMISSION_SHAPE_SPHERE:

.. _class_CPUParticles_constant_EMISSION_SHAPE_BOX:

.. _class_CPUParticles_constant_EMISSION_SHAPE_POINTS:

.. _class_CPUParticles_constant_EMISSION_SHAPE_DIRECTED_POINTS:

enum **EmissionShape**:

- **EMISSION_SHAPE_POINT** = **0** --- All particles will be emitted from a single point.

- **EMISSION_SHAPE_SPHERE** = **1** --- Particles will be emitted in the volume of a sphere.

- **EMISSION_SHAPE_BOX** = **2** --- Particles will be emitted in the volume of a box.

- **EMISSION_SHAPE_POINTS** = **3** --- Particles will be emitted at a position chosen randomly among :ref:`emission_points<class_CPUParticles_property_emission_points>`. Particle color will be modulated by :ref:`emission_colors<class_CPUParticles_property_emission_colors>`.

- **EMISSION_SHAPE_DIRECTED_POINTS** = **4** --- Particles will be emitted at a position chosen randomly among :ref:`emission_points<class_CPUParticles_property_emission_points>`. Particle velocity and rotation will be set based on :ref:`emission_normals<class_CPUParticles_property_emission_normals>`. Particle color will be modulated by :ref:`emission_colors<class_CPUParticles_property_emission_colors>`.

Description
-----------

CPU-based 3D particle node used to create a variety of particle systems and effects.

See also :ref:`Particles<class_Particles>`, which provides the same functionality with hardware acceleration, but may not run on older devices.

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

.. _class_CPUParticles_property_amount:

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

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

Number of particles emitted in one emission cycle.

----

.. _class_CPUParticles_property_angle:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Initial rotation applied to each particle, in degrees.

----

.. _class_CPUParticles_property_angle_curve:

- :ref:`Curve<class_Curve>` **angle_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_angle_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Rotation randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_angular_velocity:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.

----

.. _class_CPUParticles_property_angular_velocity_curve:

- :ref:`Curve<class_Curve>` **angular_velocity_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_angular_velocity_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Angular velocity randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_anim_offset:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Particle animation offset.

----

.. _class_CPUParticles_property_anim_offset_curve:

- :ref:`Curve<class_Curve>` **anim_offset_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_anim_offset_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Animation offset randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_anim_speed:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Particle animation speed.

----

.. _class_CPUParticles_property_anim_speed_curve:

- :ref:`Curve<class_Curve>` **anim_speed_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_anim_speed_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Animation speed randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_color:

- :ref:`Color<class_Color>` **color**

+----------+------------------+
| *Setter* | set_color(value) |
+----------+------------------+
| *Getter* | get_color()      |
+----------+------------------+

Unused for 3D particles.

----

.. _class_CPUParticles_property_color_ramp:

- :ref:`Gradient<class_Gradient>` **color_ramp**

+----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+----------+-----------------------+
| *Getter* | get_color_ramp()      |
+----------+-----------------------+

Unused for 3D particles.

----

.. _class_CPUParticles_property_damping:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

The rate at which particles lose velocity.

----

.. _class_CPUParticles_property_damping_curve:

- :ref:`Curve<class_Curve>` **damping_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Damping will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_damping_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Damping randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_draw_order:

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

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

Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` values. Default value: :ref:`DRAW_ORDER_INDEX<class_CPUParticles_constant_DRAW_ORDER_INDEX>`.

----

.. _class_CPUParticles_property_emission_box_extents:

- :ref:`Vector3<class_Vector3>` **emission_box_extents**

+----------+---------------------------------+
| *Setter* | set_emission_box_extents(value) |
+----------+---------------------------------+
| *Getter* | get_emission_box_extents()      |
+----------+---------------------------------+

The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_CPUParticles_constant_EMISSION_SHAPE_BOX>`.

----

.. _class_CPUParticles_property_emission_colors:

- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**

+----------+----------------------------+
| *Setter* | set_emission_colors(value) |
+----------+----------------------------+
| *Getter* | get_emission_colors()      |
+----------+----------------------------+

----

.. _class_CPUParticles_property_emission_normals:

- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_normals**

+----------+-----------------------------+
| *Setter* | set_emission_normals(value) |
+----------+-----------------------------+
| *Getter* | get_emission_normals()      |
+----------+-----------------------------+

----

.. _class_CPUParticles_property_emission_points:

- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points**

+----------+----------------------------+
| *Setter* | set_emission_points(value) |
+----------+----------------------------+
| *Getter* | get_emission_points()      |
+----------+----------------------------+

----

.. _class_CPUParticles_property_emission_shape:

- :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` **emission_shape**

+----------+---------------------------+
| *Setter* | set_emission_shape(value) |
+----------+---------------------------+
| *Getter* | get_emission_shape()      |
+----------+---------------------------+

Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` for values. Default value: :ref:`EMISSION_SHAPE_POINT<class_CPUParticles_constant_EMISSION_SHAPE_POINT>`.

----

.. _class_CPUParticles_property_emission_sphere_radius:

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

+----------+-----------------------------------+
| *Setter* | set_emission_sphere_radius(value) |
+----------+-----------------------------------+
| *Getter* | get_emission_sphere_radius()      |
+----------+-----------------------------------+

The sphere's radius if :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_CPUParticles_constant_EMISSION_SHAPE_SPHERE>`.

----

.. _class_CPUParticles_property_emitting:

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

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

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

----

.. _class_CPUParticles_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_CPUParticles_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_CPUParticles_property_flag_align_y:

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

+----------+--------------------------+
| *Setter* | set_particle_flag(value) |
+----------+--------------------------+
| *Getter* | get_particle_flag()      |
+----------+--------------------------+

Align y-axis of particle with the direction of its velocity.

----

.. _class_CPUParticles_property_flag_disable_z:

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

+----------+--------------------------+
| *Setter* | set_particle_flag(value) |
+----------+--------------------------+
| *Getter* | get_particle_flag()      |
+----------+--------------------------+

If ``true``, particles will not move on the z axis. Default value: ``false``.

----

.. _class_CPUParticles_property_flag_rotate_y:

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

+----------+--------------------------+
| *Setter* | set_particle_flag(value) |
+----------+--------------------------+
| *Getter* | get_particle_flag()      |
+----------+--------------------------+

If ``true``, particles rotate around y-axis by :ref:`angle<class_CPUParticles_property_angle>`.

----

.. _class_CPUParticles_property_flatness:

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

+----------+---------------------+
| *Setter* | set_flatness(value) |
+----------+---------------------+
| *Getter* | get_flatness()      |
+----------+---------------------+

Amount of :ref:`spread<class_CPUParticles_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``.

----

.. _class_CPUParticles_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_CPUParticles_property_gravity:

- :ref:`Vector3<class_Vector3>` **gravity**

+----------+--------------------+
| *Setter* | set_gravity(value) |
+----------+--------------------+
| *Getter* | get_gravity()      |
+----------+--------------------+

Gravity applied to every particle. Default value: ``(0, -9.8, 0)``.

----

.. _class_CPUParticles_property_hue_variation:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Initial hue variation applied to each particle.

----

.. _class_CPUParticles_property_hue_variation_curve:

- :ref:`Curve<class_Curve>` **hue_variation_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's hue will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_hue_variation_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Hue variation randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_initial_velocity:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_CPUParticles_property_spread>` and the node's orientation.

----

.. _class_CPUParticles_property_initial_velocity_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Initial velocity randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_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_CPUParticles_property_linear_accel:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Linear acceleration applied to each particle in the direction of motion.

----

.. _class_CPUParticles_property_linear_accel_curve:

- :ref:`Curve<class_Curve>` **linear_accel_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_linear_accel_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Linear acceleration randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_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_CPUParticles_property_mesh:

- :ref:`Mesh<class_Mesh>` **mesh**

+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh()      |
+----------+-----------------+

The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will be spheres.

----

.. _class_CPUParticles_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_CPUParticles_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_CPUParticles_property_radial_accel:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Radial acceleration applied to each particle. Makes particle accelerate away from origin.

----

.. _class_CPUParticles_property_radial_accel_curve:

- :ref:`Curve<class_Curve>` **radial_accel_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_radial_accel_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Radial acceleration randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_property_randomness:

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

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

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

----

.. _class_CPUParticles_property_scale_amount:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Initial scale applied to each particle.

----

.. _class_CPUParticles_property_scale_amount_curve:

- :ref:`Curve<class_Curve>` **scale_amount_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's scale will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_scale_amount_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Scale randomness ratio. Default value: ``0``.

----

.. _class_CPUParticles_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_CPUParticles_property_spread:

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

+----------+-------------------+
| *Setter* | set_spread(value) |
+----------+-------------------+
| *Getter* | get_spread()      |
+----------+-------------------+

Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``.

----

.. _class_CPUParticles_property_tangential_accel:

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

+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param()      |
+----------+------------------+

Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.

----

.. _class_CPUParticles_property_tangential_accel_curve:

- :ref:`Curve<class_Curve>` **tangential_accel_curve**

+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve()      |
+----------+------------------------+

Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`.

----

.. _class_CPUParticles_property_tangential_accel_random:

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

+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness()      |
+----------+-----------------------------+

Tangential acceleration randomness ratio. Default value: ``0``.

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

.. _class_CPUParticles_method_convert_from_particles:

- void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**

Sets this node's properties to match a given :ref:`Particles<class_Particles>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`.

----

.. _class_CPUParticles_method_restart:

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

Restarts the particle emitter.