:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ParticlesMaterial.xml. .. _class_ParticlesMaterial: ParticlesMaterial ================= **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Particle properties for :ref:`Particles` and :ref:`Particles2D` nodes. .. rst-class:: classref-introduction-group Description ----------- ParticlesMaterial defines particle properties and behavior. It is used in the ``process_material`` of :ref:`Particles` and :ref:`Particles2D` emitter nodes. Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture` applied to vary values over the lifetime of the particle. When a randomness ratio is applied to a property it is used to scale that property by a random amount. The random ratio is used to interpolate between ``1.0`` and a random number less than one, the result is multiplied by the property to obtain the randomized property. For example a random ratio of ``0.4`` would scale the original property between ``0.4-1.0`` of its original value. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angle` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`angle_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angle_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angular_velocity` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`angular_velocity_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angular_velocity_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_offset` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`anim_offset_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_offset_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_speed` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`anim_speed_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_speed_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`color_initial_ramp` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`color_ramp` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`damping` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`damping_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`damping_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Vector3` | :ref:`direction` | ``Vector3( 1, 0, 0 )`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Vector3` | :ref:`emission_box_extents` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`emission_color_texture` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`emission_normal_texture` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`int` | :ref:`emission_point_count` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`emission_point_texture` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Vector3` | :ref:`emission_ring_axis` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`emission_ring_height` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`emission_ring_inner_radius` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`emission_ring_radius` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`emission_sphere_radius` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`flag_align_y` | ``false`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`flag_disable_z` | ``false`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`flag_rotate_y` | ``false`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`flatness` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Vector3` | :ref:`gravity` | ``Vector3( 0, -9.8, 0 )`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`hue_variation` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`hue_variation_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`hue_variation_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`initial_velocity` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`initial_velocity_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`lifetime_randomness` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`linear_accel` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`linear_accel_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`linear_accel_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`orbit_velocity` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`orbit_velocity_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`orbit_velocity_random` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`radial_accel` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`radial_accel_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`radial_accel_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`scale` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`scale_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`scale_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`spread` | ``45.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`tangential_accel` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Texture` | :ref:`tangential_accel_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`tangential_accel_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`GradientTexture` | :ref:`trail_color_modifier` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`int` | :ref:`trail_divisor` | ``1`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ | :ref:`CurveTexture` | :ref:`trail_size_modifier` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`Parameter` param **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`Parameter` param, :ref:`float` value **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_randomness` **(** :ref:`Parameter` param, :ref:`float` randomness **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_texture` **(** :ref:`Parameter` param, :ref:`Texture` texture **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ParticlesMaterial_Parameter: .. rst-class:: classref-enumeration enum **Parameter**: .. _class_ParticlesMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set initial velocity properties. .. _class_ParticlesMaterial_constant_PARAM_ANGULAR_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANGULAR_VELOCITY** = ``1`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angular velocity properties. .. _class_ParticlesMaterial_constant_PARAM_ORBIT_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ORBIT_VELOCITY** = ``2`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set orbital velocity properties. .. _class_ParticlesMaterial_constant_PARAM_LINEAR_ACCEL: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_LINEAR_ACCEL** = ``3`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set linear acceleration properties. .. _class_ParticlesMaterial_constant_PARAM_RADIAL_ACCEL: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_RADIAL_ACCEL** = ``4`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set radial acceleration properties. .. _class_ParticlesMaterial_constant_PARAM_TANGENTIAL_ACCEL: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_TANGENTIAL_ACCEL** = ``5`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set tangential acceleration properties. .. _class_ParticlesMaterial_constant_PARAM_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_DAMPING** = ``6`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set damping properties. .. _class_ParticlesMaterial_constant_PARAM_ANGLE: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANGLE** = ``7`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angle properties. .. _class_ParticlesMaterial_constant_PARAM_SCALE: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_SCALE** = ``8`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set scale properties. .. _class_ParticlesMaterial_constant_PARAM_HUE_VARIATION: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_HUE_VARIATION** = ``9`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set hue variation properties. .. _class_ParticlesMaterial_constant_PARAM_ANIM_SPEED: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANIM_SPEED** = ``10`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation speed properties. .. _class_ParticlesMaterial_constant_PARAM_ANIM_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_ANIM_OFFSET** = ``11`` Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation offset properties. .. _class_ParticlesMaterial_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`Parameter` **PARAM_MAX** = ``12`` Represents the size of the :ref:`Parameter` enum. .. rst-class:: classref-item-separator ---- .. _enum_ParticlesMaterial_Flags: .. rst-class:: classref-enumeration enum **Flags**: .. _class_ParticlesMaterial_constant_FLAG_ALIGN_Y_TO_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Flags` **FLAG_ALIGN_Y_TO_VELOCITY** = ``0`` Use with :ref:`set_flag` to set :ref:`flag_align_y`. .. _class_ParticlesMaterial_constant_FLAG_ROTATE_Y: .. rst-class:: classref-enumeration-constant :ref:`Flags` **FLAG_ROTATE_Y** = ``1`` Use with :ref:`set_flag` to set :ref:`flag_rotate_y`. .. _class_ParticlesMaterial_constant_FLAG_DISABLE_Z: .. rst-class:: classref-enumeration-constant :ref:`Flags` **FLAG_DISABLE_Z** = ``2`` Use with :ref:`set_flag` to set :ref:`flag_disable_z`. .. _class_ParticlesMaterial_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`Flags` **FLAG_MAX** = ``3`` Represents the size of the :ref:`Flags` enum. .. rst-class:: classref-item-separator ---- .. _enum_ParticlesMaterial_EmissionShape: .. rst-class:: classref-enumeration enum **EmissionShape**: .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_POINT: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_POINT** = ``0`` All particles will be emitted from a single point. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_SPHERE: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_SPHERE** = ``1`` Particles will be emitted in the volume of a sphere. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_BOX: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_BOX** = ``2`` Particles will be emitted in the volume of a box. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_POINTS: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_POINTS** = ``3`` Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture`. Particle color will be modulated by :ref:`emission_color_texture`. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_DIRECTED_POINTS** = ``4`` Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture`. Particle velocity and rotation will be set based on :ref:`emission_normal_texture`. Particle color will be modulated by :ref:`emission_color_texture`. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_RING: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_RING** = ``5`` Particles will be emitted in a ring or cylinder. .. _class_ParticlesMaterial_constant_EMISSION_SHAPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`EmissionShape` **EMISSION_SHAPE_MAX** = ``6`` Represents the size of the :ref:`EmissionShape` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ParticlesMaterial_property_angle: .. rst-class:: classref-property :ref:`float` **angle** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Initial rotation applied to each particle, in degrees. \ **Note:** Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`Material3D` being used to draw the particle is using :ref:`Material3D.BILLBOARD_PARTICLES`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_angle_curve: .. rst-class:: classref-property :ref:`Texture` **angle_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's rotation will be animated along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_angle_random: .. rst-class:: classref-property :ref:`float` **angle_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Rotation randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_angular_velocity: .. rst-class:: classref-property :ref:`float` **angular_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Initial angular velocity applied to each particle in *degrees* per second. Sets the speed of rotation of the particle. \ **Note:** Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`Material3D` being used to draw the particle is using :ref:`Material3D.BILLBOARD_PARTICLES`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_angular_velocity_curve: .. rst-class:: classref-property :ref:`Texture` **angular_velocity_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's angular velocity will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_angular_velocity_random: .. rst-class:: classref-property :ref:`float` **angular_velocity_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Angular velocity randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_anim_offset: .. rst-class:: classref-property :ref:`float` **anim_offset** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Particle animation offset. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_anim_offset_curve: .. rst-class:: classref-property :ref:`Texture` **anim_offset_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's animation offset will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_anim_offset_random: .. rst-class:: classref-property :ref:`float` **anim_offset_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Animation offset randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_anim_speed: .. rst-class:: classref-property :ref:`float` **anim_speed** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Particle animation speed. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_anim_speed_curve: .. rst-class:: classref-property :ref:`Texture` **anim_speed_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's animation speed will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_anim_speed_random: .. rst-class:: classref-property :ref:`float` **anim_speed_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Animation speed randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color( 1, 1, 1, 1 )`` .. rst-class:: classref-property-setget - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_color** **(** **)** Each particle's initial color. If the :ref:`Particles2D`'s or :ref:`Particles`'s ``texture`` is defined, it will be multiplied by this color. \ **Note:** :ref:`color` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color` will have no visible effect. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_color_initial_ramp: .. rst-class:: classref-property :ref:`Texture` **color_initial_ramp** .. rst-class:: classref-property-setget - void **set_color_initial_ramp** **(** :ref:`Texture` value **)** - :ref:`Texture` **get_color_initial_ramp** **(** **)** Each particle's initial color will vary along this :ref:`GradientTexture` (multiplied with :ref:`color`). \ **Note:** :ref:`color_initial_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp` will have no visible effect. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_color_ramp: .. rst-class:: classref-property :ref:`Texture` **color_ramp** .. rst-class:: classref-property-setget - void **set_color_ramp** **(** :ref:`Texture` value **)** - :ref:`Texture` **get_color_ramp** **(** **)** Each particle's color will vary along this :ref:`GradientTexture` over its lifetime (multiplied with :ref:`color`). \ **Note:** :ref:`color_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp` will have no visible effect. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_damping: .. rst-class:: classref-property :ref:`float` **damping** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| The rate at which particles lose velocity. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_damping_curve: .. rst-class:: classref-property :ref:`Texture` **damping_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Damping will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_damping_random: .. rst-class:: classref-property :ref:`float` **damping_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Damping randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_direction: .. rst-class:: classref-property :ref:`Vector3` **direction** = ``Vector3( 1, 0, 0 )`` .. rst-class:: classref-property-setget - void **set_direction** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_direction** **(** **)** Unit vector specifying the particles' emission direction. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_box_extents: .. rst-class:: classref-property :ref:`Vector3` **emission_box_extents** .. rst-class:: classref-property-setget - void **set_emission_box_extents** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_emission_box_extents** **(** **)** The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_color_texture: .. rst-class:: classref-property :ref:`Texture` **emission_color_texture** .. rst-class:: classref-property-setget - void **set_emission_color_texture** **(** :ref:`Texture` value **)** - :ref:`Texture` **get_emission_color_texture** **(** **)** Particle color will be modulated by color determined by sampling this texture at the same point as the :ref:`emission_point_texture`. \ **Note:** :ref:`emission_color_texture` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_color_texture` will have no visible effect. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_normal_texture: .. rst-class:: classref-property :ref:`Texture` **emission_normal_texture** .. rst-class:: classref-property-setget - void **set_emission_normal_texture** **(** :ref:`Texture` value **)** - :ref:`Texture` **get_emission_normal_texture** **(** **)** Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture`. Used only in :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_point_count: .. rst-class:: classref-property :ref:`int` **emission_point_count** .. rst-class:: classref-property-setget - void **set_emission_point_count** **(** :ref:`int` value **)** - :ref:`int` **get_emission_point_count** **(** **)** The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_point_texture: .. rst-class:: classref-property :ref:`Texture` **emission_point_texture** .. rst-class:: classref-property-setget - void **set_emission_point_texture** **(** :ref:`Texture` value **)** - :ref:`Texture` **get_emission_point_texture** **(** **)** Particles will be emitted at positions determined by sampling this texture at a random position. Used with :ref:`EMISSION_SHAPE_POINTS` and :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_ring_axis: .. rst-class:: classref-property :ref:`Vector3` **emission_ring_axis** .. rst-class:: classref-property-setget - void **set_emission_ring_axis** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_emission_ring_axis** **(** **)** The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_ring_height: .. rst-class:: classref-property :ref:`float` **emission_ring_height** .. rst-class:: classref-property-setget - void **set_emission_ring_height** **(** :ref:`float` value **)** - :ref:`float` **get_emission_ring_height** **(** **)** The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_ring_inner_radius: .. rst-class:: classref-property :ref:`float` **emission_ring_inner_radius** .. rst-class:: classref-property-setget - void **set_emission_ring_inner_radius** **(** :ref:`float` value **)** - :ref:`float` **get_emission_ring_inner_radius** **(** **)** The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_ring_radius: .. rst-class:: classref-property :ref:`float` **emission_ring_radius** .. rst-class:: classref-property-setget - void **set_emission_ring_radius** **(** :ref:`float` value **)** - :ref:`float` **get_emission_ring_radius** **(** **)** The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_shape: .. rst-class:: classref-property :ref:`EmissionShape` **emission_shape** = ``0`` .. rst-class:: classref-property-setget - void **set_emission_shape** **(** :ref:`EmissionShape` value **)** - :ref:`EmissionShape` **get_emission_shape** **(** **)** Particles will be emitted inside this region. Use :ref:`EmissionShape` constants for values. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_emission_sphere_radius: .. rst-class:: classref-property :ref:`float` **emission_sphere_radius** .. rst-class:: classref-property-setget - void **set_emission_sphere_radius** **(** :ref:`float` value **)** - :ref:`float` **get_emission_sphere_radius** **(** **)** The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_flag_align_y: .. rst-class:: classref-property :ref:`bool` **flag_align_y** = ``false`` .. rst-class:: classref-property-setget - void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** - :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| Align Y axis of particle with the direction of its velocity. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_flag_disable_z: .. rst-class:: classref-property :ref:`bool` **flag_disable_z** = ``false`` .. rst-class:: classref-property-setget - void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** - :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| If ``true``, particles will not move on the z axis. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_flag_rotate_y: .. rst-class:: classref-property :ref:`bool` **flag_rotate_y** = ``false`` .. rst-class:: classref-property-setget - void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** - :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| If ``true``, particles rotate around Y axis by :ref:`angle`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_flatness: .. rst-class:: classref-property :ref:`float` **flatness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_flatness** **(** :ref:`float` value **)** - :ref:`float` **get_flatness** **(** **)** Amount of :ref:`spread` along the Y axis. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_gravity: .. rst-class:: classref-property :ref:`Vector3` **gravity** = ``Vector3( 0, -9.8, 0 )`` .. rst-class:: classref-property-setget - void **set_gravity** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_gravity** **(** **)** Gravity applied to every particle. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_hue_variation: .. rst-class:: classref-property :ref:`float` **hue_variation** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Initial hue variation applied to each particle. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_hue_variation_curve: .. rst-class:: classref-property :ref:`Texture` **hue_variation_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's hue will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_hue_variation_random: .. rst-class:: classref-property :ref:`float` **hue_variation_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Hue variation randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_initial_velocity: .. rst-class:: classref-property :ref:`float` **initial_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Initial velocity magnitude for each particle. Direction comes from :ref:`spread` and the node's orientation. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_initial_velocity_random: .. rst-class:: classref-property :ref:`float` **initial_velocity_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Initial velocity randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_lifetime_randomness: .. rst-class:: classref-property :ref:`float` **lifetime_randomness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_lifetime_randomness** **(** :ref:`float` value **)** - :ref:`float` **get_lifetime_randomness** **(** **)** Particle lifetime randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_linear_accel: .. rst-class:: classref-property :ref:`float` **linear_accel** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Linear acceleration applied to each particle in the direction of motion. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_linear_accel_curve: .. rst-class:: classref-property :ref:`Texture` **linear_accel_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's linear acceleration will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_linear_accel_random: .. rst-class:: classref-property :ref:`float` **linear_accel_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Linear acceleration randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_orbit_velocity: .. rst-class:: classref-property :ref:`float` **orbit_velocity** .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. \ **Note:** Only available when :ref:`flag_disable_z` is ``true``. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_orbit_velocity_curve: .. rst-class:: classref-property :ref:`Texture` **orbit_velocity_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's orbital velocity will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_orbit_velocity_random: .. rst-class:: classref-property :ref:`float` **orbit_velocity_random** .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Orbital velocity randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_radial_accel: .. rst-class:: classref-property :ref:`float` **radial_accel** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Radial acceleration applied to each particle. Makes particle accelerate away from origin. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_radial_accel_curve: .. rst-class:: classref-property :ref:`Texture` **radial_accel_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's radial acceleration will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_radial_accel_random: .. rst-class:: classref-property :ref:`float` **radial_accel_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Radial acceleration randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_scale: .. rst-class:: classref-property :ref:`float` **scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Initial scale applied to each particle. This can be set to a negative value to flip the particle on all axes. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_scale_curve: .. rst-class:: classref-property :ref:`Texture` **scale_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's scale will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_scale_random: .. rst-class:: classref-property :ref:`float` **scale_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Scale randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_spread: .. rst-class:: classref-property :ref:`float` **spread** = ``45.0`` .. rst-class:: classref-property-setget - void **set_spread** **(** :ref:`float` value **)** - :ref:`float` **get_spread** **(** **)** Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_tangential_accel: .. rst-class:: classref-property :ref:`float` **tangential_accel** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_tangential_accel_curve: .. rst-class:: classref-property :ref:`Texture` **tangential_accel_curve** .. rst-class:: classref-property-setget - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_tangential_accel_random: .. rst-class:: classref-property :ref:`float` **tangential_accel_random** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Tangential acceleration randomness ratio. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_trail_color_modifier: .. rst-class:: classref-property :ref:`GradientTexture` **trail_color_modifier** .. rst-class:: classref-property-setget - void **set_trail_color_modifier** **(** :ref:`GradientTexture` value **)** - :ref:`GradientTexture` **get_trail_color_modifier** **(** **)** Trail particles' color will vary along this :ref:`GradientTexture`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_trail_divisor: .. rst-class:: classref-property :ref:`int` **trail_divisor** = ``1`` .. rst-class:: classref-property-setget - void **set_trail_divisor** **(** :ref:`int` value **)** - :ref:`int` **get_trail_divisor** **(** **)** Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_property_trail_size_modifier: .. rst-class:: classref-property :ref:`CurveTexture` **trail_size_modifier** .. rst-class:: classref-property-setget - void **set_trail_size_modifier** **(** :ref:`CurveTexture` value **)** - :ref:`CurveTexture` **get_trail_size_modifier** **(** **)** Trail particles' size will vary along this :ref:`CurveTexture`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ParticlesMaterial_method_get_flag: .. rst-class:: classref-method :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| Returns ``true`` if the specified flag is enabled. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_get_param: .. rst-class:: classref-method :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Returns the value of the specified parameter. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_get_param_randomness: .. rst-class:: classref-method :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Returns the randomness ratio associated with the specified parameter. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_get_param_texture: .. rst-class:: classref-method :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Returns the :ref:`Texture` used by the specified parameter. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_set_flag: .. rst-class:: classref-method void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** If ``true``, enables the specified flag. See :ref:`Flags` for options. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_set_param: .. rst-class:: classref-method void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** Sets the specified :ref:`Parameter`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_set_param_randomness: .. rst-class:: classref-method void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** Sets the randomness ratio for the specified :ref:`Parameter`. .. rst-class:: classref-item-separator ---- .. _class_ParticlesMaterial_method_set_param_texture: .. rst-class:: classref-method void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** Sets the :ref:`Texture` for the specified :ref:`Parameter`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`