Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ParticleProcessMaterial

Inherits: Material < Resource < RefCounted < Object

Holds a particle configuration for GPUParticles2D or GPUParticles3D nodes.

Description

ParticleProcessMaterial defines particle properties and behavior. It is used in the process_material of the GPUParticles2D and GPUParticles3D nodes. Some of this material's properties are applied to each particle when emitted, while others can have a CurveTexture or a GradientTexture1D applied to vary numerical or color values over the lifetime of the particle.

Properties

Texture2D	alpha_curve
Texture2D	angle_curve
float	angle_max	0.0
float	angle_min	0.0
Texture2D	angular_velocity_curve
float	angular_velocity_max	0.0
float	angular_velocity_min	0.0
Texture2D	anim_offset_curve
float	anim_offset_max	0.0
float	anim_offset_min	0.0
Texture2D	anim_speed_curve
float	anim_speed_max	0.0
float	anim_speed_min	0.0
bool	attractor_interaction_enabled	true
float	collision_bounce
float	collision_friction
CollisionMode	collision_mode	0
bool	collision_use_scale	false
Color	color	Color(1, 1, 1, 1)
Texture2D	color_initial_ramp
Texture2D	color_ramp
Texture2D	damping_curve
float	damping_max	0.0
float	damping_min	0.0
Vector3	direction	Vector3(1, 0, 0)
Texture2D	directional_velocity_curve
float	directional_velocity_max
float	directional_velocity_min
Vector3	emission_box_extents
Texture2D	emission_color_texture
Texture2D	emission_curve
Texture2D	emission_normal_texture
int	emission_point_count
Texture2D	emission_point_texture
Vector3	emission_ring_axis
float	emission_ring_height
float	emission_ring_inner_radius
float	emission_ring_radius
EmissionShape	emission_shape	0
Vector3	emission_shape_offset	Vector3(0, 0, 0)
Vector3	emission_shape_scale	Vector3(1, 1, 1)
float	emission_sphere_radius
float	flatness	0.0
Vector3	gravity	Vector3(0, -9.8, 0)
Texture2D	hue_variation_curve
float	hue_variation_max	0.0
float	hue_variation_min	0.0
float	inherit_velocity_ratio	0.0
float	initial_velocity_max	0.0
float	initial_velocity_min	0.0
float	lifetime_randomness	0.0
Texture2D	linear_accel_curve
float	linear_accel_max	0.0
float	linear_accel_min	0.0
Texture2D	orbit_velocity_curve
float	orbit_velocity_max	0.0
float	orbit_velocity_min	0.0
bool	particle_flag_align_y	false
bool	particle_flag_damping_as_friction	false
bool	particle_flag_disable_z	false
bool	particle_flag_rotate_y	false
Texture2D	radial_accel_curve
float	radial_accel_max	0.0
float	radial_accel_min	0.0
Texture2D	radial_velocity_curve
float	radial_velocity_max	0.0
float	radial_velocity_min	0.0
Texture2D	scale_curve
float	scale_max	1.0
float	scale_min	1.0
Texture2D	scale_over_velocity_curve
float	scale_over_velocity_max	0.0
float	scale_over_velocity_min	0.0
float	spread	45.0
int	sub_emitter_amount_at_collision
int	sub_emitter_amount_at_end
float	sub_emitter_frequency
bool	sub_emitter_keep_velocity	false
SubEmitterMode	sub_emitter_mode	0
Texture2D	tangential_accel_curve
float	tangential_accel_max	0.0
float	tangential_accel_min	0.0
bool	turbulence_enabled	false
float	turbulence_influence_max	0.1
float	turbulence_influence_min	0.1
Texture2D	turbulence_influence_over_life
float	turbulence_initial_displacement_max	0.0
float	turbulence_initial_displacement_min	0.0
float	turbulence_noise_scale	9.0
Vector3	turbulence_noise_speed	Vector3(0, 0, 0)
float	turbulence_noise_speed_random	0.2
float	turbulence_noise_strength	1.0
Texture2D	velocity_limit_curve
Vector3	velocity_pivot	Vector3(0, 0, 0)

Methods

float	get_param_max ( Parameter param ) const
float	get_param_min ( Parameter param ) const
Texture2D	get_param_texture ( Parameter param ) const
bool	get_particle_flag ( ParticleFlags particle_flag ) const
void	set_param_max ( Parameter param, float value )
void	set_param_min ( Parameter param, float value )
void	set_param_texture ( Parameter param, Texture2D texture )
void	set_particle_flag ( ParticleFlags particle_flag, bool enable )

---

Enumerations

enum Parameter:

Parameter PARAM_INITIAL_LINEAR_VELOCITY = 0

Use with set_param_min, set_param_max, and set_param_texture to set initial velocity properties.