Files
godot-docs/classes/class_cpuparticles.rst

820 lines
34 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CPUParticles.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CPUParticles:
CPUParticles
============
**Inherits:** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Properties
----------
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`amount<class_CPUParticles_amount>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angle<class_CPUParticles_angle>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`angle_curve<class_CPUParticles_angle_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angle_random<class_CPUParticles_angle_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity<class_CPUParticles_angular_velocity>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`angular_velocity_curve<class_CPUParticles_angular_velocity_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`angular_velocity_random<class_CPUParticles_angular_velocity_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anim_offset<class_CPUParticles_anim_offset>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_offset_curve<class_CPUParticles_anim_offset_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anim_offset_random<class_CPUParticles_anim_offset_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anim_speed<class_CPUParticles_anim_speed>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`anim_speed_curve<class_CPUParticles_anim_speed_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`anim_speed_random<class_CPUParticles_anim_speed_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`color<class_CPUParticles_color>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_CPUParticles_color_ramp>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`damping<class_CPUParticles_damping>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`damping_curve<class_CPUParticles_damping_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`damping_random<class_CPUParticles_damping_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` | :ref:`draw_order<class_CPUParticles_draw_order>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_CPUParticles_emission_box_extents>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`PoolColorArray<class_PoolColorArray>` | :ref:`emission_colors<class_CPUParticles_emission_colors>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_normals<class_CPUParticles_emission_normals>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`emission_points<class_CPUParticles_emission_points>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` | :ref:`emission_shape<class_CPUParticles_emission_shape>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_CPUParticles_emission_sphere_radius>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`emitting<class_CPUParticles_emitting>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`explosiveness<class_CPUParticles_explosiveness>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`fixed_fps<class_CPUParticles_fixed_fps>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flag_align_y<class_CPUParticles_flag_align_y>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flag_disable_z<class_CPUParticles_flag_disable_z>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flag_rotate_y<class_CPUParticles_flag_rotate_y>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`flatness<class_CPUParticles_flatness>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`fract_delta<class_CPUParticles_fract_delta>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_CPUParticles_gravity>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`hue_variation<class_CPUParticles_hue_variation>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`hue_variation_curve<class_CPUParticles_hue_variation_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`hue_variation_random<class_CPUParticles_hue_variation_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`initial_velocity<class_CPUParticles_initial_velocity>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`initial_velocity_random<class_CPUParticles_initial_velocity_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`lifetime<class_CPUParticles_lifetime>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear_accel<class_CPUParticles_linear_accel>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`linear_accel_curve<class_CPUParticles_linear_accel_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear_accel_random<class_CPUParticles_linear_accel_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`local_coords<class_CPUParticles_local_coords>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_CPUParticles_mesh>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_CPUParticles_one_shot>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`preprocess<class_CPUParticles_preprocess>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radial_accel<class_CPUParticles_radial_accel>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`radial_accel_curve<class_CPUParticles_radial_accel_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`radial_accel_random<class_CPUParticles_radial_accel_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`randomness<class_CPUParticles_randomness>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`scale_amount<class_CPUParticles_scale_amount>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`scale_amount_curve<class_CPUParticles_scale_amount_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`scale_amount_random<class_CPUParticles_scale_amount_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_CPUParticles_speed_scale>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`spread<class_CPUParticles_spread>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel<class_CPUParticles_tangential_accel>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`tangential_accel_curve<class_CPUParticles_tangential_accel_curve>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tangential_accel_random<class_CPUParticles_tangential_accel_random>` |
+-------------------------------------------------------+----------------------------------------------------------------------------+
Methods
-------
+-------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_CPUParticles_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+-------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_CPUParticles_restart>` **(** **)** |
+-------+------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
.. _enum_CPUParticles_DrawOrder:
enum **DrawOrder**:
- **DRAW_ORDER_INDEX** = **0**
- **DRAW_ORDER_LIFETIME** = **1**
- **DRAW_ORDER_VIEW_DEPTH** = **2**
.. _enum_CPUParticles_Parameter:
enum **Parameter**:
- **PARAM_INITIAL_LINEAR_VELOCITY** = **0**
- **PARAM_ANGULAR_VELOCITY** = **1**
- **PARAM_LINEAR_ACCEL** = **2**
- **PARAM_RADIAL_ACCEL** = **3**
- **PARAM_TANGENTIAL_ACCEL** = **4**
- **PARAM_DAMPING** = **5**
- **PARAM_ANGLE** = **6**
- **PARAM_SCALE** = **7**
- **PARAM_HUE_VARIATION** = **8**
- **PARAM_ANIM_SPEED** = **9**
- **PARAM_ANIM_OFFSET** = **10**
- **PARAM_MAX** = **11**
.. _enum_CPUParticles_Flags:
enum **Flags**:
- **FLAG_ALIGN_Y_TO_VELOCITY** = **0**
- **FLAG_ROTATE_Y** = **1**
- **FLAG_MAX** = **3**
.. _enum_CPUParticles_EmissionShape:
enum **EmissionShape**:
- **EMISSION_SHAPE_POINT** = **0**
- **EMISSION_SHAPE_SPHERE** = **1**
- **EMISSION_SHAPE_BOX** = **2**
- **EMISSION_SHAPE_POINTS** = **3**
- **EMISSION_SHAPE_DIRECTED_POINTS** = **4**
Property Descriptions
---------------------
.. _class_CPUParticles_amount:
- :ref:`int<class_int>` **amount**
+----------+-------------------+
| *Setter* | set_amount(value) |
+----------+-------------------+
| *Getter* | get_amount() |
+----------+-------------------+
.. _class_CPUParticles_angle:
- :ref:`float<class_float>` **angle**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_angle_curve:
- :ref:`Curve<class_Curve>` **angle_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_angle_random:
- :ref:`float<class_float>` **angle_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_angular_velocity:
- :ref:`float<class_float>` **angular_velocity**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_angular_velocity_curve:
- :ref:`Curve<class_Curve>` **angular_velocity_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_angular_velocity_random:
- :ref:`float<class_float>` **angular_velocity_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_anim_offset:
- :ref:`float<class_float>` **anim_offset**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_anim_offset_curve:
- :ref:`Curve<class_Curve>` **anim_offset_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_anim_offset_random:
- :ref:`float<class_float>` **anim_offset_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_anim_speed:
- :ref:`float<class_float>` **anim_speed**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_anim_speed_curve:
- :ref:`Curve<class_Curve>` **anim_speed_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_anim_speed_random:
- :ref:`float<class_float>` **anim_speed_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_color:
- :ref:`Color<class_Color>` **color**
+----------+------------------+
| *Setter* | set_color(value) |
+----------+------------------+
| *Getter* | get_color() |
+----------+------------------+
.. _class_CPUParticles_color_ramp:
- :ref:`Gradient<class_Gradient>` **color_ramp**
+----------+-----------------------+
| *Setter* | set_color_ramp(value) |
+----------+-----------------------+
| *Getter* | get_color_ramp() |
+----------+-----------------------+
.. _class_CPUParticles_damping:
- :ref:`float<class_float>` **damping**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_damping_curve:
- :ref:`Curve<class_Curve>` **damping_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_damping_random:
- :ref:`float<class_float>` **damping_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_draw_order:
- :ref:`DrawOrder<enum_CPUParticles_DrawOrder>` **draw_order**
+----------+-----------------------+
| *Setter* | set_draw_order(value) |
+----------+-----------------------+
| *Getter* | get_draw_order() |
+----------+-----------------------+
.. _class_CPUParticles_emission_box_extents:
- :ref:`Vector3<class_Vector3>` **emission_box_extents**
+----------+---------------------------------+
| *Setter* | set_emission_box_extents(value) |
+----------+---------------------------------+
| *Getter* | get_emission_box_extents() |
+----------+---------------------------------+
.. _class_CPUParticles_emission_colors:
- :ref:`PoolColorArray<class_PoolColorArray>` **emission_colors**
+----------+----------------------------+
| *Setter* | set_emission_colors(value) |
+----------+----------------------------+
| *Getter* | get_emission_colors() |
+----------+----------------------------+
.. _class_CPUParticles_emission_normals:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_normals**
+----------+-----------------------------+
| *Setter* | set_emission_normals(value) |
+----------+-----------------------------+
| *Getter* | get_emission_normals() |
+----------+-----------------------------+
.. _class_CPUParticles_emission_points:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **emission_points**
+----------+----------------------------+
| *Setter* | set_emission_points(value) |
+----------+----------------------------+
| *Getter* | get_emission_points() |
+----------+----------------------------+
.. _class_CPUParticles_emission_shape:
- :ref:`EmissionShape<enum_CPUParticles_EmissionShape>` **emission_shape**
+----------+---------------------------+
| *Setter* | set_emission_shape(value) |
+----------+---------------------------+
| *Getter* | get_emission_shape() |
+----------+---------------------------+
.. _class_CPUParticles_emission_sphere_radius:
- :ref:`float<class_float>` **emission_sphere_radius**
+----------+-----------------------------------+
| *Setter* | set_emission_sphere_radius(value) |
+----------+-----------------------------------+
| *Getter* | get_emission_sphere_radius() |
+----------+-----------------------------------+
.. _class_CPUParticles_emitting:
- :ref:`bool<class_bool>` **emitting**
+----------+---------------------+
| *Setter* | set_emitting(value) |
+----------+---------------------+
| *Getter* | is_emitting() |
+----------+---------------------+
.. _class_CPUParticles_explosiveness:
- :ref:`float<class_float>` **explosiveness**
+----------+--------------------------------+
| *Setter* | set_explosiveness_ratio(value) |
+----------+--------------------------------+
| *Getter* | get_explosiveness_ratio() |
+----------+--------------------------------+
.. _class_CPUParticles_fixed_fps:
- :ref:`int<class_int>` **fixed_fps**
+----------+----------------------+
| *Setter* | set_fixed_fps(value) |
+----------+----------------------+
| *Getter* | get_fixed_fps() |
+----------+----------------------+
.. _class_CPUParticles_flag_align_y:
- :ref:`bool<class_bool>` **flag_align_y**
+----------+--------------------------+
| *Setter* | set_particle_flag(value) |
+----------+--------------------------+
| *Getter* | get_particle_flag() |
+----------+--------------------------+
.. _class_CPUParticles_flag_disable_z:
- :ref:`bool<class_bool>` **flag_disable_z**
+----------+--------------------------+
| *Setter* | set_particle_flag(value) |
+----------+--------------------------+
| *Getter* | get_particle_flag() |
+----------+--------------------------+
.. _class_CPUParticles_flag_rotate_y:
- :ref:`bool<class_bool>` **flag_rotate_y**
+----------+--------------------------+
| *Setter* | set_particle_flag(value) |
+----------+--------------------------+
| *Getter* | get_particle_flag() |
+----------+--------------------------+
.. _class_CPUParticles_flatness:
- :ref:`float<class_float>` **flatness**
+----------+---------------------+
| *Setter* | set_flatness(value) |
+----------+---------------------+
| *Getter* | get_flatness() |
+----------+---------------------+
.. _class_CPUParticles_fract_delta:
- :ref:`bool<class_bool>` **fract_delta**
+----------+-----------------------------+
| *Setter* | set_fractional_delta(value) |
+----------+-----------------------------+
| *Getter* | get_fractional_delta() |
+----------+-----------------------------+
.. _class_CPUParticles_gravity:
- :ref:`Vector3<class_Vector3>` **gravity**
+----------+--------------------+
| *Setter* | set_gravity(value) |
+----------+--------------------+
| *Getter* | get_gravity() |
+----------+--------------------+
.. _class_CPUParticles_hue_variation:
- :ref:`float<class_float>` **hue_variation**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_hue_variation_curve:
- :ref:`Curve<class_Curve>` **hue_variation_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_hue_variation_random:
- :ref:`float<class_float>` **hue_variation_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_initial_velocity:
- :ref:`float<class_float>` **initial_velocity**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_initial_velocity_random:
- :ref:`float<class_float>` **initial_velocity_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_lifetime:
- :ref:`float<class_float>` **lifetime**
+----------+---------------------+
| *Setter* | set_lifetime(value) |
+----------+---------------------+
| *Getter* | get_lifetime() |
+----------+---------------------+
.. _class_CPUParticles_linear_accel:
- :ref:`float<class_float>` **linear_accel**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_linear_accel_curve:
- :ref:`Curve<class_Curve>` **linear_accel_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_linear_accel_random:
- :ref:`float<class_float>` **linear_accel_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_local_coords:
- :ref:`bool<class_bool>` **local_coords**
+----------+----------------------------------+
| *Setter* | set_use_local_coordinates(value) |
+----------+----------------------------------+
| *Getter* | get_use_local_coordinates() |
+----------+----------------------------------+
.. _class_CPUParticles_mesh:
- :ref:`Mesh<class_Mesh>` **mesh**
+----------+-----------------+
| *Setter* | set_mesh(value) |
+----------+-----------------+
| *Getter* | get_mesh() |
+----------+-----------------+
.. _class_CPUParticles_one_shot:
- :ref:`bool<class_bool>` **one_shot**
+----------+---------------------+
| *Setter* | set_one_shot(value) |
+----------+---------------------+
| *Getter* | get_one_shot() |
+----------+---------------------+
.. _class_CPUParticles_preprocess:
- :ref:`float<class_float>` **preprocess**
+----------+-----------------------------+
| *Setter* | set_pre_process_time(value) |
+----------+-----------------------------+
| *Getter* | get_pre_process_time() |
+----------+-----------------------------+
.. _class_CPUParticles_radial_accel:
- :ref:`float<class_float>` **radial_accel**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_radial_accel_curve:
- :ref:`Curve<class_Curve>` **radial_accel_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_radial_accel_random:
- :ref:`float<class_float>` **radial_accel_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_randomness:
- :ref:`float<class_float>` **randomness**
+----------+-----------------------------+
| *Setter* | set_randomness_ratio(value) |
+----------+-----------------------------+
| *Getter* | get_randomness_ratio() |
+----------+-----------------------------+
.. _class_CPUParticles_scale_amount:
- :ref:`float<class_float>` **scale_amount**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_scale_amount_curve:
- :ref:`Curve<class_Curve>` **scale_amount_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_scale_amount_random:
- :ref:`float<class_float>` **scale_amount_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
.. _class_CPUParticles_speed_scale:
- :ref:`float<class_float>` **speed_scale**
+----------+------------------------+
| *Setter* | set_speed_scale(value) |
+----------+------------------------+
| *Getter* | get_speed_scale() |
+----------+------------------------+
.. _class_CPUParticles_spread:
- :ref:`float<class_float>` **spread**
+----------+-------------------+
| *Setter* | set_spread(value) |
+----------+-------------------+
| *Getter* | get_spread() |
+----------+-------------------+
.. _class_CPUParticles_tangential_accel:
- :ref:`float<class_float>` **tangential_accel**
+----------+------------------+
| *Setter* | set_param(value) |
+----------+------------------+
| *Getter* | get_param() |
+----------+------------------+
.. _class_CPUParticles_tangential_accel_curve:
- :ref:`Curve<class_Curve>` **tangential_accel_curve**
+----------+------------------------+
| *Setter* | set_param_curve(value) |
+----------+------------------------+
| *Getter* | get_param_curve() |
+----------+------------------------+
.. _class_CPUParticles_tangential_accel_random:
- :ref:`float<class_float>` **tangential_accel_random**
+----------+-----------------------------+
| *Setter* | set_param_randomness(value) |
+----------+-----------------------------+
| *Getter* | get_param_randomness() |
+----------+-----------------------------+
Method Descriptions
-------------------
.. _class_CPUParticles_convert_from_particles:
- void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
.. _class_CPUParticles_restart:
- void **restart** **(** **)**