godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.5
godot-docs/classes/class_cpuparticles3d.rst
Godot Organization f9f2c80955 classref: Sync with current master branch (42c7f14)
2025-06-07 03:33:02 +00:00

2011 lines
98 KiB
ReStructuredText
Raw Permalink Blame History

: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/CPUParticles3D.xml.
.. _class_CPUParticles3D:
CPUParticles3D
==============
**Inherits:** :ref:`GeometryInstance3D<class_GeometryInstance3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
A CPU-based 3D particle emitter.
.. rst-class:: classref-introduction-group
Description
-----------
CPU-based 3D particle node used to create a variety of particle systems and effects.
See also :ref:`GPUParticles3D<class_GPUParticles3D>`, which provides the same functionality with hardware acceleration, but may not run on older devices.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Particle systems (3D) <../tutorials/3d/particles/index>`
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles3D_property_amount>` | ``8`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles3D_property_angle_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`angle_max<class_CPUParticles3D_property_angle_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`angle_min<class_CPUParticles3D_property_angle_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles3D_property_angular_velocity_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity_max<class_CPUParticles3D_property_angular_velocity_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity_min<class_CPUParticles3D_property_angular_velocity_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles3D_property_anim_offset_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`anim_offset_max<class_CPUParticles3D_property_anim_offset_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`anim_offset_min<class_CPUParticles3D_property_anim_offset_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles3D_property_anim_speed_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`anim_speed_max<class_CPUParticles3D_property_anim_speed_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`anim_speed_min<class_CPUParticles3D_property_anim_speed_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles3D_property_color>` | ``Color(1, 1, 1, 1)`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`color_initial_ramp<class_CPUParticles3D_property_color_initial_ramp>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles3D_property_color_ramp>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles3D_property_damping_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`damping_max<class_CPUParticles3D_property_damping_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`damping_min<class_CPUParticles3D_property_damping_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`direction<class_CPUParticles3D_property_direction>` | ``Vector3(1, 0, 0)`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`DrawOrder<enum_CPUParticles3D_DrawOrder>` | :ref:`draw_order<class_CPUParticles3D_property_draw_order>` | ``0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles3D_property_emission_box_extents>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`emission_colors<class_CPUParticles3D_property_emission_colors>` | ``PackedColorArray()`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`emission_normals<class_CPUParticles3D_property_emission_normals>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`emission_points<class_CPUParticles3D_property_emission_points>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`emission_ring_axis<class_CPUParticles3D_property_emission_ring_axis>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`emission_ring_cone_angle<class_CPUParticles3D_property_emission_ring_cone_angle>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`emission_ring_height<class_CPUParticles3D_property_emission_ring_height>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`emission_ring_inner_radius<class_CPUParticles3D_property_emission_ring_inner_radius>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`emission_ring_radius<class_CPUParticles3D_property_emission_ring_radius>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` | :ref:`emission_shape<class_CPUParticles3D_property_emission_shape>` | ``0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles3D_property_emission_sphere_radius>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles3D_property_emitting>` | ``true`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles3D_property_explosiveness>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles3D_property_fixed_fps>` | ``0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles3D_property_flatness>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles3D_property_fract_delta>` | ``true`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles3D_property_gravity>` | ``Vector3(0, -9.8, 0)`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles3D_property_hue_variation_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`hue_variation_max<class_CPUParticles3D_property_hue_variation_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`hue_variation_min<class_CPUParticles3D_property_hue_variation_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`initial_velocity_max<class_CPUParticles3D_property_initial_velocity_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`initial_velocity_min<class_CPUParticles3D_property_initial_velocity_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles3D_property_lifetime>` | ``1.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`lifetime_randomness<class_CPUParticles3D_property_lifetime_randomness>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles3D_property_linear_accel_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`linear_accel_max<class_CPUParticles3D_property_linear_accel_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`linear_accel_min<class_CPUParticles3D_property_linear_accel_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles3D_property_local_coords>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles3D_property_mesh>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles3D_property_one_shot>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles3D_property_orbit_velocity_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`orbit_velocity_max<class_CPUParticles3D_property_orbit_velocity_max>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`orbit_velocity_min<class_CPUParticles3D_property_orbit_velocity_min>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`particle_flag_align_y<class_CPUParticles3D_property_particle_flag_align_y>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`particle_flag_disable_z<class_CPUParticles3D_property_particle_flag_disable_z>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`particle_flag_rotate_y<class_CPUParticles3D_property_particle_flag_rotate_y>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles3D_property_preprocess>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles3D_property_radial_accel_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`radial_accel_max<class_CPUParticles3D_property_radial_accel_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`radial_accel_min<class_CPUParticles3D_property_radial_accel_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles3D_property_randomness>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles3D_property_scale_amount_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`scale_amount_max<class_CPUParticles3D_property_scale_amount_max>` | ``1.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`scale_amount_min<class_CPUParticles3D_property_scale_amount_min>` | ``1.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_curve_x<class_CPUParticles3D_property_scale_curve_x>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_curve_y<class_CPUParticles3D_property_scale_curve_y>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_curve_z<class_CPUParticles3D_property_scale_curve_z>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`int<class_int>` | :ref:`seed<class_CPUParticles3D_property_seed>` | ``0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles3D_property_speed_scale>` | ``1.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`split_scale<class_CPUParticles3D_property_split_scale>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles3D_property_spread>` | ``45.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles3D_property_tangential_accel_curve>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel_max<class_CPUParticles3D_property_tangential_accel_max>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel_min<class_CPUParticles3D_property_tangential_accel_min>` | ``0.0`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`bool<class_bool>` | :ref:`use_fixed_seed<class_CPUParticles3D_property_use_fixed_seed>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
| :ref:`AABB<class_AABB>` | :ref:`visibility_aabb<class_CPUParticles3D_property_visibility_aabb>` | ``AABB(0, 0, 0, 0, 0, 0)`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_CPUParticles3D_method_capture_aabb>`\ (\ ) |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`convert_from_particles<class_CPUParticles3D_method_convert_from_particles>`\ (\ particles\: :ref:`Node<class_Node>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`get_param_curve<class_CPUParticles3D_method_get_param_curve>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_max<class_CPUParticles3D_method_get_param_max>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_min<class_CPUParticles3D_method_get_param_min>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_CPUParticles3D_method_get_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`\ ) |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`request_particles_process<class_CPUParticles3D_method_request_particles_process>`\ (\ process_time\: :ref:`float<class_float>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`restart<class_CPUParticles3D_method_restart>`\ (\ keep_seed\: :ref:`bool<class_bool>` = false\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_param_curve<class_CPUParticles3D_method_set_param_curve>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_param_max<class_CPUParticles3D_method_set_param_max>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_param_min<class_CPUParticles3D_method_set_param_min>`\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_particle_flag<class_CPUParticles3D_method_set_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ ) |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_CPUParticles3D_signal_finished:
.. rst-class:: classref-signal
**finished**\ (\ ) :ref:`🔗<class_CPUParticles3D_signal_finished>`
Emitted when all active particles have finished processing. When :ref:`one_shot<class_CPUParticles3D_property_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_CPUParticles3D_DrawOrder:
.. rst-class:: classref-enumeration
enum **DrawOrder**: :ref:`🔗<enum_CPUParticles3D_DrawOrder>`
.. _class_CPUParticles3D_constant_DRAW_ORDER_INDEX:
.. rst-class:: classref-enumeration-constant
:ref:`DrawOrder<enum_CPUParticles3D_DrawOrder>` **DRAW_ORDER_INDEX** = ``0``
Particles are drawn in the order emitted.
.. _class_CPUParticles3D_constant_DRAW_ORDER_LIFETIME:
.. rst-class:: classref-enumeration-constant
:ref:`DrawOrder<enum_CPUParticles3D_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.
.. _class_CPUParticles3D_constant_DRAW_ORDER_VIEW_DEPTH:
.. rst-class:: classref-enumeration-constant
:ref:`DrawOrder<enum_CPUParticles3D_DrawOrder>` **DRAW_ORDER_VIEW_DEPTH** = ``2``
Particles are drawn in order of depth.
.. rst-class:: classref-item-separator
----
.. _enum_CPUParticles3D_Parameter:
.. rst-class:: classref-enumeration
enum **Parameter**: :ref:`🔗<enum_CPUParticles3D_Parameter>`
.. _class_CPUParticles3D_constant_PARAM_INITIAL_LINEAR_VELOCITY:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set initial velocity properties.
.. _class_CPUParticles3D_constant_PARAM_ANGULAR_VELOCITY:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_ANGULAR_VELOCITY** = ``1``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set angular velocity properties.
.. _class_CPUParticles3D_constant_PARAM_ORBIT_VELOCITY:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_ORBIT_VELOCITY** = ``2``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set orbital velocity properties.
.. _class_CPUParticles3D_constant_PARAM_LINEAR_ACCEL:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_LINEAR_ACCEL** = ``3``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set linear acceleration properties.
.. _class_CPUParticles3D_constant_PARAM_RADIAL_ACCEL:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_RADIAL_ACCEL** = ``4``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set radial acceleration properties.
.. _class_CPUParticles3D_constant_PARAM_TANGENTIAL_ACCEL:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_TANGENTIAL_ACCEL** = ``5``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set tangential acceleration properties.
.. _class_CPUParticles3D_constant_PARAM_DAMPING:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_DAMPING** = ``6``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set damping properties.
.. _class_CPUParticles3D_constant_PARAM_ANGLE:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_ANGLE** = ``7``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set angle properties.
.. _class_CPUParticles3D_constant_PARAM_SCALE:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_SCALE** = ``8``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set scale properties.
.. _class_CPUParticles3D_constant_PARAM_HUE_VARIATION:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_HUE_VARIATION** = ``9``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set hue variation properties.
.. _class_CPUParticles3D_constant_PARAM_ANIM_SPEED:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_ANIM_SPEED** = ``10``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set animation speed properties.
.. _class_CPUParticles3D_constant_PARAM_ANIM_OFFSET:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_ANIM_OFFSET** = ``11``
Use with :ref:`set_param_min()<class_CPUParticles3D_method_set_param_min>`, :ref:`set_param_max()<class_CPUParticles3D_method_set_param_max>`, and :ref:`set_param_curve()<class_CPUParticles3D_method_set_param_curve>` to set animation offset properties.
.. _class_CPUParticles3D_constant_PARAM_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`Parameter<enum_CPUParticles3D_Parameter>` **PARAM_MAX** = ``12``
Represents the size of the :ref:`Parameter<enum_CPUParticles3D_Parameter>` enum.
.. rst-class:: classref-item-separator
----
.. _enum_CPUParticles3D_ParticleFlags:
.. rst-class:: classref-enumeration
enum **ParticleFlags**: :ref:`🔗<enum_CPUParticles3D_ParticleFlags>`
.. _class_CPUParticles3D_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY:
.. rst-class:: classref-enumeration-constant
:ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>` **PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY** = ``0``
Use with :ref:`set_particle_flag()<class_CPUParticles3D_method_set_particle_flag>` to set :ref:`particle_flag_align_y<class_CPUParticles3D_property_particle_flag_align_y>`.
.. _class_CPUParticles3D_constant_PARTICLE_FLAG_ROTATE_Y:
.. rst-class:: classref-enumeration-constant
:ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>` **PARTICLE_FLAG_ROTATE_Y** = ``1``
Use with :ref:`set_particle_flag()<class_CPUParticles3D_method_set_particle_flag>` to set :ref:`particle_flag_rotate_y<class_CPUParticles3D_property_particle_flag_rotate_y>`.
.. _class_CPUParticles3D_constant_PARTICLE_FLAG_DISABLE_Z:
.. rst-class:: classref-enumeration-constant
:ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>` **PARTICLE_FLAG_DISABLE_Z** = ``2``
Use with :ref:`set_particle_flag()<class_CPUParticles3D_method_set_particle_flag>` to set :ref:`particle_flag_disable_z<class_CPUParticles3D_property_particle_flag_disable_z>`.
.. _class_CPUParticles3D_constant_PARTICLE_FLAG_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>` **PARTICLE_FLAG_MAX** = ``3``
Represents the size of the :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>` enum.
.. rst-class:: classref-item-separator
----
.. _enum_CPUParticles3D_EmissionShape:
.. rst-class:: classref-enumeration
enum **EmissionShape**: :ref:`🔗<enum_CPUParticles3D_EmissionShape>`
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_POINT:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_POINT** = ``0``
All particles will be emitted from a single point.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_SPHERE:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_SPHERE** = ``1``
Particles will be emitted in the volume of a sphere.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_SPHERE_SURFACE:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_SPHERE_SURFACE** = ``2``
Particles will be emitted on the surface of a sphere.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_BOX:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_BOX** = ``3``
Particles will be emitted in the volume of a box.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_POINTS:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_POINTS** = ``4``
Particles will be emitted at a position chosen randomly among :ref:`emission_points<class_CPUParticles3D_property_emission_points>`. Particle color will be modulated by :ref:`emission_colors<class_CPUParticles3D_property_emission_colors>`.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_DIRECTED_POINTS:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_DIRECTED_POINTS** = ``5``
Particles will be emitted at a position chosen randomly among :ref:`emission_points<class_CPUParticles3D_property_emission_points>`. Particle velocity and rotation will be set based on :ref:`emission_normals<class_CPUParticles3D_property_emission_normals>`. Particle color will be modulated by :ref:`emission_colors<class_CPUParticles3D_property_emission_colors>`.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_RING:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_RING** = ``6``
Particles will be emitted in a ring or cylinder.
.. _class_CPUParticles3D_constant_EMISSION_SHAPE_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **EMISSION_SHAPE_MAX** = ``7``
Represents the size of the :ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` enum.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_CPUParticles3D_property_amount:
.. rst-class:: classref-property
:ref:`int<class_int>` **amount** = ``8`` :ref:`🔗<class_CPUParticles3D_property_amount>`
.. rst-class:: classref-property-setget
- |void| **set_amount**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_amount**\ (\ )
Number of particles emitted in one emission cycle.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_angle_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **angle_curve** :ref:`🔗<class_CPUParticles3D_property_angle_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_angle_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **angle_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_angle_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum angle.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_angle_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **angle_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_angle_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum angle.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_angular_velocity_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **angular_velocity_curve** :ref:`🔗<class_CPUParticles3D_property_angular_velocity_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's angular velocity (rotation speed) will vary along this :ref:`Curve<class_Curve>` over its lifetime. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_angular_velocity_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **angular_velocity_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_angular_velocity_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_angular_velocity_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **angular_velocity_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_angular_velocity_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum initial angular velocity (rotation speed) applied to each particle in *degrees* per second.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_anim_offset_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **anim_offset_curve** :ref:`🔗<class_CPUParticles3D_property_anim_offset_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_anim_offset_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **anim_offset_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_anim_offset_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum animation offset.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_anim_offset_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **anim_offset_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_anim_offset_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum animation offset.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_anim_speed_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **anim_speed_curve** :ref:`🔗<class_CPUParticles3D_property_anim_speed_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_anim_speed_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **anim_speed_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_anim_speed_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum particle animation speed.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_anim_speed_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **anim_speed_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_anim_speed_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum particle animation speed.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_CPUParticles3D_property_color>`
.. rst-class:: classref-property-setget
- |void| **set_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_color**\ (\ )
Each particle's initial color.
\ **Note:** :ref:`color<class_CPUParticles3D_property_color>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color<class_CPUParticles3D_property_color>` will have no visible effect.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_color_initial_ramp:
.. rst-class:: classref-property
:ref:`Gradient<class_Gradient>` **color_initial_ramp** :ref:`🔗<class_CPUParticles3D_property_color_initial_ramp>`
.. rst-class:: classref-property-setget
- |void| **set_color_initial_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
- :ref:`Gradient<class_Gradient>` **get_color_initial_ramp**\ (\ )
Each particle's initial color will vary along this :ref:`Gradient<class_Gradient>` (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
\ **Note:** :ref:`color_initial_ramp<class_CPUParticles3D_property_color_initial_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp<class_CPUParticles3D_property_color_initial_ramp>` will have no visible effect.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_color_ramp:
.. rst-class:: classref-property
:ref:`Gradient<class_Gradient>` **color_ramp** :ref:`🔗<class_CPUParticles3D_property_color_ramp>`
.. rst-class:: classref-property-setget
- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
- :ref:`Gradient<class_Gradient>` **get_color_ramp**\ (\ )
Each particle's color will vary along this :ref:`Gradient<class_Gradient>` over its lifetime (multiplied with :ref:`color<class_CPUParticles3D_property_color>`).
\ **Note:** :ref:`color_ramp<class_CPUParticles3D_property_color_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp<class_CPUParticles3D_property_color_ramp>` will have no visible effect.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_damping_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **damping_curve** :ref:`🔗<class_CPUParticles3D_property_damping_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Damping will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_damping_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **damping_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_damping_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum damping.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_damping_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **damping_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_damping_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum damping.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_direction:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **direction** = ``Vector3(1, 0, 0)`` :ref:`🔗<class_CPUParticles3D_property_direction>`
.. rst-class:: classref-property-setget
- |void| **set_direction**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_direction**\ (\ )
Unit vector specifying the particles' emission direction.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_draw_order:
.. rst-class:: classref-property
:ref:`DrawOrder<enum_CPUParticles3D_DrawOrder>` **draw_order** = ``0`` :ref:`🔗<class_CPUParticles3D_property_draw_order>`
.. rst-class:: classref-property-setget
- |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder<enum_CPUParticles3D_DrawOrder>`\ )
- :ref:`DrawOrder<enum_CPUParticles3D_DrawOrder>` **get_draw_order**\ (\ )
Particle draw order.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_box_extents:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **emission_box_extents** :ref:`🔗<class_CPUParticles3D_property_emission_box_extents>`
.. rst-class:: classref-property-setget
- |void| **set_emission_box_extents**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_emission_box_extents**\ (\ )
The rectangle's extents if :ref:`emission_shape<class_CPUParticles3D_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_CPUParticles3D_constant_EMISSION_SHAPE_BOX>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_colors:
.. rst-class:: classref-property
:ref:`PackedColorArray<class_PackedColorArray>` **emission_colors** = ``PackedColorArray()`` :ref:`🔗<class_CPUParticles3D_property_emission_colors>`
.. rst-class:: classref-property-setget
- |void| **set_emission_colors**\ (\ value\: :ref:`PackedColorArray<class_PackedColorArray>`\ )
- :ref:`PackedColorArray<class_PackedColorArray>` **get_emission_colors**\ (\ )
Sets the :ref:`Color<class_Color>`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS<class_CPUParticles3D_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles3D_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
\ **Note:** :ref:`emission_colors<class_CPUParticles3D_property_emission_colors>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_colors<class_CPUParticles3D_property_emission_colors>` will have no visible effect.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedColorArray<class_PackedColorArray>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_normals:
.. rst-class:: classref-property
:ref:`PackedVector3Array<class_PackedVector3Array>` **emission_normals** :ref:`🔗<class_CPUParticles3D_property_emission_normals>`
.. rst-class:: classref-property-setget
- |void| **set_emission_normals**\ (\ value\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ )
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_emission_normals**\ (\ )
Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles3D_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector3Array<class_PackedVector3Array>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_points:
.. rst-class:: classref-property
:ref:`PackedVector3Array<class_PackedVector3Array>` **emission_points** :ref:`🔗<class_CPUParticles3D_property_emission_points>`
.. rst-class:: classref-property-setget
- |void| **set_emission_points**\ (\ value\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ )
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_emission_points**\ (\ )
Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS<class_CPUParticles3D_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles3D_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedVector3Array<class_PackedVector3Array>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_ring_axis:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **emission_ring_axis** :ref:`🔗<class_CPUParticles3D_property_emission_ring_axis>`
.. rst-class:: classref-property-setget
- |void| **set_emission_ring_axis**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_emission_ring_axis**\ (\ )
The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_CPUParticles3D_constant_EMISSION_SHAPE_RING>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_ring_cone_angle:
.. rst-class:: classref-property
:ref:`float<class_float>` **emission_ring_cone_angle** :ref:`🔗<class_CPUParticles3D_property_emission_ring_cone_angle>`
.. rst-class:: classref-property-setget
- |void| **set_emission_ring_cone_angle**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_emission_ring_cone_angle**\ (\ )
The angle of the cone when using the emitter :ref:`EMISSION_SHAPE_RING<class_CPUParticles3D_constant_EMISSION_SHAPE_RING>`. The default angle of 90 degrees results in a ring, while an angle of 0 degrees results in a cone. Intermediate values will result in a ring where one end is larger than the other.
\ **Note:** Depending on :ref:`emission_ring_height<class_CPUParticles3D_property_emission_ring_height>`, the angle may be clamped if the ring's end is reached to form a perfect cone.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_ring_height:
.. rst-class:: classref-property
:ref:`float<class_float>` **emission_ring_height** :ref:`🔗<class_CPUParticles3D_property_emission_ring_height>`
.. rst-class:: classref-property-setget
- |void| **set_emission_ring_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_emission_ring_height**\ (\ )
The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_CPUParticles3D_constant_EMISSION_SHAPE_RING>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_ring_inner_radius:
.. rst-class:: classref-property
:ref:`float<class_float>` **emission_ring_inner_radius** :ref:`🔗<class_CPUParticles3D_property_emission_ring_inner_radius>`
.. rst-class:: classref-property-setget
- |void| **set_emission_ring_inner_radius**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_emission_ring_inner_radius**\ (\ )
The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_CPUParticles3D_constant_EMISSION_SHAPE_RING>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_ring_radius:
.. rst-class:: classref-property
:ref:`float<class_float>` **emission_ring_radius** :ref:`🔗<class_CPUParticles3D_property_emission_ring_radius>`
.. rst-class:: classref-property-setget
- |void| **set_emission_ring_radius**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_emission_ring_radius**\ (\ )
The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_CPUParticles3D_constant_EMISSION_SHAPE_RING>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_shape:
.. rst-class:: classref-property
:ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **emission_shape** = ``0`` :ref:`🔗<class_CPUParticles3D_property_emission_shape>`
.. rst-class:: classref-property-setget
- |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>`\ )
- :ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` **get_emission_shape**\ (\ )
Particles will be emitted inside this region.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emission_sphere_radius:
.. rst-class:: classref-property
:ref:`float<class_float>` **emission_sphere_radius** :ref:`🔗<class_CPUParticles3D_property_emission_sphere_radius>`
.. rst-class:: classref-property-setget
- |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_emission_sphere_radius**\ (\ )
The sphere's radius if :ref:`EmissionShape<enum_CPUParticles3D_EmissionShape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_CPUParticles3D_constant_EMISSION_SHAPE_SPHERE>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_emitting:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **emitting** = ``true`` :ref:`🔗<class_CPUParticles3D_property_emitting>`
.. rst-class:: classref-property-setget
- |void| **set_emitting**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_emitting**\ (\ )
If ``true``, particles are being emitted. :ref:`emitting<class_CPUParticles3D_property_emitting>` can be used to start and stop particles from emitting. However, if :ref:`one_shot<class_CPUParticles3D_property_one_shot>` is ``true`` setting :ref:`emitting<class_CPUParticles3D_property_emitting>` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished<class_CPUParticles3D_signal_finished>` signal to be notified once all active particles finish processing.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_explosiveness:
.. rst-class:: classref-property
:ref:`float<class_float>` **explosiveness** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_explosiveness>`
.. rst-class:: classref-property-setget
- |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_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_CPUParticles3D_property_fixed_fps:
.. rst-class:: classref-property
:ref:`int<class_int>` **fixed_fps** = ``0`` :ref:`🔗<class_CPUParticles3D_property_fixed_fps>`
.. rst-class:: classref-property-setget
- |void| **set_fixed_fps**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_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 particle system itself.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_flatness:
.. rst-class:: classref-property
:ref:`float<class_float>` **flatness** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_flatness>`
.. rst-class:: classref-property-setget
- |void| **set_flatness**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_flatness**\ (\ )
Amount of :ref:`spread<class_CPUParticles3D_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_fract_delta:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **fract_delta** = ``true`` :ref:`🔗<class_CPUParticles3D_property_fract_delta>`
.. rst-class:: classref-property-setget
- |void| **set_fractional_delta**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_fractional_delta**\ (\ )
If ``true``, results in fractional delta calculation which has a smoother particles display effect.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_gravity:
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **gravity** = ``Vector3(0, -9.8, 0)`` :ref:`🔗<class_CPUParticles3D_property_gravity>`
.. rst-class:: classref-property-setget
- |void| **set_gravity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- :ref:`Vector3<class_Vector3>` **get_gravity**\ (\ )
Gravity applied to every particle.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_hue_variation_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **hue_variation_curve** :ref:`🔗<class_CPUParticles3D_property_hue_variation_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's hue will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_hue_variation_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **hue_variation_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_hue_variation_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum hue variation.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_hue_variation_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **hue_variation_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_hue_variation_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum hue variation.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_initial_velocity_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **initial_velocity_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_initial_velocity_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum value of the initial velocity.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_initial_velocity_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **initial_velocity_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_initial_velocity_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum value of the initial velocity.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_lifetime:
.. rst-class:: classref-property
:ref:`float<class_float>` **lifetime** = ``1.0`` :ref:`🔗<class_CPUParticles3D_property_lifetime>`
.. rst-class:: classref-property-setget
- |void| **set_lifetime**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_lifetime**\ (\ )
Amount of time each particle will exist.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_lifetime_randomness:
.. rst-class:: classref-property
:ref:`float<class_float>` **lifetime_randomness** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_lifetime_randomness>`
.. rst-class:: classref-property-setget
- |void| **set_lifetime_randomness**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_lifetime_randomness**\ (\ )
Particle lifetime randomness ratio.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_linear_accel_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **linear_accel_curve** :ref:`🔗<class_CPUParticles3D_property_linear_accel_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_linear_accel_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **linear_accel_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_linear_accel_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum linear acceleration.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_linear_accel_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **linear_accel_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_linear_accel_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum linear acceleration.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_local_coords:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **local_coords** = ``false`` :ref:`🔗<class_CPUParticles3D_property_local_coords>`
.. rst-class:: classref-property-setget
- |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_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 **CPUParticles3D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **CPUParticles3D** node (and its parents) when it is moved or rotated.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_mesh:
.. rst-class:: classref-property
:ref:`Mesh<class_Mesh>` **mesh** :ref:`🔗<class_CPUParticles3D_property_mesh>`
.. rst-class:: classref-property-setget
- |void| **set_mesh**\ (\ value\: :ref:`Mesh<class_Mesh>`\ )
- :ref:`Mesh<class_Mesh>` **get_mesh**\ (\ )
The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will be spheres.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_one_shot:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **one_shot** = ``false`` :ref:`🔗<class_CPUParticles3D_property_one_shot>`
.. rst-class:: classref-property-setget
- |void| **set_one_shot**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_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_CPUParticles3D_property_orbit_velocity_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **orbit_velocity_curve** :ref:`🔗<class_CPUParticles3D_property_orbit_velocity_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's orbital velocity will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_orbit_velocity_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **orbit_velocity_max** :ref:`🔗<class_CPUParticles3D_property_orbit_velocity_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum orbit velocity.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_orbit_velocity_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **orbit_velocity_min** :ref:`🔗<class_CPUParticles3D_property_orbit_velocity_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum orbit velocity.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_particle_flag_align_y:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **particle_flag_align_y** = ``false`` :ref:`🔗<class_CPUParticles3D_property_particle_flag_align_y>`
.. rst-class:: classref-property-setget
- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`\ ) |const|
Align Y axis of particle with the direction of its velocity.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_particle_flag_disable_z:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **particle_flag_disable_z** = ``false`` :ref:`🔗<class_CPUParticles3D_property_particle_flag_disable_z>`
.. rst-class:: classref-property-setget
- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`\ ) |const|
If ``true``, particles will not move on the Z axis.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_particle_flag_rotate_y:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **particle_flag_rotate_y** = ``false`` :ref:`🔗<class_CPUParticles3D_property_particle_flag_rotate_y>`
.. rst-class:: classref-property-setget
- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`\ ) |const|
If ``true``, particles rotate around Y axis by :ref:`angle_min<class_CPUParticles3D_property_angle_min>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_preprocess:
.. rst-class:: classref-property
:ref:`float<class_float>` **preprocess** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_preprocess>`
.. rst-class:: classref-property-setget
- |void| **set_pre_process_time**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_pre_process_time**\ (\ )
Particle system starts as if it had already run for this many seconds.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_radial_accel_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **radial_accel_curve** :ref:`🔗<class_CPUParticles3D_property_radial_accel_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_radial_accel_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **radial_accel_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_radial_accel_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum radial acceleration.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_radial_accel_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **radial_accel_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_radial_accel_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum radial acceleration.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_randomness:
.. rst-class:: classref-property
:ref:`float<class_float>` **randomness** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_randomness>`
.. rst-class:: classref-property-setget
- |void| **set_randomness_ratio**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_randomness_ratio**\ (\ )
Emission lifetime randomness ratio.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_scale_amount_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **scale_amount_curve** :ref:`🔗<class_CPUParticles3D_property_scale_amount_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's scale will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_scale_amount_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **scale_amount_max** = ``1.0`` :ref:`🔗<class_CPUParticles3D_property_scale_amount_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum scale.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_scale_amount_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **scale_amount_min** = ``1.0`` :ref:`🔗<class_CPUParticles3D_property_scale_amount_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum scale.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_scale_curve_x:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **scale_curve_x** :ref:`🔗<class_CPUParticles3D_property_scale_curve_x>`
.. rst-class:: classref-property-setget
- |void| **set_scale_curve_x**\ (\ value\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_scale_curve_x**\ (\ )
Curve for the scale over life, along the x axis.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_scale_curve_y:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **scale_curve_y** :ref:`🔗<class_CPUParticles3D_property_scale_curve_y>`
.. rst-class:: classref-property-setget
- |void| **set_scale_curve_y**\ (\ value\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_scale_curve_y**\ (\ )
Curve for the scale over life, along the y axis.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_scale_curve_z:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **scale_curve_z** :ref:`🔗<class_CPUParticles3D_property_scale_curve_z>`
.. rst-class:: classref-property-setget
- |void| **set_scale_curve_z**\ (\ value\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_scale_curve_z**\ (\ )
Curve for the scale over life, along the z axis.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_seed:
.. rst-class:: classref-property
:ref:`int<class_int>` **seed** = ``0`` :ref:`🔗<class_CPUParticles3D_property_seed>`
.. rst-class:: classref-property-setget
- |void| **set_seed**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_seed**\ (\ )
Sets the random seed used by the particle system. Only effective if :ref:`use_fixed_seed<class_CPUParticles3D_property_use_fixed_seed>` is ``true``.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_speed_scale:
.. rst-class:: classref-property
:ref:`float<class_float>` **speed_scale** = ``1.0`` :ref:`🔗<class_CPUParticles3D_property_speed_scale>`
.. rst-class:: classref-property-setget
- |void| **set_speed_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_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_CPUParticles3D_property_split_scale:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **split_scale** = ``false`` :ref:`🔗<class_CPUParticles3D_property_split_scale>`
.. rst-class:: classref-property-setget
- |void| **set_split_scale**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_split_scale**\ (\ )
If set to ``true``, three different scale curves can be specified, one per scale axis.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_spread:
.. rst-class:: classref-property
:ref:`float<class_float>` **spread** = ``45.0`` :ref:`🔗<class_CPUParticles3D_property_spread>`
.. rst-class:: classref-property-setget
- |void| **set_spread**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_spread**\ (\ )
Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Applied to X/Z plane and Y/Z planes.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_tangential_accel_curve:
.. rst-class:: classref-property
:ref:`Curve<class_Curve>` **tangential_accel_curve** :ref:`🔗<class_CPUParticles3D_property_tangential_accel_curve>`
.. rst-class:: classref-property-setget
- |void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ )
- :ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_tangential_accel_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **tangential_accel_max** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_tangential_accel_max>`
.. rst-class:: classref-property-setget
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Maximum tangent acceleration.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_tangential_accel_min:
.. rst-class:: classref-property
:ref:`float<class_float>` **tangential_accel_min** = ``0.0`` :ref:`🔗<class_CPUParticles3D_property_tangential_accel_min>`
.. rst-class:: classref-property-setget
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const|
Minimum tangent acceleration.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_property_use_fixed_seed:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_fixed_seed** = ``false`` :ref:`🔗<class_CPUParticles3D_property_use_fixed_seed>`
.. rst-class:: classref-property-setget
- |void| **set_use_fixed_seed**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_use_fixed_seed**\ (\ )
If ``true``, particles will use the same seed for every simulation using the seed defined in :ref:`seed<class_CPUParticles3D_property_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-item-separator
----
.. _class_CPUParticles3D_property_visibility_aabb:
.. rst-class:: classref-property
:ref:`AABB<class_AABB>` **visibility_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` :ref:`🔗<class_CPUParticles3D_property_visibility_aabb>`
.. rst-class:: classref-property-setget
- |void| **set_visibility_aabb**\ (\ value\: :ref:`AABB<class_AABB>`\ )
- :ref:`AABB<class_AABB>` **get_visibility_aabb**\ (\ )
The :ref:`AABB<class_AABB>` that determines the node's region which needs to be visible on screen for the particle system to be active.
Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The :ref:`AABB<class_AABB>` can be grown via code or with the **Particles → Generate AABB** editor tool.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_CPUParticles3D_method_capture_aabb:
.. rst-class:: classref-method
:ref:`AABB<class_AABB>` **capture_aabb**\ (\ ) |const| :ref:`🔗<class_CPUParticles3D_method_capture_aabb>`
Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_convert_from_particles:
.. rst-class:: classref-method
|void| **convert_from_particles**\ (\ particles\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_CPUParticles3D_method_convert_from_particles>`
Sets this node's properties to match a given :ref:`GPUParticles3D<class_GPUParticles3D>` node with an assigned :ref:`ParticleProcessMaterial<class_ParticleProcessMaterial>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_get_param_curve:
.. rst-class:: classref-method
:ref:`Curve<class_Curve>` **get_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const| :ref:`🔗<class_CPUParticles3D_method_get_param_curve>`
Returns the :ref:`Curve<class_Curve>` of the parameter specified by :ref:`Parameter<enum_CPUParticles3D_Parameter>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_get_param_max:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const| :ref:`🔗<class_CPUParticles3D_method_get_param_max>`
Returns the maximum value range for the given parameter.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_get_param_min:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`\ ) |const| :ref:`🔗<class_CPUParticles3D_method_get_param_min>`
Returns the minimum value range for the given parameter.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_get_particle_flag:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`\ ) |const| :ref:`🔗<class_CPUParticles3D_method_get_particle_flag>`
Returns the enabled state of the given particle flag.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_request_particles_process:
.. rst-class:: classref-method
|void| **request_particles_process**\ (\ process_time\: :ref:`float<class_float>`\ ) :ref:`🔗<class_CPUParticles3D_method_request_particles_process>`
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<class_CPUParticles3D_property_use_fixed_seed>` or by calling :ref:`restart()<class_CPUParticles3D_method_restart>` with parameter ``keep_seed`` set to ``true``.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_restart:
.. rst-class:: classref-method
|void| **restart**\ (\ keep_seed\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CPUParticles3D_method_restart>`
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_CPUParticles3D_method_set_param_curve:
.. rst-class:: classref-method
|void| **set_param_curve**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, curve\: :ref:`Curve<class_Curve>`\ ) :ref:`🔗<class_CPUParticles3D_method_set_param_curve>`
Sets the :ref:`Curve<class_Curve>` of the parameter specified by :ref:`Parameter<enum_CPUParticles3D_Parameter>`. Should be a unit :ref:`Curve<class_Curve>`.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_set_param_max:
.. rst-class:: classref-method
|void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_CPUParticles3D_method_set_param_max>`
Sets the maximum value for the given parameter.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_set_param_min:
.. rst-class:: classref-method
|void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_CPUParticles3D_Parameter>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_CPUParticles3D_method_set_param_min>`
Sets the minimum value for the given parameter.
.. rst-class:: classref-item-separator
----
.. _class_CPUParticles3D_method_set_particle_flag:
.. rst-class:: classref-method
|void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_CPUParticles3D_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CPUParticles3D_method_set_particle_flag>`
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.)`
Reference in New Issue View Git Blame Copy Permalink