CPUParticles2D

Inherits: Node2D < CanvasItem < Node < Object

CPU-based 2D particle emitter.

Description

CPU-based 2D particle node used to create a variety of particle systems and effects.

See also Particles2D, which provides the same functionality with hardware acceleration, but may not run on older devices.

Methods

voidconvert_from_particles ( Node particles )
floatget_param ( Parameter param ) const
Curveget_param_curve ( Parameter param ) const
floatget_param_randomness ( Parameter param ) const
boolget_particle_flag ( Flags flag ) const
voidrestart ( )
voidset_param ( Parameter param, float value )
voidset_param_curve ( Parameter param, Curve curve )
voidset_param_randomness ( Parameter param, float randomness )
voidset_particle_flag ( Flags flag, bool enable )

Enumerations

enum DrawOrder:

  • DRAW_ORDER_INDEX = 0 — Particles are drawn in the order emitted.
  • DRAW_ORDER_LIFETIME = 1 — Particles are drawn in order of remaining lifetime.

enum Parameter:


enum Flags:

  • FLAG_ALIGN_Y_TO_VELOCITY = 0 — Use with set_particle_flag to set flag_align_y.
  • FLAG_ROTATE_Y = 1 — Present for consistency with 3D particle nodes, not used in 2D.
  • FLAG_DISABLE_Z = 2 — Present for consistency with 3D particle nodes, not used in 2D.
  • FLAG_MAX = 3 — Represents the size of the Flags enum.

enum EmissionShape:

  • EMISSION_SHAPE_POINT = 0 — All particles will be emitted from a single point.
  • EMISSION_SHAPE_SPHERE = 1 — Particles will be emitted on the surface of a sphere flattened to two dimensions.
  • EMISSION_SHAPE_RECTANGLE = 2 — Particles will be emitted in the area of a rectangle.
  • EMISSION_SHAPE_POINTS = 3 — Particles will be emitted at a position chosen randomly among emission_points. Particle color will be modulated by emission_colors.
  • EMISSION_SHAPE_DIRECTED_POINTS = 4 — Particles 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_MAX = 5 — Represents the size of the EmissionShape enum.

Property Descriptions

Default8
Setterset_amount(value)
Getterget_amount()

Number of particles emitted in one emission cycle.


Default0.0
Setterset_param(value)
Getterget_param()

Initial rotation applied to each particle, in degrees.


Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s rotation will be animated along this Curve.


Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Rotation randomness ratio.


Default0.0
Setterset_param(value)
Getterget_param()

Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.


  • Curve angular_velocity_curve
Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s angular velocity will vary along this Curve.


  • float angular_velocity_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Angular velocity randomness ratio.


Default0.0
Setterset_param(value)
Getterget_param()

Particle animation offset.


Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s animation offset will vary along this Curve.


Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Animation offset randomness ratio.


Default0.0
Setterset_param(value)
Getterget_param()

Particle animation speed.


Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s animation speed will vary along this Curve.


Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Animation speed randomness ratio.


DefaultColor( 1, 1, 1, 1 )
Setterset_color(value)
Getterget_color()

Each particle’s initial color. If Texture is defined, it will be multiplied by this color.


Setterset_color_ramp(value)
Getterget_color_ramp()

Each particle’s color will vary along this Gradient.


Default0.0
Setterset_param(value)
Getterget_param()

The rate at which particles lose velocity.


Setterset_param_curve(value)
Getterget_param_curve()

Damping will vary along this Curve.


Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Damping randomness ratio.


DefaultVector2( 1, 0 )
Setterset_direction(value)
Getterget_direction()

Unit vector specifying the particles’ emission direction.


Default0
Setterset_draw_order(value)
Getterget_draw_order()

Particle draw order. Uses DrawOrder values.


Setterset_emission_colors(value)
Getterget_emission_colors()

Sets the Colors to modulate particles by when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.


Setterset_emission_normals(value)
Getterget_emission_normals()

Sets the direction the particles will be emitted in when using EMISSION_SHAPE_DIRECTED_POINTS.


Setterset_emission_points(value)
Getterget_emission_points()

Sets the initial positions to spawn particles when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.


Setterset_emission_rect_extents(value)
Getterget_emission_rect_extents()

The rectangle’s extents if emission_shape is set to EMISSION_SHAPE_RECTANGLE.


Default0
Setterset_emission_shape(value)
Getterget_emission_shape()

Particles will be emitted inside this region. See EmissionShape for possible values.


  • float emission_sphere_radius
Setterset_emission_sphere_radius(value)
Getterget_emission_sphere_radius()

The sphere’s radius if emission_shape is set to EMISSION_SHAPE_SPHERE.


Defaulttrue
Setterset_emitting(value)
Getteris_emitting()

If true, particles are being emitted.


Default0.0
Setterset_explosiveness_ratio(value)
Getterget_explosiveness_ratio()

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.


Default0
Setterset_fixed_fps(value)
Getterget_fixed_fps()

The particle system’s frame rate is fixed to a value. For instance, 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.


Defaultfalse
Setterset_particle_flag(value)
Getterget_particle_flag()

Align Y axis of particle with the direction of its velocity.


Defaulttrue
Setterset_fractional_delta(value)
Getterget_fractional_delta()

If true, results in fractional delta calculation which has a smoother particles display effect.


DefaultVector2( 0, 98 )
Setterset_gravity(value)
Getterget_gravity()

Gravity applied to every particle.


Default0.0
Setterset_param(value)
Getterget_param()

Initial hue variation applied to each particle.


  • Curve hue_variation_curve
Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s hue will vary along this Curve.


  • float hue_variation_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Hue variation randomness ratio.


Default0.0
Setterset_param(value)
Getterget_param()

Initial velocity magnitude for each particle. Direction comes from spread and the node’s orientation.


  • float initial_velocity_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Initial velocity randomness ratio.


Default1.0
Setterset_lifetime(value)
Getterget_lifetime()

Amount of time each particle will exist.


  • float lifetime_randomness
Default0.0
Setterset_lifetime_randomness(value)
Getterget_lifetime_randomness()

Particle lifetime randomness ratio.


Default0.0
Setterset_param(value)
Getterget_param()

Linear acceleration applied to each particle in the direction of motion.


Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s linear acceleration will vary along this Curve.


  • float linear_accel_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Linear acceleration randomness ratio.


Defaulttrue
Setterset_use_local_coordinates(value)
Getterget_use_local_coordinates()

If true, particles use the parent node’s coordinate space. If false, they use global coordinates.


Setterset_normalmap(value)
Getterget_normalmap()

Normal map to be used for the Texture property.


Defaultfalse
Setterset_one_shot(value)
Getterget_one_shot()

If true, only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle’s end.


Default0.0
Setterset_param(value)
Getterget_param()

Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.


  • Curve orbit_velocity_curve
Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s orbital velocity will vary along this Curve.


  • float orbit_velocity_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Orbital velocity randomness ratio.


Default0.0
Setterset_pre_process_time(value)
Getterget_pre_process_time()

Particle system starts as if it had already run for this many seconds.


Default0.0
Setterset_param(value)
Getterget_param()

Radial acceleration applied to each particle. Makes particle accelerate away from origin.


Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s radial acceleration will vary along this Curve.


  • float radial_accel_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Radial acceleration randomness ratio.


Default0.0
Setterset_randomness_ratio(value)
Getterget_randomness_ratio()

Emission lifetime randomness ratio.


Default1.0
Setterset_param(value)
Getterget_param()

Initial scale applied to each particle.


Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s scale will vary along this Curve.


  • float scale_amount_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Scale randomness ratio.


Default1.0
Setterset_speed_scale(value)
Getterget_speed_scale()

Particle system’s running speed scaling ratio. A value of 0 can be used to pause the particles.


Default45.0
Setterset_spread(value)
Getterget_spread()

Each particle’s initial direction range from +spread to -spread degrees.


Default0.0
Setterset_param(value)
Getterget_param()

Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle’s velocity giving the particles a swirling motion.


  • Curve tangential_accel_curve
Setterset_param_curve(value)
Getterget_param_curve()

Each particle’s tangential acceleration will vary along this Curve.


  • float tangential_accel_random
Default0.0
Setterset_param_randomness(value)
Getterget_param_randomness()

Tangential acceleration randomness ratio.


Setterset_texture(value)
Getterget_texture()

Particle texture. If null, particles will be squares.

Method Descriptions

  • void convert_from_particles ( Node particles )

Sets this node’s properties to match a given Particles2D node with an assigned ParticlesMaterial.


Returns the base value of the parameter specified by Parameter.


Returns the Curve of the parameter specified by Parameter.


Returns the randomness factor of the parameter specified by Parameter.


Returns the enabled state of the given flag (see Flags for options).


  • void restart ( )

Restarts the particle emitter.


Sets the base value of the parameter specified by Parameter.


Sets the Curve of the parameter specified by Parameter.


Sets the randomness factor of the parameter specified by Parameter.


  • void set_particle_flag ( Flags flag, bool enable )

Enables or disables the given flag (see Flags for options).

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:30:57. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.