Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

CPUParticles3D

Inherits: GeometryInstance3D < VisualInstance3D < Node3D < Node < Object

A CPU-based 3D particle emitter.

Description

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

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

Tutorials

• Particle systems (3D)

Properties

int	amount	8
Curve	angle_curve
float	angle_max	0.0
float	angle_min	0.0
Curve	angular_velocity_curve
float	angular_velocity_max	0.0
float	angular_velocity_min	0.0
Curve	anim_offset_curve
float	anim_offset_max	0.0
float	anim_offset_min	0.0
Curve	anim_speed_curve
float	anim_speed_max	0.0
float	anim_speed_min	0.0
Color	color	Color(1, 1, 1, 1)
Gradient	color_initial_ramp
Gradient	color_ramp
Curve	damping_curve
float	damping_max	0.0
float	damping_min	0.0
Vector3	direction	Vector3(1, 0, 0)
DrawOrder	draw_order	0
Vector3	emission_box_extents
PackedColorArray	emission_colors	PackedColorArray()
PackedVector3Array	emission_normals
PackedVector3Array	emission_points
Vector3	emission_ring_axis
float	emission_ring_height
float	emission_ring_inner_radius
float	emission_ring_radius
EmissionShape	emission_shape	0
float	emission_sphere_radius
bool	emitting	true
float	explosiveness	0.0
int	fixed_fps	0
float	flatness	0.0
bool	fract_delta	true
Vector3	gravity	Vector3(0, -9.8, 0)
Curve	hue_variation_curve
float	hue_variation_max	0.0
float	hue_variation_min	0.0
float	initial_velocity_max	0.0
float	initial_velocity_min	0.0
float	lifetime	1.0
float	lifetime_randomness	0.0
Curve	linear_accel_curve
float	linear_accel_max	0.0
float	linear_accel_min	0.0
bool	local_coords	false
Mesh	mesh
bool	one_shot	false
Curve	orbit_velocity_curve
float	orbit_velocity_max
float	orbit_velocity_min
bool	particle_flag_align_y	false
bool	particle_flag_disable_z	false
bool	particle_flag_rotate_y	false
float	preprocess	0.0
Curve	radial_accel_curve
float	radial_accel_max	0.0
float	radial_accel_min	0.0
float	randomness	0.0
Curve	scale_amount_curve
float	scale_amount_max	1.0
float	scale_amount_min	1.0
Curve	scale_curve_x
Curve	scale_curve_y
Curve	scale_curve_z
float	speed_scale	1.0
bool	split_scale	false
float	spread	45.0
Curve	tangential_accel_curve
float	tangential_accel_max	0.0
float	tangential_accel_min	0.0

Methods

void	convert_from_particles ( Node particles