A CPU-based 2D particle emitter.
CPU-based 2D particle node used to create a variety of particle systems and effects.
See also GPUParticles2D, which provides the same functionality with hardware acceleration, but may not run on older devices.
Maximum animation offset that corresponds to frame index in the texture. 0 is the first frame, 1 is the last one. See CanvasItemMaterial.particles_animation.
Maximum particle animation speed. Animation speed of 1 means that the particles will make full 0 to 1 offset cycle during lifetime, 2 means 2 cycles etc.
With animation speed greater than 1, remember to enable CanvasItemMaterial.particles_anim_loop property if you want the animation to repeat.
Each particle's initial color. If texture is defined, it will be multiplied by this color.
The maximum rate at which particles lose velocity. For example value of 100 means that the particle will go from 100 velocity to 0 in 1 second.
Sets the Colors to modulate particles by when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.
Sets the direction the particles will be emitted in when using EMISSION_SHAPE_DIRECTED_POINTS.
Sets the initial positions to spawn particles when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.
The rectangle's extents if emission_shape is set to EMISSION_SHAPE_RECTANGLE.
The ring's inner radius if emission_shape is set to EMISSION_SHAPE_RING.
The ring's outer radius if emission_shape is set to EMISSION_SHAPE_RING.
The sphere's radius if emission_shape is set to EMISSION_SHAPE_SPHERE.
If true, particles are being emitted. emitting can be used to start and stop particles from emitting. However, if one_shot is true setting emitting to true will not restart the emission cycle until after all active particles finish processing. You can use the finished signal to be notified once all active particles finish processing.
How rapidly particles in an emission cycle are emitted. If greater than 0, there will be a gap in emissions before the next cycle begins.
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.
If true, 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 false, particles use global coordinates; they will not move or rotate along the CPUParticles2D node (and its parents) when it is moved or rotated.
If true, only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle's end.
Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
Each particle's horizontal scale will vary along this Curve. Should be a unit Curve.
split_scale must be enabled.
Each particle's vertical scale will vary along this Curve. Should be a unit Curve.
split_scale must be enabled.
Sets the random seed used by the particle system. Only effective if use_fixed_seed is true.
If true, the scale curve will be split into x and y components. See scale_curve_x and scale_curve_y.
Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
If true, particles will use the same seed for every simulation using the seed defined in seed. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode.
Sets this node's properties to match a given GPUParticles2D node with an assigned ParticleProcessMaterial.
Requests the particles to process for extra process time during a single frame.
process_time defines the time that the particles will process while emitting is on. process_time_residual defines the time that particles will process with emitting turned off for the simulation. When combined with speed_scale set to 0.0, this is useful to be able to seek a particle system timeline.
Restarts the particle emitter.
If keep_seed is true, the current random seed will be preserved. Useful for seeking and playback.
Emitted when all active particles have finished processing. When one_shot is disabled, particles will process continuously, so this is never emitted.
DRAW_ORDER_INDEX = 0Particles are drawn in the order emitted.
DRAW_ORDER_LIFETIME = 1Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front.
PARAM_INITIAL_LINEAR_VELOCITY = 0Use with set_param_min(), set_param_max(), and set_param_curve() to set initial velocity properties.
PARAM_ANGULAR_VELOCITY = 1Use with set_param_min(), set_param_max(), and set_param_curve() to set angular velocity properties.
PARAM_ORBIT_VELOCITY = 2Use with set_param_min(), set_param_max(), and set_param_curve() to set orbital velocity properties.
PARAM_LINEAR_ACCEL = 3Use with set_param_min(), set_param_max(), and set_param_curve() to set linear acceleration properties.
PARAM_RADIAL_ACCEL = 4Use with set_param_min(), set_param_max(), and set_param_curve() to set radial acceleration properties.
PARAM_TANGENTIAL_ACCEL = 5Use with set_param_min(), set_param_max(), and set_param_curve() to set tangential acceleration properties.
PARAM_DAMPING = 6Use with set_param_min(), set_param_max(), and set_param_curve() to set damping properties.
PARAM_ANGLE = 7Use with set_param_min(), set_param_max(), and set_param_curve() to set angle properties.
PARAM_SCALE = 8Use with set_param_min(), set_param_max(), and set_param_curve() to set scale properties.
PARAM_HUE_VARIATION = 9Use with set_param_min(), set_param_max(), and set_param_curve() to set hue variation properties.
PARAM_ANIM_SPEED = 10Use with set_param_min(), set_param_max(), and set_param_curve() to set animation speed properties.
PARAM_ANIM_OFFSET = 11Use with set_param_min(), set_param_max(), and set_param_curve() to set animation offset properties.
PARAM_MAX = 12Represents the size of the Parameter enum.
PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY = 0Use with set_particle_flag() to set particle_flag_align_y.
PARTICLE_FLAG_ROTATE_Y = 1Present for consistency with 3D particle nodes, not used in 2D.
PARTICLE_FLAG_DISABLE_Z = 2Present for consistency with 3D particle nodes, not used in 2D.
PARTICLE_FLAG_MAX = 3Represents the size of the ParticleFlags enum.
EMISSION_SHAPE_POINT = 0All particles will be emitted from a single point.
EMISSION_SHAPE_SPHERE = 1Particles will be emitted in the volume of a sphere flattened to two dimensions.
EMISSION_SHAPE_SPHERE_SURFACE = 2Particles will be emitted on the surface of a sphere flattened to two dimensions.
EMISSION_SHAPE_RECTANGLE = 3Particles will be emitted in the area of a rectangle.
EMISSION_SHAPE_POINTS = 4Particles will be emitted at a position chosen randomly among emission_points. Particle color will be modulated by emission_colors.
EMISSION_SHAPE_DIRECTED_POINTS = 5Particles will be emitted at a position chosen randomly among emission_points. Particle velocity and rotation will be set based on emission_normals. Particle color will be modulated by emission_colors.
EMISSION_SHAPE_RING = 6Particles will be emitted in the area of a ring parameterized by its outer and inner radius.
EMISSION_SHAPE_MAX = 7Represents the size of the EmissionShape enum.