.. 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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_color` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_color_ramp` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_emission_box_extents` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_emission_color_texture` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_emission_normal_texture` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_emission_point_count` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_emission_point_texture` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_emission_shape` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_emission_sphere_radius` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_flatness` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_spread` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GradientTexture` | :ref:`get_trail_color_modifier` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_trail_divisor` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CurveTexture` | :ref:`get_trail_size_modifier` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`Color` color **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color_ramp` **(** :ref:`Texture` ramp **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_box_extents` **(** :ref:`Vector3` extents **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_color_texture` **(** :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_normal_texture` **(** :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_point_count` **(** :ref:`int` point_count **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_point_texture` **(** :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_shape` **(** :ref:`int` shape **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_sphere_radius` **(** :ref:`float` radius **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flatness` **(** :ref:`float` amount **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_spread` **(** :ref:`float` degrees **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_trail_color_modifier` **(** :ref:`GradientTexture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_trail_divisor` **(** :ref:`int` divisor **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_trail_size_modifier` **(** :ref:`CurveTexture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`float` **angle** - :ref:`Texture` **angle_curve** - :ref:`float` **angle_random** - :ref:`float` **angular_velocity** - :ref:`Texture` **angular_velocity_curve** - :ref:`float` **angular_velocity_random** - :ref:`bool` **anim_loop** - :ref:`float` **anim_offset** - :ref:`Texture` **anim_offset_curve** - :ref:`float` **anim_offset_random** - :ref:`float` **anim_speed** - :ref:`Texture` **anim_speed_curve** - :ref:`float` **anim_speed_random** - :ref:`Color` **color** - :ref:`Texture` **color_ramp** - :ref:`float` **damping** - :ref:`Texture` **damping_curve** - :ref:`float` **damping_random** - :ref:`Vector3` **emission_box_extents** - :ref:`Texture` **emission_color_texture** - :ref:`Texture` **emission_normal_texture** - :ref:`int` **emission_point_count** - :ref:`Texture` **emission_point_texture** - :ref:`int` **emission_shape** - :ref:`float` **emission_sphere_radius** - :ref:`bool` **flag_align_y** - :ref:`bool` **flag_disable_z** - :ref:`bool` **flag_rotate_y** - :ref:`float` **flatness** - :ref:`Vector3` **gravity** - :ref:`float` **hue_variation** - :ref:`Texture` **hue_variation_curve** - :ref:`float` **hue_variation_random** - :ref:`float` **initial_velocity** - :ref:`float` **initial_velocity_random** - :ref:`float` **linear_accel** - :ref:`Texture` **linear_accel_curve** - :ref:`float` **linear_accel_random** - :ref:`float` **orbit_velocity** - :ref:`Texture` **orbit_velocity_curve** - :ref:`float` **orbit_velocity_random** - :ref:`float` **radial_accel** - :ref:`Texture` **radial_accel_curve** - :ref:`float` **radial_accel_random** - :ref:`float` **scale** - :ref:`Texture` **scale_curve** - :ref:`float` **scale_random** - :ref:`float` **spread** - :ref:`float` **tangential_accel** - :ref:`Texture` **tangential_accel_curve** - :ref:`float` **tangential_accel_random** - :ref:`GradientTexture` **trail_color_modifier** - :ref:`int` **trail_divisor** - :ref:`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** = **4** - **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` **get_color** **(** **)** const .. _class_ParticlesMaterial_get_color_ramp: - :ref:`Texture` **get_color_ramp** **(** **)** const .. _class_ParticlesMaterial_get_emission_box_extents: - :ref:`Vector3` **get_emission_box_extents** **(** **)** const .. _class_ParticlesMaterial_get_emission_color_texture: - :ref:`Texture` **get_emission_color_texture** **(** **)** const .. _class_ParticlesMaterial_get_emission_normal_texture: - :ref:`Texture` **get_emission_normal_texture** **(** **)** const .. _class_ParticlesMaterial_get_emission_point_count: - :ref:`int` **get_emission_point_count** **(** **)** const .. _class_ParticlesMaterial_get_emission_point_texture: - :ref:`Texture` **get_emission_point_texture** **(** **)** const .. _class_ParticlesMaterial_get_emission_shape: - :ref:`int` **get_emission_shape** **(** **)** const .. _class_ParticlesMaterial_get_emission_sphere_radius: - :ref:`float` **get_emission_sphere_radius** **(** **)** const .. _class_ParticlesMaterial_get_flag: - :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const .. _class_ParticlesMaterial_get_flatness: - :ref:`float` **get_flatness** **(** **)** const .. _class_ParticlesMaterial_get_gravity: - :ref:`Vector3` **get_gravity** **(** **)** const .. _class_ParticlesMaterial_get_param: - :ref:`float` **get_param** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_param_randomness: - :ref:`float` **get_param_randomness** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_param_texture: - :ref:`Texture` **get_param_texture** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_spread: - :ref:`float` **get_spread** **(** **)** const .. _class_ParticlesMaterial_get_trail_color_modifier: - :ref:`GradientTexture` **get_trail_color_modifier** **(** **)** const .. _class_ParticlesMaterial_get_trail_divisor: - :ref:`int` **get_trail_divisor** **(** **)** const .. _class_ParticlesMaterial_get_trail_size_modifier: - :ref:`CurveTexture` **get_trail_size_modifier** **(** **)** const .. _class_ParticlesMaterial_set_color: - void **set_color** **(** :ref:`Color` color **)** .. _class_ParticlesMaterial_set_color_ramp: - void **set_color_ramp** **(** :ref:`Texture` ramp **)** .. _class_ParticlesMaterial_set_emission_box_extents: - void **set_emission_box_extents** **(** :ref:`Vector3` extents **)** .. _class_ParticlesMaterial_set_emission_color_texture: - void **set_emission_color_texture** **(** :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_emission_normal_texture: - void **set_emission_normal_texture** **(** :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_emission_point_count: - void **set_emission_point_count** **(** :ref:`int` point_count **)** .. _class_ParticlesMaterial_set_emission_point_texture: - void **set_emission_point_texture** **(** :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_emission_shape: - void **set_emission_shape** **(** :ref:`int` shape **)** .. _class_ParticlesMaterial_set_emission_sphere_radius: - void **set_emission_sphere_radius** **(** :ref:`float` radius **)** .. _class_ParticlesMaterial_set_flag: - void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** .. _class_ParticlesMaterial_set_flatness: - void **set_flatness** **(** :ref:`float` amount **)** .. _class_ParticlesMaterial_set_gravity: - void **set_gravity** **(** :ref:`Vector3` accel_vec **)** .. _class_ParticlesMaterial_set_param: - void **set_param** **(** :ref:`int` param, :ref:`float` value **)** .. _class_ParticlesMaterial_set_param_randomness: - void **set_param_randomness** **(** :ref:`int` param, :ref:`float` randomness **)** .. _class_ParticlesMaterial_set_param_texture: - void **set_param_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_spread: - void **set_spread** **(** :ref:`float` degrees **)** .. _class_ParticlesMaterial_set_trail_color_modifier: - void **set_trail_color_modifier** **(** :ref:`GradientTexture` texture **)** .. _class_ParticlesMaterial_set_trail_divisor: - void **set_trail_divisor** **(** :ref:`int` divisor **)** .. _class_ParticlesMaterial_set_trail_size_modifier: - void **set_trail_size_modifier** **(** :ref:`CurveTexture` texture **)**