2018-08-29 22:25:11 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 10:08:05 +02:00
<class name= "CPUParticles2D" inherits= "Node2D" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2018-08-29 22:25:11 +02:00
<brief_description >
2023-06-24 13:19:58 +02:00
A CPU-based 2D particle emitter.
2018-08-29 22:25:11 +02:00
</brief_description>
<description >
2019-06-14 02:13:37 +02:00
CPU-based 2D particle node used to create a variety of particle systems and effects.
2020-03-30 18:22:57 +02:00
See also [GPUParticles2D], which provides the same functionality with hardware acceleration, but may not run on older devices.
2018-08-29 22:25:11 +02:00
</description>
<tutorials >
2021-11-15 10:43:07 +01:00
<link title= "Particle systems (2D)" > $DOCS_URL/tutorials/2d/particle_systems_2d.html</link>
2018-08-29 22:25:11 +02:00
</tutorials>
<methods >
<method name= "convert_from_particles" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "particles" type= "Node" />
2018-08-29 22:25:11 +02:00
<description >
2022-08-18 11:09:22 +02:00
Sets this node's properties to match a given [GPUParticles2D] node with an assigned [ParticleProcessMaterial].
2018-08-29 22:25:11 +02:00
</description>
</method>
2021-07-13 19:46:27 +02:00
<method name= "get_param_curve" qualifiers= "const" >
<return type= "Curve" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "param" type= "int" enum= "CPUParticles2D.Parameter" />
2019-06-27 16:10:09 +02:00
<description >
2021-07-13 19:46:27 +02:00
Returns the [Curve] of the parameter specified by [enum Parameter].
2019-06-27 16:10:09 +02:00
</description>
</method>
2021-07-13 19:46:27 +02:00
<method name= "get_param_max" qualifiers= "const" >
<return type= "float" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "param" type= "int" enum= "CPUParticles2D.Parameter" />
2019-06-27 16:10:09 +02:00
<description >
2022-10-06 21:59:48 +02:00
Returns the maximum value range for the given parameter.
2019-06-27 16:10:09 +02:00
</description>
</method>
2021-07-13 19:46:27 +02:00
<method name= "get_param_min" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "float" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "param" type= "int" enum= "CPUParticles2D.Parameter" />
2019-06-27 16:10:09 +02:00
<description >
2022-10-06 21:59:48 +02:00
Returns the minimum value range for the given parameter.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name= "get_particle_flag" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "particle_flag" type= "int" enum= "CPUParticles2D.ParticleFlags" />
2019-06-27 16:10:09 +02:00
<description >
2020-12-05 00:35:57 +01:00
Returns the enabled state of the given flag (see [enum ParticleFlags] for options).
2019-06-27 16:10:09 +02:00
</description>
</method>
2018-08-29 22:25:11 +02:00
<method name= "restart" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2018-08-29 22:25:11 +02:00
<description >
2019-06-14 02:13:37 +02:00
Restarts the particle emitter.
2018-08-29 22:25:11 +02:00
</description>
</method>
2021-07-13 19:46:27 +02:00
<method name= "set_param_curve" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "param" type= "int" enum= "CPUParticles2D.Parameter" />
<param index= "1" name= "curve" type= "Curve" />
2019-06-27 16:10:09 +02:00
<description >
2021-07-13 19:46:27 +02:00
Sets the [Curve] of the parameter specified by [enum Parameter].
2019-06-27 16:10:09 +02:00
</description>
</method>
2021-07-13 19:46:27 +02:00
<method name= "set_param_max" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "param" type= "int" enum= "CPUParticles2D.Parameter" />
<param index= "1" name= "value" type= "float" />
2019-06-27 16:10:09 +02:00
<description >
2022-10-06 21:59:48 +02:00
Sets the maximum value for the given parameter.
2019-06-27 16:10:09 +02:00
</description>
</method>
2021-07-13 19:46:27 +02:00
<method name= "set_param_min" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "param" type= "int" enum= "CPUParticles2D.Parameter" />
<param index= "1" name= "value" type= "float" />
2019-06-27 16:10:09 +02:00
<description >
2022-10-06 21:59:48 +02:00
Sets the minimum value for the given parameter.
2019-06-27 16:10:09 +02:00
</description>
</method>
<method name= "set_particle_flag" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "particle_flag" type= "int" enum= "CPUParticles2D.ParticleFlags" />
<param index= "1" name= "enable" type= "bool" />
2019-06-27 16:10:09 +02:00
<description >
2020-12-05 00:35:57 +01:00
Enables or disables the given flag (see [enum ParticleFlags] for options).
2019-06-27 16:10:09 +02:00
</description>
</method>
2018-08-29 22:25:11 +02:00
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "amount" type= "int" setter= "set_amount" getter= "get_amount" default= "8" >
2019-06-14 02:13:37 +02:00
Number of particles emitted in one emission cycle.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "angle_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's rotation will be animated along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "angle_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum initial rotation applied to each particle, in degrees.
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "angle_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member angle_max].
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "angular_velocity_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's angular velocity will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "angular_velocity_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "angular_velocity_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member angular_velocity_max].
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "anim_offset_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's animation offset will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "anim_offset_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum animation offset that corresponds to frame index in the texture. [code]0[/code] is the first frame, [code]1[/code] is the last one. See [member CanvasItemMaterial.particles_animation].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "anim_offset_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member anim_offset_max].
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "anim_speed_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's animation speed will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "anim_speed_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum particle animation speed. Animation speed of [code]1[/code] means that the particles will make full [code]0[/code] to [code]1[/code] offset cycle during lifetime, [code]2[/code] means [code]2[/code] cycles etc.
With animation speed greater than [code]1[/code], remember to enable [member CanvasItemMaterial.particles_anim_loop] property if you want the animation to repeat.
2021-07-13 19:46:27 +02:00
</member>
<member name= "anim_speed_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member anim_speed_max].
2018-08-29 22:25:11 +02:00
</member>
2024-02-21 18:51:08 +01:00
<member name= "color" type= "Color" setter= "set_color" getter= "get_color" default= "Color(1, 1, 1, 1)" keywords= "colour" >
2019-06-14 02:13:37 +02:00
Each particle's initial color. If [member texture] is defined, it will be multiplied by this color.
2018-08-29 22:25:11 +02:00
</member>
2021-11-23 13:50:35 +01:00
<member name= "color_initial_ramp" type= "Gradient" setter= "set_color_initial_ramp" getter= "get_color_initial_ramp" >
Each particle's initial color will vary along this [GradientTexture1D] (multiplied with [member color]).
</member>
2019-07-15 20:42:47 +02:00
<member name= "color_ramp" type= "Gradient" setter= "set_color_ramp" getter= "get_color_ramp" >
2021-07-04 02:14:31 +02:00
Each particle's color will vary along this [Gradient] (multiplied with [member color]).
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "damping_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Damping will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "damping_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
The maximum rate at which particles lose velocity. For example value of [code]100[/code] means that the particle will go from [code]100[/code] velocity to [code]0[/code] in [code]1[/code] second.
2021-07-13 19:46:27 +02:00
</member>
<member name= "damping_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member damping_max].
2018-08-29 22:25:11 +02:00
</member>
2019-09-24 19:45:03 +02:00
<member name= "direction" type= "Vector2" setter= "set_direction" getter= "get_direction" default= "Vector2(1, 0)" >
2019-07-02 12:04:26 +02:00
Unit vector specifying the particles' emission direction.
</member>
2019-06-29 12:38:01 +02:00
<member name= "draw_order" type= "int" setter= "set_draw_order" getter= "get_draw_order" enum= "CPUParticles2D.DrawOrder" default= "0" >
2019-06-29 15:24:23 +02:00
Particle draw order. Uses [enum DrawOrder] values.
2018-08-29 22:25:11 +02:00
</member>
2020-02-18 13:59:24 +01:00
<member name= "emission_colors" type= "PackedColorArray" setter= "set_emission_colors" getter= "get_emission_colors" >
2020-01-26 06:59:51 +01:00
Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
2018-08-29 22:25:11 +02:00
</member>
2020-02-18 13:59:24 +01:00
<member name= "emission_normals" type= "PackedVector2Array" setter= "set_emission_normals" getter= "get_emission_normals" >
2020-01-26 06:59:51 +01:00
Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS].
2018-08-29 22:25:11 +02:00
</member>
2020-02-18 13:59:24 +01:00
<member name= "emission_points" type= "PackedVector2Array" setter= "set_emission_points" getter= "get_emission_points" >
2020-01-26 06:59:51 +01:00
Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 21:22:15 +02:00
<member name= "emission_rect_extents" type= "Vector2" setter= "set_emission_rect_extents" getter= "get_emission_rect_extents" >
2019-06-15 00:04:55 +02:00
The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE].
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "emission_shape" type= "int" setter= "set_emission_shape" getter= "get_emission_shape" enum= "CPUParticles2D.EmissionShape" default= "0" >
2019-06-29 15:24:23 +02:00
Particles will be emitted inside this region. See [enum EmissionShape] for possible values.
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 21:22:15 +02:00
<member name= "emission_sphere_radius" type= "float" setter= "set_emission_sphere_radius" getter= "get_emission_sphere_radius" >
2019-06-18 15:07:31 +02:00
The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE].
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "emitting" type= "bool" setter= "set_emitting" getter= "is_emitting" default= "true" >
2023-07-20 22:03:59 +02:00
If [code]true[/code], particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is [code]true[/code] setting [member emitting] to [code]true[/code] will not restart the emission cycle until after all active particles finish processing. You can use the [signal finished] signal to be notified once all active particles finish processing.
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "explosiveness" type= "float" setter= "set_explosiveness_ratio" getter= "get_explosiveness_ratio" default= "0.0" >
2019-06-29 15:24:23 +02:00
How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins.
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "fixed_fps" type= "int" setter= "set_fixed_fps" getter= "get_fixed_fps" default= "0" >
2022-10-20 04:09:17 +02:00
The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself.
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "fract_delta" type= "bool" setter= "set_fractional_delta" getter= "get_fractional_delta" default= "true" >
2019-06-29 15:24:23 +02:00
If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect.
2018-08-29 22:25:11 +02:00
</member>
2019-09-24 19:45:03 +02:00
<member name= "gravity" type= "Vector2" setter= "set_gravity" getter= "get_gravity" default= "Vector2(0, 980)" >
2019-06-29 15:24:23 +02:00
Gravity applied to every particle.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "hue_variation_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's hue will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "hue_variation_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
2021-07-13 19:46:27 +02:00
</member>
<member name= "hue_variation_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member hue_variation_max].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "initial_velocity_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum initial velocity magnitude for each particle. Direction comes from [member direction] and [member spread].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "initial_velocity_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member initial_velocity_max].
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "lifetime" type= "float" setter= "set_lifetime" getter= "get_lifetime" default= "1.0" >
2019-06-29 15:24:23 +02:00
Amount of time each particle will exist.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 06:48:20 +02:00
<member name= "lifetime_randomness" type= "float" setter= "set_lifetime_randomness" getter= "get_lifetime_randomness" default= "0.0" >
Particle lifetime randomness ratio.
</member>
2019-07-15 20:42:47 +02:00
<member name= "linear_accel_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's linear acceleration will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "linear_accel_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum linear acceleration applied to each particle in the direction of motion.
2021-07-13 19:46:27 +02:00
</member>
<member name= "linear_accel_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member linear_accel_max].
2018-08-29 22:25:11 +02:00
</member>
2022-06-09 17:38:07 +02:00
<member name= "local_coords" type= "bool" setter= "set_use_local_coordinates" getter= "get_use_local_coordinates" default= "false" >
If [code]true[/code], particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the [CPUParticles2D] node (and its parents) when it is moved or rotated. If [code]false[/code], particles use global coordinates; they will not move or rotate along the [CPUParticles2D] node (and its parents) when it is moved or rotated.
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "one_shot" type= "bool" setter= "set_one_shot" getter= "get_one_shot" default= "false" >
2019-06-29 15:24:23 +02:00
If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "orbit_velocity_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's orbital velocity will vary along this [Curve].
2019-06-11 17:47:24 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "orbit_velocity_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
2021-07-13 19:46:27 +02:00
</member>
<member name= "orbit_velocity_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member orbit_velocity_max].
2019-06-11 17:47:24 +02:00
</member>
2020-12-05 00:35:57 +01:00
<member name= "particle_flag_align_y" type= "bool" setter= "set_particle_flag" getter= "get_particle_flag" default= "false" >
Align Y axis of particle with the direction of its velocity.
</member>
2019-06-29 12:38:01 +02:00
<member name= "preprocess" type= "float" setter= "set_pre_process_time" getter= "get_pre_process_time" default= "0.0" >
2019-06-14 02:13:37 +02:00
Particle system starts as if it had already run for this many seconds.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "radial_accel_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's radial acceleration will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "radial_accel_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
2021-07-13 19:46:27 +02:00
</member>
<member name= "radial_accel_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member radial_accel_max].
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "randomness" type= "float" setter= "set_randomness_ratio" getter= "get_randomness_ratio" default= "0.0" >
2019-06-29 15:24:23 +02:00
Emission lifetime randomness ratio.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "scale_amount_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's scale will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "scale_amount_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "1.0" >
2022-10-06 21:59:48 +02:00
Maximum initial scale applied to each particle.
2021-07-13 19:46:27 +02:00
</member>
<member name= "scale_amount_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "1.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member scale_amount_max].
2021-07-13 19:46:27 +02:00
</member>
<member name= "scale_curve_x" type= "Curve" setter= "set_scale_curve_x" getter= "get_scale_curve_x" >
2022-10-06 21:59:48 +02:00
Each particle's horizontal scale will vary along this [Curve].
[member split_scale] must be enabled.
2021-07-13 19:46:27 +02:00
</member>
<member name= "scale_curve_y" type= "Curve" setter= "set_scale_curve_y" getter= "get_scale_curve_y" >
2022-10-06 21:59:48 +02:00
Each particle's vertical scale will vary along this [Curve].
[member split_scale] must be enabled.
2018-08-29 22:25:11 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "speed_scale" type= "float" setter= "set_speed_scale" getter= "get_speed_scale" default= "1.0" >
2019-06-29 15:24:23 +02:00
Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "split_scale" type= "bool" setter= "set_split_scale" getter= "get_split_scale" default= "false" >
2022-10-06 21:59:48 +02:00
If [code]true[/code], the scale curve will be split into x and y components. See [member scale_curve_x] and [member scale_curve_y].
2021-07-13 19:46:27 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "spread" type= "float" setter= "set_spread" getter= "get_spread" default= "45.0" >
2019-06-29 15:24:23 +02:00
Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees.
2018-08-29 22:25:11 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "tangential_accel_curve" type= "Curve" setter= "set_param_curve" getter= "get_param_curve" >
2019-06-14 02:13:37 +02:00
Each particle's tangential acceleration will vary along this [Curve].
2018-08-29 22:25:11 +02:00
</member>
2021-07-13 19:46:27 +02:00
<member name= "tangential_accel_max" type= "float" setter= "set_param_max" getter= "get_param_max" default= "0.0" >
2022-10-06 21:59:48 +02:00
Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
2021-07-13 19:46:27 +02:00
</member>
<member name= "tangential_accel_min" type= "float" setter= "set_param_min" getter= "get_param_min" default= "0.0" >
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member tangential_accel_max].
2018-08-29 22:25:11 +02:00
</member>
2020-02-12 09:59:06 +01:00
<member name= "texture" type= "Texture2D" setter= "set_texture" getter= "get_texture" >
2019-06-22 01:04:47 +02:00
Particle texture. If [code]null[/code], particles will be squares.
2018-08-29 22:25:11 +02:00
</member>
</members>
2023-05-09 10:18:08 +02:00
<signals >
<signal name= "finished" >
<description >
Emitted when all active particles have finished processing. When [member one_shot] is disabled, particles will process continuously, so this is never emitted.
</description>
</signal>
</signals>
2018-08-29 22:25:11 +02:00
<constants >
<constant name= "DRAW_ORDER_INDEX" value= "0" enum= "DrawOrder" >
2019-06-14 02:13:37 +02:00
Particles are drawn in the order emitted.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "DRAW_ORDER_LIFETIME" value= "1" enum= "DrawOrder" >
2023-10-05 18:41:05 +02:00
Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front.
2019-06-15 00:04:55 +02:00
</constant>
2018-08-29 22:25:11 +02:00
<constant name= "PARAM_INITIAL_LINEAR_VELOCITY" value= "0" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set initial velocity properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_ANGULAR_VELOCITY" value= "1" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set angular velocity properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_ORBIT_VELOCITY" value= "2" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set orbital velocity properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_LINEAR_ACCEL" value= "3" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set linear acceleration properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_RADIAL_ACCEL" value= "4" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set radial acceleration properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_TANGENTIAL_ACCEL" value= "5" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set tangential acceleration properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_DAMPING" value= "6" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set damping properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_ANGLE" value= "7" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set angle properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_SCALE" value= "8" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set scale properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_HUE_VARIATION" value= "9" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set hue variation properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_ANIM_SPEED" value= "10" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set animation speed properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_ANIM_OFFSET" value= "11" enum= "Parameter" >
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set animation offset properties.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "PARAM_MAX" value= "12" enum= "Parameter" >
2019-06-14 02:13:37 +02:00
Represents the size of the [enum Parameter] enum.
2018-08-29 22:25:11 +02:00
</constant>
2020-12-05 00:35:57 +01:00
<constant name= "PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY" value= "0" enum= "ParticleFlags" >
Use with [method set_particle_flag] to set [member particle_flag_align_y].
2018-08-29 22:25:11 +02:00
</constant>
2020-12-05 00:35:57 +01:00
<constant name= "PARTICLE_FLAG_ROTATE_Y" value= "1" enum= "ParticleFlags" >
2019-06-15 00:04:55 +02:00
Present for consistency with 3D particle nodes, not used in 2D.
2019-06-11 17:47:24 +02:00
</constant>
2020-12-05 00:35:57 +01:00
<constant name= "PARTICLE_FLAG_DISABLE_Z" value= "2" enum= "ParticleFlags" >
2019-06-15 00:04:55 +02:00
Present for consistency with 3D particle nodes, not used in 2D.
2019-06-11 17:47:24 +02:00
</constant>
2020-12-05 00:35:57 +01:00
<constant name= "PARTICLE_FLAG_MAX" value= "3" enum= "ParticleFlags" >
Represents the size of the [enum ParticleFlags] enum.
2018-08-29 22:25:11 +02:00
</constant>
<constant name= "EMISSION_SHAPE_POINT" value= "0" enum= "EmissionShape" >
2019-06-14 02:13:37 +02:00
All particles will be emitted from a single point.
2018-08-29 22:25:11 +02:00
</constant>
2019-06-17 20:59:31 +02:00
<constant name= "EMISSION_SHAPE_SPHERE" value= "1" enum= "EmissionShape" >
2021-11-27 23:28:53 +01:00
Particles will be emitted in the volume of a sphere flattened to two dimensions.
</constant>
<constant name= "EMISSION_SHAPE_SPHERE_SURFACE" value= "2" enum= "EmissionShape" >
2019-06-18 15:07:31 +02:00
Particles will be emitted on the surface of a sphere flattened to two dimensions.
2018-08-29 22:25:11 +02:00
</constant>
2021-11-27 23:28:53 +01:00
<constant name= "EMISSION_SHAPE_RECTANGLE" value= "3" enum= "EmissionShape" >
2019-06-14 02:13:37 +02:00
Particles will be emitted in the area of a rectangle.
2018-08-29 22:25:11 +02:00
</constant>
2021-11-27 23:28:53 +01:00
<constant name= "EMISSION_SHAPE_POINTS" value= "4" enum= "EmissionShape" >
2019-06-15 00:04:55 +02:00
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors].
2018-08-29 22:25:11 +02:00
</constant>
2021-11-27 23:28:53 +01:00
<constant name= "EMISSION_SHAPE_DIRECTED_POINTS" value= "5" enum= "EmissionShape" >
2019-06-15 00:04:55 +02:00
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors].
2018-08-29 22:25:11 +02:00
</constant>
2021-11-27 23:28:53 +01:00
<constant name= "EMISSION_SHAPE_MAX" value= "6" enum= "EmissionShape" >
2020-01-19 10:18:09 +01:00
Represents the size of the [enum EmissionShape] enum.
2020-01-16 10:59:01 +01:00
</constant>
2018-08-29 22:25:11 +02:00
</constants>
</class>