ParticlesMaterial

Category: Core

Particle properties for and Particles2D nodes.

enum Parameter:

PARAM_INITIAL_LINEAR_VELOCITY = 0 — Use with set_param, set_param_randomness, and set_param_texture to set initial velocity properties.
PARAM_ANGULAR_VELOCITY = 1 — Use with set_param, set_param_randomness, and set_param_texture to set angular velocity properties.
PARAM_ORBIT_VELOCITY = 2 — Use with set_param, set_param_randomness, and set_param_texture to set orbital velocity properties.
PARAM_LINEAR_ACCEL = 3 — Use with set_param, set_param_randomness, and set_param_texture to set linear acceleration properties.
PARAM_RADIAL_ACCEL = 4 — Use with set_param, set_param_randomness, and set_param_texture to set radial acceleration properties.
PARAM_TANGENTIAL_ACCEL = 5 — Use with set_param, set_param_randomness, and set_param_texture to set tangential acceleration properties.
PARAM_DAMPING = 6 — Use with set_param, set_param_randomness, and set_param_texture to set damping properties.
PARAM_ANGLE = 7 — Use with set_param, set_param_randomness, and set_param_texture to set angle properties.
PARAM_SCALE = 8 — Use with set_param, set_param_randomness, and set_param_texture to set scale properties.
PARAM_HUE_VARIATION = 9 — Use with set_param, set_param_randomness, and set_param_texture to set hue variation properties.
PARAM_ANIM_SPEED = 10 — Use with set_param, set_param_randomness, and set_param_texture to set animation speed properties.
PARAM_ANIM_OFFSET = 11 — Use with set_param, set_param_randomness, and set_param_texture to set animation offset properties.
PARAM_MAX = 12 — Represents the size of the enum.

enum Flags:

FLAG_ALIGN_Y_TO_VELOCITY = 0 — Use with set_flag to set flag_align_y.
FLAG_ROTATE_Y = 1 — Use with set_flag to set .
FLAG_DISABLE_Z = 2 — Use with set_flag to set flag_disable_z.
FLAG_MAX = 3 — Represents the size of the enum.

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 determined by sampling a random point on the emission_point_texture. Particle color will be modulated by .

ParticlesMaterial defines particle properties and behavior. It is used in the of Particles and emitter nodes.

Some of this material’s properties are applied to each particle when emitted, while others can have a CurveTexture applied to vary values over the lifetime of the particle.

When a randomness ratio is applied to a property it is used to scale that property by a random amount. The random ratio is used to interpolate between 1.0 and a random number less than one, the result is multiplied by the property to obtain the randomized property. For example a random ratio of 0.4 would scale the original property between 0.4-1.0 of its original value.

angle

Setter	set_param(value)
Getter	get_param()

Initial rotation applied to each particle, in degrees.

Only applied when flag_disable_z or are true or the SpatialMaterial being used to draw the particle is using BillboardMode.BILLBOARD_PARTICLES.

angle_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

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

angle_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Rotation randomness ratio. Default value: 0.

float angular_velocity

Setter	set_param(value)
Getter	get_param()

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

Only applied when or flag_rotate_y are true or the being used to draw the particle is using BillboardMode.BILLBOARD_PARTICLES.

Texture angular_velocity_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Each particle’s angular velocity will vary along this .

float angular_velocity_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Angular velocity randomness ratio. Default value: 0.

anim_offset

Setter	set_param(value)
Getter	get_param()

Particle animation offset.

Texture anim_offset_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Each particle’s animation offset will vary along this .

float anim_offset_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Animation offset randomness ratio. Default value: 0.

anim_speed

Setter	set_param(value)
Getter	get_param()

Particle animation speed.

Texture anim_speed_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

anim_speed_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Animation speed randomness ratio. Default value: 0.

Color color

Setter	set_color(value)
Getter	get_color()

Each particle’s initial color. If the ’s texture is defined, it will be multiplied by this color. To have particle display color in a SpatialMaterial make sure to set to .

Texture color_ramp

Setter	set_color_ramp(value)
Getter	get_color_ramp()

Each particle’s color will vary along this .

float damping

Setter	set_param(value)
Getter	get_param()

The rate at which particles lose velocity.

damping_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Damping will vary along this CurveTexture.

damping_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Damping randomness ratio. Default value: 0.

Vector3 emission_box_extents

The box’s extents if emission_shape is set to .

Texture emission_color_texture

Setter	set_emission_color_texture(value)
Getter	get_emission_color_texture()

Particle color will be modulated by color determined by sampling this texture at the same point as the .

Texture emission_normal_texture

Setter	set_emission_normal_texture(value)
Getter	get_emission_normal_texture()

Particle velocity and rotation will be set by sampling this texture at the same point as the . Used only in EMISSION_SHAPE_DIRECTED_POINTS. Can be created automatically from mesh or node by selecting “Create Emission Points from Mesh/Node” under the “Particles” tool in the toolbar.

emission_point_count

Setter	set_emission_point_count(value)
Getter	get_emission_point_count()

The number of emission points if emission_shape is set to EMISSION_SHAPE_POINTS or .

Texture emission_point_texture

Setter	set_emission_point_texture(value)
Getter	get_emission_point_texture()

Particles will be emitted at positions determined by sampling this texture at a random position. Used with and EMISSION_SHAPE_DIRECTED_POINTS. Can be created automatically from mesh or node by selecting “Create Emission Points from Mesh/Node” under the “Particles” tool in the toolbar.

emission_shape

Setter	set_emission_shape(value)
Getter	get_emission_shape()

Particles will be emitted inside this region. Use EMISSION_SHAPE_* constants for values. Default value: EMISSION_SHAPE_POINT.

emission_sphere_radius

Setter	set_emission_sphere_radius(value)
Getter	get_emission_sphere_radius()

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

flag_align_y

Setter	set_flag(value)
Getter	get_flag()

Align y-axis of particle with the direction of its velocity.

bool flag_disable_z

Setter	set_flag(value)
Getter	get_flag()

If true, particles will not move on the z axis. Default value: true for , false for Particles.

Setter	set_flag(value)
Getter	get_flag()

If true, particles rotate around y-axis by .

float flatness

Setter	set_flatness(value)
Getter	get_flatness()

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

Vector3 gravity

Setter	set_gravity(value)
Getter	get_gravity()

Gravity applied to every particle. Default value: (0, -9.8, 0).

hue_variation

Setter	set_param(value)
Getter	get_param()

Initial hue variation applied to each particle.

Texture hue_variation_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Each particle’s hue will vary along this .

float hue_variation_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

initial_velocity

Setter	set_param(value)
Getter	get_param()

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

initial_velocity_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Initial velocity randomness ratio. Default value: 0.

float linear_accel

Setter	set_param(value)
Getter	get_param()

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

linear_accel_curve

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

linear_accel_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Linear acceleration randomness ratio. Default value: 0.

float orbit_velocity

Setter	set_param(value)
Getter	get_param()

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

Only available when is true.

Texture orbit_velocity_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Each particle’s orbital velocity will vary along this .

float orbit_velocity_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Orbital velocity randomness ratio. Default value: 0.

radial_accel

Setter	set_param(value)
Getter	get_param()

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

Texture radial_accel_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Each particle’s radial acceleration will vary along this .

float radial_accel_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Radial acceleration randomness ratio. Default value: 0.

scale

Setter	set_param(value)
Getter	get_param()

Initial scale applied to each particle.

Texture scale_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

Each particle’s scale will vary along this .

float scale_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Scale randomness ratio. Default value: 0.

spread

Setter	set_spread(value)
Getter	get_spread()

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

float tangential_accel

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.

tangential_accel_curve

Setter	set_param_texture(value)
Getter	get_param_texture()

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

tangential_accel_random

Setter	set_param_randomness(value)
Getter	get_param_randomness()

Tangential acceleration randomness ratio. Default value: 0.

GradientTexture trail_color_modifier

Setter	set_trail_color_modifier(value)
Getter	get_trail_color_modifier()

Trail particles’ color will vary along this .

int trail_divisor

Setter	set_trail_divisor(value)
Getter	get_trail_divisor()

trail_size_modifier

Setter	set_trail_size_modifier(value)
Getter	get_trail_size_modifier()

Trail particles’ size will vary along this CurveTexture.