|
@@ -14,7 +14,7 @@ CPUParticles
|
|
Brief Description
|
|
Brief Description
|
|
-----------------
|
|
-----------------
|
|
|
|
|
|
-
|
|
|
|
|
|
+CPU-based 3D particle emitter.
|
|
|
|
|
|
Properties
|
|
Properties
|
|
----------
|
|
----------
|
|
@@ -112,6 +112,12 @@ Properties
|
|
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` |
|
|
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_property_one_shot>` |
|
|
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`orbit_velocity<class_CPUParticles_property_orbit_velocity>` |
|
|
|
|
++-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`Curve<class_Curve>` | :ref:`orbit_velocity_curve<class_CPUParticles_property_orbit_velocity_curve>` |
|
|
|
|
++-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`orbit_velocity_random<class_CPUParticles_property_orbit_velocity_random>` |
|
|
|
|
++-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` |
|
|
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_property_preprocess>` |
|
|
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
+-------------------------------------------------------+-------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_property_radial_accel>` |
|
|
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_property_radial_accel>` |
|
|
@@ -161,11 +167,11 @@ Enumerations
|
|
|
|
|
|
enum **DrawOrder**:
|
|
enum **DrawOrder**:
|
|
|
|
|
|
-- **DRAW_ORDER_INDEX** = **0**
|
|
|
|
|
|
+- **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted.
|
|
|
|
|
|
-- **DRAW_ORDER_LIFETIME** = **1**
|
|
|
|
|
|
+- **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime.
|
|
|
|
|
|
-- **DRAW_ORDER_VIEW_DEPTH** = **2**
|
|
|
|
|
|
+- **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth.
|
|
|
|
|
|
.. _enum_CPUParticles_Parameter:
|
|
.. _enum_CPUParticles_Parameter:
|
|
|
|
|
|
@@ -173,6 +179,8 @@ enum **DrawOrder**:
|
|
|
|
|
|
.. _class_CPUParticles_constant_PARAM_ANGULAR_VELOCITY:
|
|
.. _class_CPUParticles_constant_PARAM_ANGULAR_VELOCITY:
|
|
|
|
|
|
|
|
+.. _class_CPUParticles_constant_PARAM_ORBIT_VELOCITY:
|
|
|
|
+
|
|
.. _class_CPUParticles_constant_PARAM_LINEAR_ACCEL:
|
|
.. _class_CPUParticles_constant_PARAM_LINEAR_ACCEL:
|
|
|
|
|
|
.. _class_CPUParticles_constant_PARAM_RADIAL_ACCEL:
|
|
.. _class_CPUParticles_constant_PARAM_RADIAL_ACCEL:
|
|
@@ -195,29 +203,31 @@ enum **DrawOrder**:
|
|
|
|
|
|
enum **Parameter**:
|
|
enum **Parameter**:
|
|
|
|
|
|
-- **PARAM_INITIAL_LINEAR_VELOCITY** = **0**
|
|
|
|
|
|
+- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set initial velocity properties.
|
|
|
|
+
|
|
|
|
+- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set angular velocity properties.
|
|
|
|
|
|
-- **PARAM_ANGULAR_VELOCITY** = **1**
|
|
|
|
|
|
+- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set orbital velocity properties.
|
|
|
|
|
|
-- **PARAM_LINEAR_ACCEL** = **2**
|
|
|
|
|
|
+- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set linear acceleration properties.
|
|
|
|
|
|
-- **PARAM_RADIAL_ACCEL** = **3**
|
|
|
|
|
|
+- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set radial acceleration properties.
|
|
|
|
|
|
-- **PARAM_TANGENTIAL_ACCEL** = **4**
|
|
|
|
|
|
+- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set tangential acceleration properties.
|
|
|
|
|
|
-- **PARAM_DAMPING** = **5**
|
|
|
|
|
|
+- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set damping properties.
|
|
|
|
|
|
-- **PARAM_ANGLE** = **6**
|
|
|
|
|
|
+- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set angle properties.
|
|
|
|
|
|
-- **PARAM_SCALE** = **7**
|
|
|
|
|
|
+- **PARAM_SCALE** = **8** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set scale properties.
|
|
|
|
|
|
-- **PARAM_HUE_VARIATION** = **8**
|
|
|
|
|
|
+- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set hue variation properties.
|
|
|
|
|
|
-- **PARAM_ANIM_SPEED** = **9**
|
|
|
|
|
|
+- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set animation speed properties.
|
|
|
|
|
|
-- **PARAM_ANIM_OFFSET** = **10**
|
|
|
|
|
|
+- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param<class_CPUParticles_method_set_param>`, :ref:`set_param_randomness<class_CPUParticles_method_set_param_randomness>`, and :ref:`set_param_texture<class_CPUParticles_method_set_param_texture>` to set animation offset properties.
|
|
|
|
|
|
-- **PARAM_MAX** = **11**
|
|
|
|
|
|
+- **PARAM_MAX** = **12** --- Represents the size of the :ref:`Parameter<enum_CPUParticles_Parameter>` enum.
|
|
|
|
|
|
.. _enum_CPUParticles_Flags:
|
|
.. _enum_CPUParticles_Flags:
|
|
|
|
|
|
@@ -225,15 +235,19 @@ enum **Parameter**:
|
|
|
|
|
|
.. _class_CPUParticles_constant_FLAG_ROTATE_Y:
|
|
.. _class_CPUParticles_constant_FLAG_ROTATE_Y:
|
|
|
|
|
|
|
|
+.. _class_CPUParticles_constant_FLAG_DISABLE_Z:
|
|
|
|
+
|
|
.. _class_CPUParticles_constant_FLAG_MAX:
|
|
.. _class_CPUParticles_constant_FLAG_MAX:
|
|
|
|
|
|
enum **Flags**:
|
|
enum **Flags**:
|
|
|
|
|
|
-- **FLAG_ALIGN_Y_TO_VELOCITY** = **0**
|
|
|
|
|
|
+- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_align_y<class_CPUParticles_property_flag_align_y>`.
|
|
|
|
+
|
|
|
|
+- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_rotate_y<class_CPUParticles_property_flag_rotate_y>`.
|
|
|
|
|
|
-- **FLAG_ROTATE_Y** = **1**
|
|
|
|
|
|
+- **FLAG_DISABLE_Z** = **2** --- Use with :ref:`set_flag<class_CPUParticles_method_set_flag>` to set :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>`.
|
|
|
|
|
|
-- **FLAG_MAX** = **3**
|
|
|
|
|
|
+- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags<enum_CPUParticles_Flags>` enum.
|
|
|
|
|
|
.. _enum_CPUParticles_EmissionShape:
|
|
.. _enum_CPUParticles_EmissionShape:
|
|
|
|
|
|
@@ -249,15 +263,22 @@ enum **Flags**:
|
|
|
|
|
|
enum **EmissionShape**:
|
|
enum **EmissionShape**:
|
|
|
|
|
|
-- **EMISSION_SHAPE_POINT** = **0**
|
|
|
|
|
|
+- **EMISSION_SHAPE_POINT** = **0** --- All particles will be emitted from a single point.
|
|
|
|
+
|
|
|
|
+- **EMISSION_SHAPE_SPHERE** = **1** --- Particles will be emitted in the volume of a sphere.
|
|
|
|
|
|
-- **EMISSION_SHAPE_SPHERE** = **1**
|
|
|
|
|
|
+- **EMISSION_SHAPE_BOX** = **2** --- Particles will be emitted in the volume of a box.
|
|
|
|
|
|
-- **EMISSION_SHAPE_BOX** = **2**
|
|
|
|
|
|
+- **EMISSION_SHAPE_POINTS** = **3** --- Particles will be emitted at a position chosen randomly among :ref:`emission_points<class_CPUParticles_property_emission_points>`. Particle color will be modulated by :ref:`emission_colors<class_CPUParticles_property_emission_colors>`.
|
|
|
|
|
|
-- **EMISSION_SHAPE_POINTS** = **3**
|
|
|
|
|
|
+- **EMISSION_SHAPE_DIRECTED_POINTS** = **4** --- Particles will be emitted at a position chosen randomly among :ref:`emission_points<class_CPUParticles_property_emission_points>`. Particle velocity and rotation will be set based on :ref:`emission_normals<class_CPUParticles_property_emission_normals>`. Particle color will be modulated by :ref:`emission_colors<class_CPUParticles_property_emission_colors>`.
|
|
|
|
|
|
-- **EMISSION_SHAPE_DIRECTED_POINTS** = **4**
|
|
|
|
|
|
+Description
|
|
|
|
+-----------
|
|
|
|
+
|
|
|
|
+CPU-based 3D particle node used to create a variety of particle systems and effects.
|
|
|
|
+
|
|
|
|
+See also :ref:`Particles<class_Particles>`, which provides the same functionality with hardware acceleration, but may not run on older devices.
|
|
|
|
|
|
Property Descriptions
|
|
Property Descriptions
|
|
---------------------
|
|
---------------------
|
|
@@ -272,6 +293,8 @@ Property Descriptions
|
|
| *Getter* | get_amount() |
|
|
| *Getter* | get_amount() |
|
|
+----------+-------------------+
|
|
+----------+-------------------+
|
|
|
|
|
|
|
|
+Number of particles emitted in one emission cycle.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_angle:
|
|
.. _class_CPUParticles_property_angle:
|
|
|
|
|
|
- :ref:`float<class_float>` **angle**
|
|
- :ref:`float<class_float>` **angle**
|
|
@@ -282,6 +305,8 @@ Property Descriptions
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Initial rotation applied to each particle, in degrees.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_angle_curve:
|
|
.. _class_CPUParticles_property_angle_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **angle_curve**
|
|
- :ref:`Curve<class_Curve>` **angle_curve**
|
|
@@ -292,6 +317,8 @@ Property Descriptions
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's rotation will be animated along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_angle_random:
|
|
.. _class_CPUParticles_property_angle_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **angle_random**
|
|
- :ref:`float<class_float>` **angle_random**
|
|
@@ -302,6 +329,8 @@ Property Descriptions
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Rotation randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_angular_velocity:
|
|
.. _class_CPUParticles_property_angular_velocity:
|
|
|
|
|
|
- :ref:`float<class_float>` **angular_velocity**
|
|
- :ref:`float<class_float>` **angular_velocity**
|
|
@@ -312,6 +341,8 @@ Property Descriptions
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_angular_velocity_curve:
|
|
.. _class_CPUParticles_property_angular_velocity_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **angular_velocity_curve**
|
|
- :ref:`Curve<class_Curve>` **angular_velocity_curve**
|
|
@@ -322,6 +353,8 @@ Property Descriptions
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's angular velocity will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_angular_velocity_random:
|
|
.. _class_CPUParticles_property_angular_velocity_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **angular_velocity_random**
|
|
- :ref:`float<class_float>` **angular_velocity_random**
|
|
@@ -332,6 +365,8 @@ Property Descriptions
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Angular velocity randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_anim_offset:
|
|
.. _class_CPUParticles_property_anim_offset:
|
|
|
|
|
|
- :ref:`float<class_float>` **anim_offset**
|
|
- :ref:`float<class_float>` **anim_offset**
|
|
@@ -342,6 +377,8 @@ Property Descriptions
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Particle animation offset.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_anim_offset_curve:
|
|
.. _class_CPUParticles_property_anim_offset_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **anim_offset_curve**
|
|
- :ref:`Curve<class_Curve>` **anim_offset_curve**
|
|
@@ -352,6 +389,8 @@ Property Descriptions
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's animation offset will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_anim_offset_random:
|
|
.. _class_CPUParticles_property_anim_offset_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **anim_offset_random**
|
|
- :ref:`float<class_float>` **anim_offset_random**
|
|
@@ -362,6 +401,8 @@ Property Descriptions
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Animation offset randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_anim_speed:
|
|
.. _class_CPUParticles_property_anim_speed:
|
|
|
|
|
|
- :ref:`float<class_float>` **anim_speed**
|
|
- :ref:`float<class_float>` **anim_speed**
|
|
@@ -372,6 +413,8 @@ Property Descriptions
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Particle animation speed.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_anim_speed_curve:
|
|
.. _class_CPUParticles_property_anim_speed_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **anim_speed_curve**
|
|
- :ref:`Curve<class_Curve>` **anim_speed_curve**
|
|
@@ -382,6 +425,8 @@ Property Descriptions
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's animation speed will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_anim_speed_random:
|
|
.. _class_CPUParticles_property_anim_speed_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **anim_speed_random**
|
|
- :ref:`float<class_float>` **anim_speed_random**
|
|
@@ -392,6 +437,8 @@ Property Descriptions
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Animation speed randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_color:
|
|
.. _class_CPUParticles_property_color:
|
|
|
|
|
|
- :ref:`Color<class_Color>` **color**
|
|
- :ref:`Color<class_Color>` **color**
|
|
@@ -402,6 +449,8 @@ Property Descriptions
|
|
| *Getter* | get_color() |
|
|
| *Getter* | get_color() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Unused for 3D particles.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_color_ramp:
|
|
.. _class_CPUParticles_property_color_ramp:
|
|
|
|
|
|
- :ref:`Gradient<class_Gradient>` **color_ramp**
|
|
- :ref:`Gradient<class_Gradient>` **color_ramp**
|
|
@@ -412,7 +461,7 @@ Property Descriptions
|
|
| *Getter* | get_color_ramp() |
|
|
| *Getter* | get_color_ramp() |
|
|
+----------+-----------------------+
|
|
+----------+-----------------------+
|
|
|
|
|
|
-Each particle's vertex color will vary along this :ref:`GradientTexture<class_GradientTexture>`.
|
|
|
|
|
|
+Unused for 3D particles.
|
|
|
|
|
|
.. _class_CPUParticles_property_damping:
|
|
.. _class_CPUParticles_property_damping:
|
|
|
|
|
|
@@ -424,6 +473,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+The rate at which particles lose velocity.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_damping_curve:
|
|
.. _class_CPUParticles_property_damping_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **damping_curve**
|
|
- :ref:`Curve<class_Curve>` **damping_curve**
|
|
@@ -434,6 +485,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Damping will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_damping_random:
|
|
.. _class_CPUParticles_property_damping_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **damping_random**
|
|
- :ref:`float<class_float>` **damping_random**
|
|
@@ -444,6 +497,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Damping randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_draw_order:
|
|
.. _class_CPUParticles_property_draw_order:
|
|
|
|
|
|
- :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order**
|
|
- :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order**
|
|
@@ -454,6 +509,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_draw_order() |
|
|
| *Getter* | get_draw_order() |
|
|
+----------+-----------------------+
|
|
+----------+-----------------------+
|
|
|
|
|
|
|
|
+Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` values. Default value: :ref:`DRAW_ORDER_INDEX<class_CPUParticles_constant_DRAW_ORDER_INDEX>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_emission_box_extents:
|
|
.. _class_CPUParticles_property_emission_box_extents:
|
|
|
|
|
|
- :ref:`Vector3<class_Vector3>` **emission_box_extents**
|
|
- :ref:`Vector3<class_Vector3>` **emission_box_extents**
|
|
@@ -464,6 +521,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_emission_box_extents() |
|
|
| *Getter* | get_emission_box_extents() |
|
|
+----------+---------------------------------+
|
|
+----------+---------------------------------+
|
|
|
|
|
|
|
|
+The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_CPUParticles_constant_EMISSION_SHAPE_BOX>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_emission_colors:
|
|
.. _class_CPUParticles_property_emission_colors:
|
|
|
|
|
|
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
|
|
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
|
|
@@ -504,6 +563,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_emission_shape() |
|
|
| *Getter* | get_emission_shape() |
|
|
+----------+---------------------------+
|
|
+----------+---------------------------+
|
|
|
|
|
|
|
|
+Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` for values. Default value: :ref:`EMISSION_SHAPE_POINT<class_CPUParticles_constant_EMISSION_SHAPE_POINT>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_emission_sphere_radius:
|
|
.. _class_CPUParticles_property_emission_sphere_radius:
|
|
|
|
|
|
- :ref:`float<class_float>` **emission_sphere_radius**
|
|
- :ref:`float<class_float>` **emission_sphere_radius**
|
|
@@ -514,6 +575,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_emission_sphere_radius() |
|
|
| *Getter* | get_emission_sphere_radius() |
|
|
+----------+-----------------------------------+
|
|
+----------+-----------------------------------+
|
|
|
|
|
|
|
|
+The sphere's radius if :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_CPUParticles_constant_EMISSION_SHAPE_SPHERE>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_emitting:
|
|
.. _class_CPUParticles_property_emitting:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **emitting**
|
|
- :ref:`bool<class_bool>` **emitting**
|
|
@@ -524,6 +587,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | is_emitting() |
|
|
| *Getter* | is_emitting() |
|
|
+----------+---------------------+
|
|
+----------+---------------------+
|
|
|
|
|
|
|
|
+If ``true``, particles are being emitted. Default value: ``true``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_explosiveness:
|
|
.. _class_CPUParticles_property_explosiveness:
|
|
|
|
|
|
- :ref:`float<class_float>` **explosiveness**
|
|
- :ref:`float<class_float>` **explosiveness**
|
|
@@ -534,6 +599,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_explosiveness_ratio() |
|
|
| *Getter* | get_explosiveness_ratio() |
|
|
+----------+--------------------------------+
|
|
+----------+--------------------------------+
|
|
|
|
|
|
|
|
+How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_fixed_fps:
|
|
.. _class_CPUParticles_property_fixed_fps:
|
|
|
|
|
|
- :ref:`int<class_int>` **fixed_fps**
|
|
- :ref:`int<class_int>` **fixed_fps**
|
|
@@ -544,6 +611,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_fixed_fps() |
|
|
| *Getter* | get_fixed_fps() |
|
|
+----------+----------------------+
|
|
+----------+----------------------+
|
|
|
|
|
|
|
|
+The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_flag_align_y:
|
|
.. _class_CPUParticles_property_flag_align_y:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **flag_align_y**
|
|
- :ref:`bool<class_bool>` **flag_align_y**
|
|
@@ -554,6 +623,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_particle_flag() |
|
|
| *Getter* | get_particle_flag() |
|
|
+----------+--------------------------+
|
|
+----------+--------------------------+
|
|
|
|
|
|
|
|
+Align y-axis of particle with the direction of its velocity.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_flag_disable_z:
|
|
.. _class_CPUParticles_property_flag_disable_z:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **flag_disable_z**
|
|
- :ref:`bool<class_bool>` **flag_disable_z**
|
|
@@ -564,6 +635,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_particle_flag() |
|
|
| *Getter* | get_particle_flag() |
|
|
+----------+--------------------------+
|
|
+----------+--------------------------+
|
|
|
|
|
|
|
|
+If ``true``, particles will not move on the z axis. Default value: ``false``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_flag_rotate_y:
|
|
.. _class_CPUParticles_property_flag_rotate_y:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **flag_rotate_y**
|
|
- :ref:`bool<class_bool>` **flag_rotate_y**
|
|
@@ -574,6 +647,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_particle_flag() |
|
|
| *Getter* | get_particle_flag() |
|
|
+----------+--------------------------+
|
|
+----------+--------------------------+
|
|
|
|
|
|
|
|
+If ``true``, particles rotate around y-axis by :ref:`angle<class_CPUParticles_property_angle>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_flatness:
|
|
.. _class_CPUParticles_property_flatness:
|
|
|
|
|
|
- :ref:`float<class_float>` **flatness**
|
|
- :ref:`float<class_float>` **flatness**
|
|
@@ -584,6 +659,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_flatness() |
|
|
| *Getter* | get_flatness() |
|
|
+----------+---------------------+
|
|
+----------+---------------------+
|
|
|
|
|
|
|
|
+Amount of :ref:`spread<class_CPUParticles_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_fract_delta:
|
|
.. _class_CPUParticles_property_fract_delta:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **fract_delta**
|
|
- :ref:`bool<class_bool>` **fract_delta**
|
|
@@ -594,6 +671,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_fractional_delta() |
|
|
| *Getter* | get_fractional_delta() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+If ``true``, results in fractional delta calculation which has a smoother particles display effect. Default value: ``true``
|
|
|
|
+
|
|
.. _class_CPUParticles_property_gravity:
|
|
.. _class_CPUParticles_property_gravity:
|
|
|
|
|
|
- :ref:`Vector3<class_Vector3>` **gravity**
|
|
- :ref:`Vector3<class_Vector3>` **gravity**
|
|
@@ -604,6 +683,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_gravity() |
|
|
| *Getter* | get_gravity() |
|
|
+----------+--------------------+
|
|
+----------+--------------------+
|
|
|
|
|
|
|
|
+Gravity applied to every particle. Default value: ``(0, -9.8, 0)``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_hue_variation:
|
|
.. _class_CPUParticles_property_hue_variation:
|
|
|
|
|
|
- :ref:`float<class_float>` **hue_variation**
|
|
- :ref:`float<class_float>` **hue_variation**
|
|
@@ -614,6 +695,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Initial hue variation applied to each particle.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_hue_variation_curve:
|
|
.. _class_CPUParticles_property_hue_variation_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **hue_variation_curve**
|
|
- :ref:`Curve<class_Curve>` **hue_variation_curve**
|
|
@@ -624,6 +707,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's hue will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_hue_variation_random:
|
|
.. _class_CPUParticles_property_hue_variation_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **hue_variation_random**
|
|
- :ref:`float<class_float>` **hue_variation_random**
|
|
@@ -634,6 +719,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Hue variation randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_initial_velocity:
|
|
.. _class_CPUParticles_property_initial_velocity:
|
|
|
|
|
|
- :ref:`float<class_float>` **initial_velocity**
|
|
- :ref:`float<class_float>` **initial_velocity**
|
|
@@ -644,6 +731,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_CPUParticles_property_spread>` and the node's orientation.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_initial_velocity_random:
|
|
.. _class_CPUParticles_property_initial_velocity_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **initial_velocity_random**
|
|
- :ref:`float<class_float>` **initial_velocity_random**
|
|
@@ -654,6 +743,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Initial velocity randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_lifetime:
|
|
.. _class_CPUParticles_property_lifetime:
|
|
|
|
|
|
- :ref:`float<class_float>` **lifetime**
|
|
- :ref:`float<class_float>` **lifetime**
|
|
@@ -664,6 +755,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_lifetime() |
|
|
| *Getter* | get_lifetime() |
|
|
+----------+---------------------+
|
|
+----------+---------------------+
|
|
|
|
|
|
|
|
+Amount of time each particle will exist. Default value: ``1``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_linear_accel:
|
|
.. _class_CPUParticles_property_linear_accel:
|
|
|
|
|
|
- :ref:`float<class_float>` **linear_accel**
|
|
- :ref:`float<class_float>` **linear_accel**
|
|
@@ -674,6 +767,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Linear acceleration applied to each particle in the direction of motion.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_linear_accel_curve:
|
|
.. _class_CPUParticles_property_linear_accel_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **linear_accel_curve**
|
|
- :ref:`Curve<class_Curve>` **linear_accel_curve**
|
|
@@ -684,6 +779,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's linear acceleration will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_linear_accel_random:
|
|
.. _class_CPUParticles_property_linear_accel_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **linear_accel_random**
|
|
- :ref:`float<class_float>` **linear_accel_random**
|
|
@@ -694,6 +791,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Linear acceleration randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_local_coords:
|
|
.. _class_CPUParticles_property_local_coords:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **local_coords**
|
|
- :ref:`bool<class_bool>` **local_coords**
|
|
@@ -704,6 +803,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_use_local_coordinates() |
|
|
| *Getter* | get_use_local_coordinates() |
|
|
+----------+----------------------------------+
|
|
+----------+----------------------------------+
|
|
|
|
|
|
|
|
+If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_mesh:
|
|
.. _class_CPUParticles_property_mesh:
|
|
|
|
|
|
- :ref:`Mesh<class_Mesh>` **mesh**
|
|
- :ref:`Mesh<class_Mesh>` **mesh**
|
|
@@ -714,6 +815,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_mesh() |
|
|
| *Getter* | get_mesh() |
|
|
+----------+-----------------+
|
|
+----------+-----------------+
|
|
|
|
|
|
|
|
+The :ref:`Mesh<class_Mesh>` used for each particle. If ``null``, particles will be spheres.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_one_shot:
|
|
.. _class_CPUParticles_property_one_shot:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **one_shot**
|
|
- :ref:`bool<class_bool>` **one_shot**
|
|
@@ -724,6 +827,46 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_one_shot() |
|
|
| *Getter* | get_one_shot() |
|
|
+----------+---------------------+
|
|
+----------+---------------------+
|
|
|
|
|
|
|
|
+If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``.
|
|
|
|
+
|
|
|
|
+.. _class_CPUParticles_property_orbit_velocity:
|
|
|
|
+
|
|
|
|
+- :ref:`float<class_float>` **orbit_velocity**
|
|
|
|
+
|
|
|
|
++----------+------------------+
|
|
|
|
+| *Setter* | set_param(value) |
|
|
|
|
++----------+------------------+
|
|
|
|
+| *Getter* | get_param() |
|
|
|
|
++----------+------------------+
|
|
|
|
+
|
|
|
|
+Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second.
|
|
|
|
+
|
|
|
|
+This property is only available when :ref:`flag_disable_z<class_CPUParticles_property_flag_disable_z>` is ``true``.
|
|
|
|
+
|
|
|
|
+.. _class_CPUParticles_property_orbit_velocity_curve:
|
|
|
|
+
|
|
|
|
+- :ref:`Curve<class_Curve>` **orbit_velocity_curve**
|
|
|
|
+
|
|
|
|
++----------+------------------------+
|
|
|
|
+| *Setter* | set_param_curve(value) |
|
|
|
|
++----------+------------------------+
|
|
|
|
+| *Getter* | get_param_curve() |
|
|
|
|
++----------+------------------------+
|
|
|
|
+
|
|
|
|
+Each particle's orbital velocity will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
|
|
+.. _class_CPUParticles_property_orbit_velocity_random:
|
|
|
|
+
|
|
|
|
+- :ref:`float<class_float>` **orbit_velocity_random**
|
|
|
|
+
|
|
|
|
++----------+-----------------------------+
|
|
|
|
+| *Setter* | set_param_randomness(value) |
|
|
|
|
++----------+-----------------------------+
|
|
|
|
+| *Getter* | get_param_randomness() |
|
|
|
|
++----------+-----------------------------+
|
|
|
|
+
|
|
|
|
+Orbital velocity randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_preprocess:
|
|
.. _class_CPUParticles_property_preprocess:
|
|
|
|
|
|
- :ref:`float<class_float>` **preprocess**
|
|
- :ref:`float<class_float>` **preprocess**
|
|
@@ -734,6 +877,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_pre_process_time() |
|
|
| *Getter* | get_pre_process_time() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Particle system starts as if it had already run for this many seconds.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_radial_accel:
|
|
.. _class_CPUParticles_property_radial_accel:
|
|
|
|
|
|
- :ref:`float<class_float>` **radial_accel**
|
|
- :ref:`float<class_float>` **radial_accel**
|
|
@@ -744,6 +889,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Radial acceleration applied to each particle. Makes particle accelerate away from origin.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_radial_accel_curve:
|
|
.. _class_CPUParticles_property_radial_accel_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **radial_accel_curve**
|
|
- :ref:`Curve<class_Curve>` **radial_accel_curve**
|
|
@@ -754,6 +901,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's radial acceleration will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_radial_accel_random:
|
|
.. _class_CPUParticles_property_radial_accel_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **radial_accel_random**
|
|
- :ref:`float<class_float>` **radial_accel_random**
|
|
@@ -764,6 +913,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Radial acceleration randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_randomness:
|
|
.. _class_CPUParticles_property_randomness:
|
|
|
|
|
|
- :ref:`float<class_float>` **randomness**
|
|
- :ref:`float<class_float>` **randomness**
|
|
@@ -774,6 +925,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_randomness_ratio() |
|
|
| *Getter* | get_randomness_ratio() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Emission lifetime randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_scale_amount:
|
|
.. _class_CPUParticles_property_scale_amount:
|
|
|
|
|
|
- :ref:`float<class_float>` **scale_amount**
|
|
- :ref:`float<class_float>` **scale_amount**
|
|
@@ -784,6 +937,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Initial scale applied to each particle.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_scale_amount_curve:
|
|
.. _class_CPUParticles_property_scale_amount_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **scale_amount_curve**
|
|
- :ref:`Curve<class_Curve>` **scale_amount_curve**
|
|
@@ -794,6 +949,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's scale will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_scale_amount_random:
|
|
.. _class_CPUParticles_property_scale_amount_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **scale_amount_random**
|
|
- :ref:`float<class_float>` **scale_amount_random**
|
|
@@ -804,6 +961,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Scale randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_speed_scale:
|
|
.. _class_CPUParticles_property_speed_scale:
|
|
|
|
|
|
- :ref:`float<class_float>` **speed_scale**
|
|
- :ref:`float<class_float>` **speed_scale**
|
|
@@ -814,6 +973,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_speed_scale() |
|
|
| *Getter* | get_speed_scale() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_spread:
|
|
.. _class_CPUParticles_property_spread:
|
|
|
|
|
|
- :ref:`float<class_float>` **spread**
|
|
- :ref:`float<class_float>` **spread**
|
|
@@ -824,6 +985,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_spread() |
|
|
| *Getter* | get_spread() |
|
|
+----------+-------------------+
|
|
+----------+-------------------+
|
|
|
|
|
|
|
|
+Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_tangential_accel:
|
|
.. _class_CPUParticles_property_tangential_accel:
|
|
|
|
|
|
- :ref:`float<class_float>` **tangential_accel**
|
|
- :ref:`float<class_float>` **tangential_accel**
|
|
@@ -834,6 +997,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param() |
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
+----------+------------------+
|
|
|
|
|
|
|
|
+Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_tangential_accel_curve:
|
|
.. _class_CPUParticles_property_tangential_accel_curve:
|
|
|
|
|
|
- :ref:`Curve<class_Curve>` **tangential_accel_curve**
|
|
- :ref:`Curve<class_Curve>` **tangential_accel_curve**
|
|
@@ -844,6 +1009,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_curve() |
|
|
| *Getter* | get_param_curve() |
|
|
+----------+------------------------+
|
|
+----------+------------------------+
|
|
|
|
|
|
|
|
+Each particle's tangential acceleration will vary along this :ref:`Curve<class_Curve>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_property_tangential_accel_random:
|
|
.. _class_CPUParticles_property_tangential_accel_random:
|
|
|
|
|
|
- :ref:`float<class_float>` **tangential_accel_random**
|
|
- :ref:`float<class_float>` **tangential_accel_random**
|
|
@@ -854,6 +1021,8 @@ Each particle's vertex color will vary along this :ref:`GradientTexture<class_Gr
|
|
| *Getter* | get_param_randomness() |
|
|
| *Getter* | get_param_randomness() |
|
|
+----------+-----------------------------+
|
|
+----------+-----------------------------+
|
|
|
|
|
|
|
|
+Tangential acceleration randomness ratio. Default value: ``0``.
|
|
|
|
+
|
|
Method Descriptions
|
|
Method Descriptions
|
|
-------------------
|
|
-------------------
|
|
|
|
|
|
@@ -861,7 +1030,11 @@ Method Descriptions
|
|
|
|
|
|
- void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
|
|
- void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
|
|
|
|
|
|
|
|
+Sets this node's properties to match a given :ref:`Particles<class_Particles>` node with an assigned :ref:`ParticlesMaterial<class_ParticlesMaterial>`.
|
|
|
|
+
|
|
.. _class_CPUParticles_method_restart:
|
|
.. _class_CPUParticles_method_restart:
|
|
|
|
|
|
- void **restart** **(** **)**
|
|
- void **restart** **(** **)**
|
|
|
|
|
|
|
|
+Restarts the particle emitter.
|
|
|
|
+
|