CPUParticles

Inherits: GeometryInstance < VisualInstance < Spatial < Node < Object

CPU-based 3D particle emitter.

Description

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

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

Properties

int amount 8
float angle 0.0
Curve angle_curve  
float angle_random 0.0
float angular_velocity 0.0
Curve angular_velocity_curve  
float angular_velocity_random 0.0
float anim_offset 0.0
Curve anim_offset_curve  
float anim_offset_random 0.0
float anim_speed 0.0
Curve anim_speed_curve  
float anim_speed_random 0.0
Color color Color( 1, 1, 1, 1 )
Gradient color_ramp  
float damping 0.0
Curve damping_curve  
float damping_random 0.0
Vector3 direction Vector3( 1, 0, 0 )
DrawOrder draw_order 0
Vector3 emission_box_extents  
PoolColorArray emission_colors PoolColorArray(  )
PoolVector3Array emission_normals  
PoolVector3Array emission_points PoolVector3Array(  )
EmissionShape emission_shape 0
float emission_sphere_radius  
bool emitting true
float explosiveness 0.0
int fixed_fps 0
bool flag_align_y false
bool flag_disable_z false
bool flag_rotate_y false
float flatness 0.0
bool fract_delta true
Vector3 gravity Vector3( 0, -9.8, 0 )
float hue_variation 0.0
Curve hue_variation_curve  
float hue_variation_random 0.0
float initial_velocity 0.0
float initial_velocity_random 0.0
float lifetime 1.0
float lifetime_randomness 0.0
float linear_accel 0.0
Curve linear_accel_curve  
float linear_accel_random 0.0
bool local_coords true
Mesh mesh  
bool one_shot false
float orbit_velocity  
Curve orbit_velocity_curve  
float orbit_velocity_random  
float preprocess 0.0
float radial_accel 0.0
Curve radial_accel_curve  
float radial_accel_random 0.0
float randomness 0.0
float scale_amount 1.0
Curve scale_amount_curve  
float scale_amount_random 0.0
float speed_scale 1.0
float spread 45.0
float tangential_accel 0.0
Curve tangential_accel_curve  
float tangential_accel_random 0.0

Methods

void convert_from_particles ( Node particles )
float get_param ( Parameter param ) const
Curve get_param_curve ( Parameter param ) const
float get_param_randomness ( Parameter param ) const
bool get_particle_flag ( Flags flag ) const
void restart ( )
void set_param ( Parameter param, float value )
void set_param_curve ( Parameter param, Curve curve )
void set_param_randomness ( Parameter param, float randomness )
void set_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.
  • DRAW_ORDER_VIEW_DEPTH = 2 — Particles are drawn in order of depth.

enum Parameter:

enum Flags:

enum EmissionShape:

  • EMISSION_SHAPE_POINT = 0 — All particles will be emitted from a single point.
  • EMISSION_SHAPE_SPHERE = 1 — Particles will be emitted in the volume of a sphere.
  • EMISSION_SHAPE_BOX = 2 — Particles will be emitted in the volume of a box.
  • 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

Default 8
Setter set_amount(value)
Getter get_amount()

Number of particles emitted in one emission cycle.

Default 0.0
Setter set_param(value)
Getter get_param()

Initial rotation applied to each particle, in degrees.

Setter set_param_curve(value)
Getter get_param_curve()

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

Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Rotation randomness ratio.

Default 0.0
Setter set_param(value)
Getter get_param()

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

  • Curve angular_velocity_curve
Setter set_param_curve(value)
Getter get_param_curve()

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

  • float angular_velocity_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Angular velocity randomness ratio.

Default 0.0
Setter set_param(value)
Getter get_param()

Particle animation offset.

  • Curve anim_offset_curve
Setter set_param_curve(value)
Getter get_param_curve()

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

  • float anim_offset_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Animation offset randomness ratio.

Default 0.0
Setter set_param(value)
Getter get_param()

Particle animation speed.

Setter set_param_curve(value)
Getter get_param_curve()

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

  • float anim_speed_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Animation speed randomness ratio.

Default Color( 1, 1, 1, 1 )
Setter set_color(value)
Getter get_color()

Unused for 3D particles.

Setter set_color_ramp(value)
Getter get_color_ramp()

Unused for 3D particles.

Default 0.0
Setter set_param(value)
Getter get_param()

The rate at which particles lose velocity.

Setter set_param_curve(value)
Getter get_param_curve()

Damping will vary along this Curve.

Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Damping randomness ratio.

Default Vector3( 1, 0, 0 )
Setter set_direction(value)
Getter get_direction()

Unit vector specifying the particles’ emission direction.

Default 0
Setter set_draw_order(value)
Getter get_draw_order()

Particle draw order. Uses DrawOrder values.

Setter set_emission_box_extents(value)
Getter get_emission_box_extents()

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

Default PoolColorArray(  )
Setter set_emission_colors(value)
Getter get_emission_colors()

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

Setter set_emission_normals(value)
Getter get_emission_normals()

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

Default PoolVector3Array(  )
Setter set_emission_points(value)
Getter get_emission_points()

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

Default 0
Setter set_emission_shape(value)
Getter get_emission_shape()

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

  • float emission_sphere_radius
Setter set_emission_sphere_radius(value)
Getter get_emission_sphere_radius()

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

Default true
Setter set_emitting(value)
Getter is_emitting()

If true, particles are being emitted.

Default 0.0
Setter set_explosiveness_ratio(value)
Getter get_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.

  • int fixed_fps
Default 0
Setter set_fixed_fps(value)
Getter get_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 particle system itself.

Default false
Setter set_particle_flag(value)
Getter get_particle_flag()

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

  • bool flag_disable_z
Default false
Setter set_particle_flag(value)
Getter get_particle_flag()

If true, particles will not move on the z axis.

  • bool flag_rotate_y
Default false
Setter set_particle_flag(value)
Getter get_particle_flag()

If true, particles rotate around Y axis by angle.

Default 0.0
Setter set_flatness(value)
Getter get_flatness()

Amount of spread in Y/Z plane. A value of 1 restricts particles to X/Z plane.

Default true
Setter set_fractional_delta(value)
Getter get_fractional_delta()

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

Default Vector3( 0, -9.8, 0 )
Setter set_gravity(value)
Getter get_gravity()

Gravity applied to every particle.

Default 0.0
Setter set_param(value)
Getter get_param()

Initial hue variation applied to each particle.

  • Curve hue_variation_curve
Setter set_param_curve(value)
Getter get_param_curve()

Each particle’s hue will vary along this Curve.

  • float hue_variation_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Hue variation randomness ratio.

Default 0.0
Setter set_param(value)
Getter get_param()

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

  • float initial_velocity_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Initial velocity randomness ratio.

Default 1.0
Setter set_lifetime(value)
Getter get_lifetime()

Amount of time each particle will exist.

  • float lifetime_randomness
Default 0.0
Setter set_lifetime_randomness(value)
Getter get_lifetime_randomness()

Particle lifetime randomness ratio.

Default 0.0
Setter set_param(value)
Getter get_param()

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

  • Curve linear_accel_curve
Setter set_param_curve(value)
Getter get_param_curve()

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

  • float linear_accel_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Linear acceleration randomness ratio.

Default true
Setter set_use_local_coordinates(value)
Getter get_use_local_coordinates()

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

Setter set_mesh(value)
Getter get_mesh()

The Mesh used for each particle. If null, particles will be spheres.

Default false
Setter set_one_shot(value)
Getter get_one_shot()

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

Setter set_param(value)
Getter get_param()

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

This property is only available when flag_disable_z is true.

  • Curve orbit_velocity_curve
Setter set_param_curve(value)
Getter get_param_curve()

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

  • float orbit_velocity_random
Setter set_param_randomness(value)
Getter get_param_randomness()

Orbital velocity randomness ratio.

Default 0.0
Setter set_pre_process_time(value)
Getter get_pre_process_time()

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

Default 0.0
Setter set_param(value)
Getter get_param()

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

  • Curve radial_accel_curve
Setter set_param_curve(value)
Getter get_param_curve()

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

  • float radial_accel_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Radial acceleration randomness ratio.

Default 0.0
Setter set_randomness_ratio(value)
Getter get_randomness_ratio()

Emission lifetime randomness ratio.

Default 1.0
Setter set_param(value)
Getter get_param()

Initial scale applied to each particle.

  • Curve scale_amount_curve
Setter set_param_curve(value)
Getter get_param_curve()

Each particle’s scale will vary along this Curve.

  • float scale_amount_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Scale randomness ratio.

Default 1.0
Setter set_speed_scale(value)
Getter get_speed_scale()

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

Default 45.0
Setter set_spread(value)
Getter get_spread()

Each particle’s initial direction range from +spread to -spread degrees. Applied to X/Z plane and Y/Z planes.

Default 0.0
Setter set_param(value)
Getter get_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
Setter set_param_curve(value)
Getter get_param_curve()

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

  • float tangential_accel_random
Default 0.0
Setter set_param_randomness(value)
Getter get_param_randomness()

Tangential acceleration randomness ratio.

Method Descriptions

  • void convert_from_particles ( Node particles )

Sets this node’s properties to match a given Particles 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.

  • bool get_particle_flag ( Flags flag ) const

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).