:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CPUParticles2D.xml. .. _class_CPUParticles2D: CPUParticles2D ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A CPU-based 2D particle emitter. .. rst-class:: classref-introduction-group Description ----------- CPU-based 2D particle node used to create a variety of particle systems and effects. See also :ref:`GPUParticles2D`, which provides the same functionality with hardware acceleration, but may not run on older devices. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Particle systems (2D) <../tutorials/2d/particle_systems_2d>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`amount` | ``8`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`angle_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angle_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angle_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`angular_velocity_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_velocity_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_velocity_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`anim_offset_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`anim_offset_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`anim_offset_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`anim_speed_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`anim_speed_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`anim_speed_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Gradient` | :ref:`color_initial_ramp` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Gradient` | :ref:`color_ramp` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`damping_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`damping_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`damping_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`direction` | ``Vector2(1, 0)`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`emission_colors` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`emission_normals` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`emission_points` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`emission_rect_extents` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`emission_sphere_radius` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`emitting` | ``true`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`explosiveness` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`fixed_fps` | ``0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`fract_delta` | ``true`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`gravity` | ``Vector2(0, 980)`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`hue_variation_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`hue_variation_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`hue_variation_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`initial_velocity_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`initial_velocity_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`lifetime` | ``1.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`lifetime_randomness` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`linear_accel_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_accel_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_accel_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`local_coords` | ``false`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`one_shot` | ``false`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`orbit_velocity_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`orbit_velocity_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`orbit_velocity_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`particle_flag_align_y` | ``false`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`preprocess` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`radial_accel_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`radial_accel_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`radial_accel_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`randomness` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`scale_amount_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`scale_amount_max` | ``1.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`scale_amount_min` | ``1.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`scale_curve_x` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`scale_curve_y` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`seed` | ``0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`speed_scale` | ``1.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`split_scale` | ``false`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`spread` | ``45.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`tangential_accel_curve` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tangential_accel_max` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tangential_accel_min` | ``0.0`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`texture` | | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`use_fixed_seed` | ``false`` | +---------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`convert_from_particles`\ (\ particles\: :ref:`Node`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Curve` | :ref:`get_param_curve`\ (\ param\: :ref:`Parameter`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_max`\ (\ param\: :ref:`Parameter`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_min`\ (\ param\: :ref:`Parameter`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`request_particles_process`\ (\ process_time\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`restart`\ (\ keep_seed\: :ref:`bool` = false\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_param_curve`\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_param_max`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_param_min`\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_particle_flag`\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_CPUParticles2D_signal_finished: .. rst-class:: classref-signal **finished**\ (\ ) :ref:`🔗` Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_CPUParticles2D_DrawOrder: .. rst-class:: classref-enumeration enum **DrawOrder**: :ref:`🔗` .. _class_CPUParticles2D_constant_DRAW_ORDER_INDEX: .. rst-class:: classref-enumeration-constant :ref:`DrawOrder` **DRAW_ORDER_INDEX** = ``0`` Particles are drawn in the order emitted. .. _class_CPUParticles2D_constant_DRAW_ORDER_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`DrawOrder` **DRAW_ORDER_LIFETIME** = ``1`` Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. .. rst-class:: classref-item-separator ---- .. _enum_CPUParticles2D_Parameter: .. rst-class:: classref-enumeration enum **Parameter**: :ref:`🔗` .. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set initial velocity properties. .. _class_CPUParticles2D_constant_PARAM_ANGULAR_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANGULAR_VELOCITY** = ``1`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set angular velocity properties. .. _class_CPUParticles2D_constant_PARAM_ORBIT_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ORBIT_VELOCITY** = ``2`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set orbital velocity properties. .. _class_CPUParticles2D_constant_PARAM_LINEAR_ACCEL: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_LINEAR_ACCEL** = ``3`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set linear acceleration properties. .. _class_CPUParticles2D_constant_PARAM_RADIAL_ACCEL: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_RADIAL_ACCEL** = ``4`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set radial acceleration properties. .. _class_CPUParticles2D_constant_PARAM_TANGENTIAL_ACCEL: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_TANGENTIAL_ACCEL** = ``5`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set tangential acceleration properties. .. _class_CPUParticles2D_constant_PARAM_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_DAMPING** = ``6`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set damping properties. .. _class_CPUParticles2D_constant_PARAM_ANGLE: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANGLE** = ``7`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set angle properties. .. _class_CPUParticles2D_constant_PARAM_SCALE: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_SCALE** = ``8`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set scale properties. .. _class_CPUParticles2D_constant_PARAM_HUE_VARIATION: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_HUE_VARIATION** = ``9`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set hue variation properties. .. _class_CPUParticles2D_constant_PARAM_ANIM_SPEED: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANIM_SPEED** = ``10`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set animation speed properties. .. _class_CPUParticles2D_constant_PARAM_ANIM_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANIM_OFFSET** = ``11`` Use with :ref:`set_param_min()`, :ref:`set_param_max()`, and :ref:`set_param_curve()` to set animation offset properties. .. _class_CPUParticles2D_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_MAX** = ``12`` Represents the size of the :ref:`Parameter` enum. .. rst-class:: classref-item-separator ---- .. _enum_CPUParticles2D_ParticleFlags: .. rst-class:: classref-enumeration enum **ParticleFlags**: :ref:`🔗` .. _class_CPUParticles2D_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`ParticleFlags` **PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY** = ``0`` Use with :ref:`set_particle_flag()` to set :ref:`particle_flag_align_y`. .. _class_CPUParticles2D_constant_PARTICLE_FLAG_ROTATE_Y: .. rst-class:: classref-enumeration-constant :ref:`ParticleFlags` **PARTICLE_FLAG_ROTATE_Y** = ``1`` Present for consistency with 3D particle nodes, not used in 2D. .. _class_CPUParticles2D_constant_PARTICLE_FLAG_DISABLE_Z: .. rst-class:: classref-enumeration-constant :ref:`ParticleFlags` **PARTICLE_FLAG_DISABLE_Z** = ``2`` Present for consistency with 3D particle nodes, not used in 2D. .. _class_CPUParticles2D_constant_PARTICLE_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`ParticleFlags` **PARTICLE_FLAG_MAX** = ``3`` Represents the size of the :ref:`ParticleFlags` enum. .. rst-class:: classref-item-separator ---- .. _enum_CPUParticles2D_EmissionShape: .. rst-class:: classref-enumeration enum **EmissionShape**: :ref:`🔗` .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_POINT** = ``0`` All particles will be emitted from a single point. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_SPHERE: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_SPHERE** = ``1`` Particles will be emitted in the volume of a sphere flattened to two dimensions. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_SPHERE_SURFACE: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_SPHERE_SURFACE** = ``2`` Particles will be emitted on the surface of a sphere flattened to two dimensions. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_RECTANGLE: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_RECTANGLE** = ``3`` Particles will be emitted in the area of a rectangle. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINTS: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_POINTS** = ``4`` Particles will be emitted at a position chosen randomly among :ref:`emission_points`. Particle color will be modulated by :ref:`emission_colors`. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_DIRECTED_POINTS: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_DIRECTED_POINTS** = ``5`` Particles will be emitted at a position chosen randomly among :ref:`emission_points`. Particle velocity and rotation will be set based on :ref:`emission_normals`. Particle color will be modulated by :ref:`emission_colors`. .. _class_CPUParticles2D_constant_EMISSION_SHAPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_MAX** = ``6`` Represents the size of the :ref:`EmissionShape` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CPUParticles2D_property_amount: .. rst-class:: classref-property :ref:`int` **amount** = ``8`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_amount**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_amount**\ (\ ) Number of particles emitted in one emission cycle. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_angle_curve: .. rst-class:: classref-property :ref:`Curve` **angle_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's rotation will be animated along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_angle_max: .. rst-class:: classref-property :ref:`float` **angle_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial rotation applied to each particle, in degrees. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_angle_min: .. rst-class:: classref-property :ref:`float` **angle_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`angle_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_angular_velocity_curve: .. rst-class:: classref-property :ref:`Curve` **angular_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's angular velocity will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_angular_velocity_max: .. rst-class:: classref-property :ref:`float` **angular_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_angular_velocity_min: .. rst-class:: classref-property :ref:`float` **angular_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`angular_velocity_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_anim_offset_curve: .. rst-class:: classref-property :ref:`Curve` **anim_offset_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation offset will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_anim_offset_max: .. rst-class:: classref-property :ref:`float` **anim_offset_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum animation offset that corresponds to frame index in the texture. ``0`` is the first frame, ``1`` is the last one. See :ref:`CanvasItemMaterial.particles_animation`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_anim_offset_min: .. rst-class:: classref-property :ref:`float` **anim_offset_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`anim_offset_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_anim_speed_curve: .. rst-class:: classref-property :ref:`Curve` **anim_speed_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's animation speed will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_anim_speed_max: .. rst-class:: classref-property :ref:`float` **anim_speed_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum particle animation speed. Animation speed of ``1`` means that the particles will make full ``0`` to ``1`` offset cycle during lifetime, ``2`` means ``2`` cycles etc. With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMaterial.particles_anim_loop` property if you want the animation to repeat. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_anim_speed_min: .. rst-class:: classref-property :ref:`float` **anim_speed_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`anim_speed_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) Each particle's initial color. If :ref:`texture` is defined, it will be multiplied by this color. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_color_initial_ramp: .. rst-class:: classref-property :ref:`Gradient` **color_initial_ramp** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient`\ ) - :ref:`Gradient` **get_color_initial_ramp**\ (\ ) Each particle's initial color will vary along this :ref:`Gradient` (multiplied with :ref:`color`). .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_color_ramp: .. rst-class:: classref-property :ref:`Gradient` **color_ramp** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color_ramp**\ (\ value\: :ref:`Gradient`\ ) - :ref:`Gradient` **get_color_ramp**\ (\ ) Each particle's color will vary along this :ref:`Gradient` over its lifetime (multiplied with :ref:`color`). .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_damping_curve: .. rst-class:: classref-property :ref:`Curve` **damping_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Damping will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_damping_max: .. rst-class:: classref-property :ref:`float` **damping_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| The maximum rate at which particles lose velocity. For example value of ``100`` means that the particle will go from ``100`` velocity to ``0`` in ``1`` second. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_damping_min: .. rst-class:: classref-property :ref:`float` **damping_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`damping_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_direction: .. rst-class:: classref-property :ref:`Vector2` **direction** = ``Vector2(1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_direction**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_direction**\ (\ ) Unit vector specifying the particles' emission direction. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_draw_order: .. rst-class:: classref-property :ref:`DrawOrder` **draw_order** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder`\ ) - :ref:`DrawOrder` **get_draw_order**\ (\ ) Particle draw order. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emission_colors: .. rst-class:: classref-property :ref:`PackedColorArray` **emission_colors** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emission_colors**\ (\ value\: :ref:`PackedColorArray`\ ) - :ref:`PackedColorArray` **get_emission_colors**\ (\ ) Sets the :ref:`Color`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedColorArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emission_normals: .. rst-class:: classref-property :ref:`PackedVector2Array` **emission_normals** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emission_normals**\ (\ value\: :ref:`PackedVector2Array`\ ) - :ref:`PackedVector2Array` **get_emission_normals**\ (\ ) Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emission_points: .. rst-class:: classref-property :ref:`PackedVector2Array` **emission_points** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emission_points**\ (\ value\: :ref:`PackedVector2Array`\ ) - :ref:`PackedVector2Array` **get_emission_points**\ (\ ) Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector2Array` for more details. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emission_rect_extents: .. rst-class:: classref-property :ref:`Vector2` **emission_rect_extents** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emission_rect_extents**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_emission_rect_extents**\ (\ ) The rectangle's extents if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_RECTANGLE`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emission_shape: .. rst-class:: classref-property :ref:`EmissionShape` **emission_shape** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape`\ ) - :ref:`EmissionShape` **get_emission_shape**\ (\ ) Particles will be emitted inside this region. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emission_sphere_radius: .. rst-class:: classref-property :ref:`float` **emission_sphere_radius** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_emission_sphere_radius**\ (\ ) The sphere's radius if :ref:`emission_shape` is set to :ref:`EMISSION_SHAPE_SPHERE`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_emitting: .. rst-class:: classref-property :ref:`bool` **emitting** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_emitting**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_emitting**\ (\ ) If ``true``, particles are being emitted. :ref:`emitting` can be used to start and stop particles from emitting. However, if :ref:`one_shot` is ``true`` setting :ref:`emitting` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished` signal to be notified once all active particles finish processing. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_explosiveness: .. rst-class:: classref-property :ref:`float` **explosiveness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_fixed_fps: .. rst-class:: classref-property :ref:`int` **fixed_fps** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_fixed_fps**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_fixed_fps**\ (\ ) The particle system's frame rate is fixed to a value. For example, 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. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_fract_delta: .. rst-class:: classref-property :ref:`bool` **fract_delta** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_fractional_delta**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_fractional_delta**\ (\ ) If ``true``, results in fractional delta calculation which has a smoother particles display effect. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_gravity: .. rst-class:: classref-property :ref:`Vector2` **gravity** = ``Vector2(0, 980)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_gravity**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_gravity**\ (\ ) Gravity applied to every particle. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_hue_variation_curve: .. rst-class:: classref-property :ref:`Curve` **hue_variation_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's hue will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_hue_variation_max: .. rst-class:: classref-property :ref:`float` **hue_variation_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial hue variation applied to each particle. It will shift the particle color's hue. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_hue_variation_min: .. rst-class:: classref-property :ref:`float` **hue_variation_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`hue_variation_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_initial_velocity_max: .. rst-class:: classref-property :ref:`float` **initial_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction` and :ref:`spread`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_initial_velocity_min: .. rst-class:: classref-property :ref:`float` **initial_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`initial_velocity_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_lifetime: .. rst-class:: classref-property :ref:`float` **lifetime** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_lifetime**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_lifetime**\ (\ ) Amount of time each particle will exist. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_lifetime_randomness: .. rst-class:: classref-property :ref:`float` **lifetime_randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_lifetime_randomness**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_lifetime_randomness**\ (\ ) Particle lifetime randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_linear_accel_curve: .. rst-class:: classref-property :ref:`Curve` **linear_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's linear acceleration will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_linear_accel_max: .. rst-class:: classref-property :ref:`float` **linear_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum linear acceleration applied to each particle in the direction of motion. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_linear_accel_min: .. rst-class:: classref-property :ref:`float` **linear_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`linear_accel_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_local_coords: .. rst-class:: classref-property :ref:`bool` **local_coords** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_use_local_coordinates**\ (\ ) If ``true``, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the **CPUParticles2D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **CPUParticles2D** node (and its parents) when it is moved or rotated. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_one_shot: .. rst-class:: classref-property :ref:`bool` **one_shot** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_one_shot**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_one_shot**\ (\ ) If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_orbit_velocity_curve: .. rst-class:: classref-property :ref:`Curve` **orbit_velocity_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's orbital velocity will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_orbit_velocity_max: .. rst-class:: classref-property :ref:`float` **orbit_velocity_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_orbit_velocity_min: .. rst-class:: classref-property :ref:`float` **orbit_velocity_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`orbit_velocity_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_particle_flag_align_y: .. rst-class:: classref-property :ref:`bool` **particle_flag_align_y** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) - :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_preprocess: .. rst-class:: classref-property :ref:`float` **preprocess** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pre_process_time**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_pre_process_time**\ (\ ) Particle system starts as if it had already run for this many seconds. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_radial_accel_curve: .. rst-class:: classref-property :ref:`Curve` **radial_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's radial acceleration will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_radial_accel_max: .. rst-class:: classref-property :ref:`float` **radial_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_radial_accel_min: .. rst-class:: classref-property :ref:`float` **radial_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`radial_accel_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_randomness: .. rst-class:: classref-property :ref:`float` **randomness** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_randomness_ratio**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_randomness_ratio**\ (\ ) Emission lifetime randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_scale_amount_curve: .. rst-class:: classref-property :ref:`Curve` **scale_amount_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's scale will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_scale_amount_max: .. rst-class:: classref-property :ref:`float` **scale_amount_max** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum initial scale applied to each particle. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_scale_amount_min: .. rst-class:: classref-property :ref:`float` **scale_amount_min** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`scale_amount_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_scale_curve_x: .. rst-class:: classref-property :ref:`Curve` **scale_curve_x** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_scale_curve_x**\ (\ value\: :ref:`Curve`\ ) - :ref:`Curve` **get_scale_curve_x**\ (\ ) Each particle's horizontal scale will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. \ :ref:`split_scale` must be enabled. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_scale_curve_y: .. rst-class:: classref-property :ref:`Curve` **scale_curve_y** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_scale_curve_y**\ (\ value\: :ref:`Curve`\ ) - :ref:`Curve` **get_scale_curve_y**\ (\ ) Each particle's vertical scale will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. \ :ref:`split_scale` must be enabled. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_seed: .. rst-class:: classref-property :ref:`int` **seed** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_seed**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_seed**\ (\ ) Sets the random seed used by the particle system. Only effective if :ref:`use_fixed_seed` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_speed_scale: .. rst-class:: classref-property :ref:`float` **speed_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_speed_scale**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_speed_scale**\ (\ ) Particle system's running speed scaling ratio. A value of ``0`` can be used to pause the particles. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_split_scale: .. rst-class:: classref-property :ref:`bool` **split_scale** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_split_scale**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_split_scale**\ (\ ) If ``true``, the scale curve will be split into x and y components. See :ref:`scale_curve_x` and :ref:`scale_curve_y`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_spread: .. rst-class:: classref-property :ref:`float` **spread** = ``45.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_spread**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_spread**\ (\ ) Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_tangential_accel_curve: .. rst-class:: classref-property :ref:`Curve` **tangential_accel_curve** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) - :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| Each particle's tangential acceleration will vary along this :ref:`Curve`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_tangential_accel_max: .. rst-class:: classref-property :ref:`float` **tangential_accel_max** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_tangential_accel_min: .. rst-class:: classref-property :ref:`float` **tangential_accel_min** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) - :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| Minimum equivalent of :ref:`tangential_accel_max`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_texture: .. rst-class:: classref-property :ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_texture**\ (\ ) Particle texture. If ``null``, particles will be squares. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_property_use_fixed_seed: .. rst-class:: classref-property :ref:`bool` **use_fixed_seed** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_use_fixed_seed**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_use_fixed_seed**\ (\ ) If ``true``, particles will use the same seed for every simulation using the seed defined in :ref:`seed`. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_CPUParticles2D_method_convert_from_particles: .. rst-class:: classref-method |void| **convert_from_particles**\ (\ particles\: :ref:`Node`\ ) :ref:`🔗` Sets this node's properties to match a given :ref:`GPUParticles2D` node with an assigned :ref:`ParticleProcessMaterial`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_get_param_curve: .. rst-class:: classref-method :ref:`Curve` **get_param_curve**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_get_param_max: .. rst-class:: classref-method :ref:`float` **get_param_max**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the maximum value range for the given parameter. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_get_param_min: .. rst-class:: classref-method :ref:`float` **get_param_min**\ (\ param\: :ref:`Parameter`\ ) |const| :ref:`🔗` Returns the minimum value range for the given parameter. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_get_particle_flag: .. rst-class:: classref-method :ref:`bool` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`\ ) |const| :ref:`🔗` Returns the enabled state of the given particle flag. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_request_particles_process: .. rst-class:: classref-method |void| **request_particles_process**\ (\ process_time\: :ref:`float`\ ) :ref:`🔗` Requests the particles to process for extra process time during a single frame. Useful for particle playback, if used in combination with :ref:`use_fixed_seed` or by calling :ref:`restart()` with parameter ``keep_seed`` set to ``true``. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_restart: .. rst-class:: classref-method |void| **restart**\ (\ keep_seed\: :ref:`bool` = false\ ) :ref:`🔗` Restarts the particle emitter. If ``keep_seed`` is ``true``, the current random seed will be preserved. Useful for seeking and playback. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_set_param_curve: .. rst-class:: classref-method |void| **set_param_curve**\ (\ param\: :ref:`Parameter`, curve\: :ref:`Curve`\ ) :ref:`🔗` Sets the :ref:`Curve` of the parameter specified by :ref:`Parameter`. Should be a unit :ref:`Curve`. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_set_param_max: .. rst-class:: classref-method |void| **set_param_max**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the maximum value for the given parameter. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_set_param_min: .. rst-class:: classref-method |void| **set_param_min**\ (\ param\: :ref:`Parameter`, value\: :ref:`float`\ ) :ref:`🔗` Sets the minimum value for the given parameter. .. rst-class:: classref-item-separator ---- .. _class_CPUParticles2D_method_set_particle_flag: .. rst-class:: classref-method |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags`, enable\: :ref:`bool`\ ) :ref:`🔗` Enables or disables the given particle flag. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`