godot-docs/classes/class_particlesmaterial.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_ParticlesMaterial:

ParticlesMaterial
=================

**Inherits:** :ref:`Material<class_material>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

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



Member Functions
----------------

+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`                      | :ref:`get_color<class_ParticlesMaterial_get_color>`  **(** **)** const                                                                                    |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`                  | :ref:`get_color_ramp<class_ParticlesMaterial_get_color_ramp>`  **(** **)** const                                                                          |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`                  | :ref:`get_emission_box_extents<class_ParticlesMaterial_get_emission_box_extents>`  **(** **)** const                                                      |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`                  | :ref:`get_emission_normal_texture<class_ParticlesMaterial_get_emission_normal_texture>`  **(** **)** const                                                |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                          | :ref:`get_emission_point_count<class_ParticlesMaterial_get_emission_point_count>`  **(** **)** const                                                      |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`                  | :ref:`get_emission_point_texture<class_ParticlesMaterial_get_emission_point_texture>`  **(** **)** const                                                  |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                          | :ref:`get_emission_shape<class_ParticlesMaterial_get_emission_shape>`  **(** **)** const                                                                  |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                      | :ref:`get_emission_sphere_radius<class_ParticlesMaterial_get_emission_sphere_radius>`  **(** **)** const                                                  |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                        | :ref:`get_flag<class_ParticlesMaterial_get_flag>`  **(** :ref:`int<class_int>` flag  **)** const                                                          |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                      | :ref:`get_flatness<class_ParticlesMaterial_get_flatness>`  **(** **)** const                                                                              |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`                  | :ref:`get_gravity<class_ParticlesMaterial_get_gravity>`  **(** **)** const                                                                                |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                      | :ref:`get_param<class_ParticlesMaterial_get_param>`  **(** :ref:`int<class_int>` param  **)** const                                                       |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                      | :ref:`get_param_randomness<class_ParticlesMaterial_get_param_randomness>`  **(** :ref:`int<class_int>` param  **)** const                                 |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>`                    | :ref:`get_param_texture<class_ParticlesMaterial_get_param_texture>`  **(** :ref:`int<class_int>` param  **)** const                                       |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                      | :ref:`get_spread<class_ParticlesMaterial_get_spread>`  **(** **)** const                                                                                  |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`GradientTexture<class_gradienttexture>`  | :ref:`get_trail_color_modifier<class_ParticlesMaterial_get_trail_color_modifier>`  **(** **)** const                                                      |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                          | :ref:`get_trail_divisor<class_ParticlesMaterial_get_trail_divisor>`  **(** **)** const                                                                    |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CurveTexture<class_curvetexture>`        | :ref:`get_trail_size_modifier<class_ParticlesMaterial_get_trail_size_modifier>`  **(** **)** const                                                        |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_color<class_ParticlesMaterial_set_color>`  **(** :ref:`Color<class_color>` color  **)**                                                         |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_color_ramp<class_ParticlesMaterial_set_color_ramp>`  **(** :ref:`Texture<class_texture>` ramp  **)**                                            |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_emission_box_extents<class_ParticlesMaterial_set_emission_box_extents>`  **(** :ref:`Vector3<class_vector3>` extents  **)**                     |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_emission_normal_texture<class_ParticlesMaterial_set_emission_normal_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**               |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_emission_point_count<class_ParticlesMaterial_set_emission_point_count>`  **(** :ref:`int<class_int>` point_count  **)**                         |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_emission_point_texture<class_ParticlesMaterial_set_emission_point_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**                 |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_emission_shape<class_ParticlesMaterial_set_emission_shape>`  **(** :ref:`int<class_int>` shape  **)**                                           |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_emission_sphere_radius<class_ParticlesMaterial_set_emission_sphere_radius>`  **(** :ref:`float<class_float>` radius  **)**                      |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_flag<class_ParticlesMaterial_set_flag>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enable  **)**                                |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_flatness<class_ParticlesMaterial_set_flatness>`  **(** :ref:`float<class_float>` amount  **)**                                                  |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_gravity<class_ParticlesMaterial_set_gravity>`  **(** :ref:`Vector3<class_vector3>` accel_vec  **)**                                             |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_param<class_ParticlesMaterial_set_param>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)**                            |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_param_randomness<class_ParticlesMaterial_set_param_randomness>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` randomness  **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_param_texture<class_ParticlesMaterial_set_param_texture>`  **(** :ref:`int<class_int>` param, :ref:`Object<class_object>` texture  **)**        |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_spread<class_ParticlesMaterial_set_spread>`  **(** :ref:`float<class_float>` degrees  **)**                                                     |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_trail_color_modifier<class_ParticlesMaterial_set_trail_color_modifier>`  **(** :ref:`GradientTexture<class_gradienttexture>` texture  **)**     |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_trail_divisor<class_ParticlesMaterial_set_trail_divisor>`  **(** :ref:`int<class_int>` divisor  **)**                                           |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_trail_size_modifier<class_ParticlesMaterial_set_trail_size_modifier>`  **(** :ref:`CurveTexture<class_curvetexture>` texture  **)**             |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`float<class_float>` **angle**
- :ref:`CurveTexture<class_curvetexture>` **angle_curve**
- :ref:`float<class_float>` **angle_random**
- :ref:`float<class_float>` **angular_velocity**
- :ref:`CurveTexture<class_curvetexture>` **angular_velocity_curve**
- :ref:`float<class_float>` **angular_velocity_random**
- :ref:`float<class_float>` **anim_offset**
- :ref:`CurveTexture<class_curvetexture>` **anim_offset_curve**
- :ref:`float<class_float>` **anim_offset_random**
- :ref:`float<class_float>` **anim_speed**
- :ref:`CurveTexture<class_curvetexture>` **anim_speed_curve**
- :ref:`float<class_float>` **anim_speed_random**
- :ref:`Color<class_color>` **color**
- :ref:`GradientTexture<class_gradienttexture>` **color_ramp**
- :ref:`float<class_float>` **damping**
- :ref:`CurveTexture<class_curvetexture>` **damping_curve**
- :ref:`float<class_float>` **damping_random**
- :ref:`Vector3<class_vector3>` **emission_box_extents**
- :ref:`Texture<class_texture>` **emission_normal_texture**
- :ref:`int<class_int>` **emission_point_count**
- :ref:`Texture<class_texture>` **emission_point_texture**
- :ref:`int<class_int>` **emission_shape**
- :ref:`float<class_float>` **emission_sphere_radius**
- :ref:`bool<class_bool>` **flag_align_y**
- :ref:`bool<class_bool>` **flag_rotate_y**
- :ref:`float<class_float>` **flatness**
- :ref:`Vector3<class_vector3>` **gravity**
- :ref:`float<class_float>` **hue_variation**
- :ref:`CurveTexture<class_curvetexture>` **hue_variation_curve**
- :ref:`float<class_float>` **hue_variation_random**
- :ref:`float<class_float>` **initial_velocity**
- :ref:`float<class_float>` **initial_velocity_random**
- :ref:`float<class_float>` **linear_accel**
- :ref:`CurveTexture<class_curvetexture>` **linear_accel_curve**
- :ref:`float<class_float>` **linear_accel_random**
- :ref:`float<class_float>` **orbit_velocity**
- :ref:`CurveTexture<class_curvetexture>` **orbit_velocity_curve**
- :ref:`float<class_float>` **orbit_velocity_random**
- :ref:`float<class_float>` **radial_accel**
- :ref:`CurveTexture<class_curvetexture>` **radial_accel_curve**
- :ref:`float<class_float>` **radial_accel_random**
- :ref:`float<class_float>` **scale**
- :ref:`CurveTexture<class_curvetexture>` **scale_curve**
- :ref:`float<class_float>` **scale_random**
- :ref:`float<class_float>` **spread**
- :ref:`float<class_float>` **tangential_accel**
- :ref:`CurveTexture<class_curvetexture>` **tangential_accel_curve**
- :ref:`float<class_float>` **tangential_accel_random**
- :ref:`GradientTexture<class_gradienttexture>` **trail_color_modifier**
- :ref:`int<class_int>` **trail_divisor**
- :ref:`CurveTexture<class_curvetexture>` **trail_size_modifier**

Numeric Constants
-----------------

- **PARAM_INITIAL_LINEAR_VELOCITY** = **0**
- **PARAM_ANGULAR_VELOCITY** = **1**
- **PARAM_ORBIT_VELOCITY** = **2**
- **PARAM_LINEAR_ACCEL** = **3**
- **PARAM_RADIAL_ACCEL** = **4**
- **PARAM_TANGENTIAL_ACCEL** = **5**
- **PARAM_DAMPING** = **6**
- **PARAM_ANGLE** = **7**
- **PARAM_SCALE** = **8**
- **PARAM_HUE_VARIATION** = **9**
- **PARAM_ANIM_SPEED** = **10**
- **PARAM_ANIM_OFFSET** = **11**
- **PARAM_MAX** = **12**
- **FLAG_ALIGN_Y_TO_VELOCITY** = **0**
- **FLAG_ROTATE_Y** = **1**
- **FLAG_MAX** = **2**
- **EMISSION_SHAPE_POINT** = **0**
- **EMISSION_SHAPE_SPHERE** = **1**
- **EMISSION_SHAPE_BOX** = **2**
- **EMISSION_SHAPE_POINTS** = **3**
- **EMISSION_SHAPE_DIRECTED_POINTS** = **4**

Member Function Description
---------------------------

.. _class_ParticlesMaterial_get_color:

- :ref:`Color<class_color>`  **get_color**  **(** **)** const

.. _class_ParticlesMaterial_get_color_ramp:

- :ref:`Texture<class_texture>`  **get_color_ramp**  **(** **)** const

.. _class_ParticlesMaterial_get_emission_box_extents:

- :ref:`Vector3<class_vector3>`  **get_emission_box_extents**  **(** **)** const

.. _class_ParticlesMaterial_get_emission_normal_texture:

- :ref:`Texture<class_texture>`  **get_emission_normal_texture**  **(** **)** const

.. _class_ParticlesMaterial_get_emission_point_count:

- :ref:`int<class_int>`  **get_emission_point_count**  **(** **)** const

.. _class_ParticlesMaterial_get_emission_point_texture:

- :ref:`Texture<class_texture>`  **get_emission_point_texture**  **(** **)** const

.. _class_ParticlesMaterial_get_emission_shape:

- :ref:`int<class_int>`  **get_emission_shape**  **(** **)** const

.. _class_ParticlesMaterial_get_emission_sphere_radius:

- :ref:`float<class_float>`  **get_emission_sphere_radius**  **(** **)** const

.. _class_ParticlesMaterial_get_flag:

- :ref:`bool<class_bool>`  **get_flag**  **(** :ref:`int<class_int>` flag  **)** const

.. _class_ParticlesMaterial_get_flatness:

- :ref:`float<class_float>`  **get_flatness**  **(** **)** const

.. _class_ParticlesMaterial_get_gravity:

- :ref:`Vector3<class_vector3>`  **get_gravity**  **(** **)** const

.. _class_ParticlesMaterial_get_param:

- :ref:`float<class_float>`  **get_param**  **(** :ref:`int<class_int>` param  **)** const

.. _class_ParticlesMaterial_get_param_randomness:

- :ref:`float<class_float>`  **get_param_randomness**  **(** :ref:`int<class_int>` param  **)** const

.. _class_ParticlesMaterial_get_param_texture:

- :ref:`Object<class_object>`  **get_param_texture**  **(** :ref:`int<class_int>` param  **)** const

.. _class_ParticlesMaterial_get_spread:

- :ref:`float<class_float>`  **get_spread**  **(** **)** const

.. _class_ParticlesMaterial_get_trail_color_modifier:

- :ref:`GradientTexture<class_gradienttexture>`  **get_trail_color_modifier**  **(** **)** const

.. _class_ParticlesMaterial_get_trail_divisor:

- :ref:`int<class_int>`  **get_trail_divisor**  **(** **)** const

.. _class_ParticlesMaterial_get_trail_size_modifier:

- :ref:`CurveTexture<class_curvetexture>`  **get_trail_size_modifier**  **(** **)** const

.. _class_ParticlesMaterial_set_color:

- void  **set_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_ParticlesMaterial_set_color_ramp:

- void  **set_color_ramp**  **(** :ref:`Texture<class_texture>` ramp  **)**

.. _class_ParticlesMaterial_set_emission_box_extents:

- void  **set_emission_box_extents**  **(** :ref:`Vector3<class_vector3>` extents  **)**

.. _class_ParticlesMaterial_set_emission_normal_texture:

- void  **set_emission_normal_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_ParticlesMaterial_set_emission_point_count:

- void  **set_emission_point_count**  **(** :ref:`int<class_int>` point_count  **)**

.. _class_ParticlesMaterial_set_emission_point_texture:

- void  **set_emission_point_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_ParticlesMaterial_set_emission_shape:

- void  **set_emission_shape**  **(** :ref:`int<class_int>` shape  **)**

.. _class_ParticlesMaterial_set_emission_sphere_radius:

- void  **set_emission_sphere_radius**  **(** :ref:`float<class_float>` radius  **)**

.. _class_ParticlesMaterial_set_flag:

- void  **set_flag**  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enable  **)**

.. _class_ParticlesMaterial_set_flatness:

- void  **set_flatness**  **(** :ref:`float<class_float>` amount  **)**

.. _class_ParticlesMaterial_set_gravity:

- void  **set_gravity**  **(** :ref:`Vector3<class_vector3>` accel_vec  **)**

.. _class_ParticlesMaterial_set_param:

- void  **set_param**  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)**

.. _class_ParticlesMaterial_set_param_randomness:

- void  **set_param_randomness**  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` randomness  **)**

.. _class_ParticlesMaterial_set_param_texture:

- void  **set_param_texture**  **(** :ref:`int<class_int>` param, :ref:`Object<class_object>` texture  **)**

.. _class_ParticlesMaterial_set_spread:

- void  **set_spread**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_ParticlesMaterial_set_trail_color_modifier:

- void  **set_trail_color_modifier**  **(** :ref:`GradientTexture<class_gradienttexture>` texture  **)**

.. _class_ParticlesMaterial_set_trail_divisor:

- void  **set_trail_divisor**  **(** :ref:`int<class_int>` divisor  **)**

.. _class_ParticlesMaterial_set_trail_size_modifier:

- void  **set_trail_size_modifier**  **(** :ref:`CurveTexture<class_curvetexture>` texture  **)**