CPUParticles3D

Inherits: GeometryInstance3D < VisualInstance3D < Node3D < Node < Object

There is currently no description for this class. Please help us by contributing one!

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
AABB	visibility_aabb	AABB(0, 0, 0, 0, 0, 0)

Methods

void	convert_from_particles ( Node particles )
Curve	get_param_curve ( Parameter param ) const
float	get_param_max ( Parameter param ) const
float	get_param_min ( Parameter param ) const
bool	get_particle_flag ( ParticleFlags particle_flag ) const
void	restart ( )
void	set_param_curve ( Parameter param, Curve curve )
void	set_param_max ( Parameter param, float value )
void	set_param_min ( Parameter param, float value )
void	set_particle_flag ( ParticleFlags particle_flag, bool enable )

---

Signals

finished ( )

There is currently no description for this signal. Please help us by contributing one!

---

Enumerations

enum DrawOrder:

DrawOrder DRAW_ORDER_INDEX = 0

There is currently no description for this enum. Please help us by contributing one!

DrawOrder DRAW_ORDER_LIFETIME = 1

There is currently no description for this enum. Please help us by contributing one!

DrawOrder DRAW_ORDER_VIEW_DEPTH = 2

There is currently no description for this enum. Please help us by contributing one!

---

enum Parameter:

Parameter PARAM_INITIAL_LINEAR_VELOCITY = 0

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_ANGULAR_VELOCITY = 1

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_ORBIT_VELOCITY = 2

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_LINEAR_ACCEL = 3

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_RADIAL_ACCEL = 4

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_TANGENTIAL_ACCEL = 5

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_DAMPING = 6

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_ANGLE = 7

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_SCALE = 8

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_HUE_VARIATION = 9

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_ANIM_SPEED = 10

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_ANIM_OFFSET = 11

There is currently no description for this enum. Please help us by contributing one!

Parameter PARAM_MAX = 12

There is currently no description for this enum. Please help us by contributing one!

---

enum ParticleFlags:

ParticleFlags PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY = 0

There is currently no description for this enum. Please help us by contributing one!

ParticleFlags PARTICLE_FLAG_ROTATE_Y = 1

There is currently no description for this enum. Please help us by contributing one!

ParticleFlags PARTICLE_FLAG_DISABLE_Z = 2

There is currently no description for this enum. Please help us by contributing one!

ParticleFlags PARTICLE_FLAG_MAX = 3

There is currently no description for this enum. Please help us by contributing one!

---

enum EmissionShape:

EmissionShape EMISSION_SHAPE_POINT = 0

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_SPHERE = 1

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_SPHERE_SURFACE = 2

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_BOX = 3

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_POINTS = 4

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_DIRECTED_POINTS = 5

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_RING = 6

There is currently no description for this enum. Please help us by contributing one!

EmissionShape EMISSION_SHAPE_MAX = 7

There is currently no description for this enum. Please help us by contributing one!

---

Property Descriptions

int amount = 8

• void set_amount ( int value )

• int get_amount ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve angle_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float angle_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float angle_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

Curve angular_velocity_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float angular_velocity_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float angular_velocity_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

Curve anim_offset_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float anim_offset_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float anim_offset_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

Curve anim_speed_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float anim_speed_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float anim_speed_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

Color color = Color(1, 1, 1, 1)

• void set_color ( Color value )

• Color get_color ( )

There is currently no description for this property. Please help us by contributing one!

---

Gradient color_initial_ramp

• void set_color_initial_ramp ( Gradient value )

• Gradient get_color_initial_ramp ( )

There is currently no description for this property. Please help us by contributing one!

---

Gradient color_ramp

• void set_color_ramp ( Gradient value )

• Gradient get_color_ramp ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve damping_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float damping_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float damping_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

Vector3 direction = Vector3(1, 0, 0)

• void set_direction ( Vector3 value )

• Vector3 get_direction ( )

There is currently no description for this property. Please help us by contributing one!

---

DrawOrder draw_order = 0

• void set_draw_order ( DrawOrder value )

• DrawOrder get_draw_order ( )

There is currently no description for this property. Please help us by contributing one!

---

Vector3 emission_box_extents

• void set_emission_box_extents ( Vector3 value )

• Vector3 get_emission_box_extents ( )

There is currently no description for this property. Please help us by contributing one!

---

PackedColorArray emission_colors = PackedColorArray()

• void set_emission_colors ( PackedColorArray value )

• PackedColorArray get_emission_colors ( )

There is currently no description for this property. Please help us by contributing one!

---

PackedVector3Array emission_normals

• void set_emission_normals ( PackedVector3Array value )

• PackedVector3Array get_emission_normals ( )

There is currently no description for this property. Please help us by contributing one!

---

PackedVector3Array emission_points

• void set_emission_points ( PackedVector3Array value )

• PackedVector3Array get_emission_points ( )

There is currently no description for this property. Please help us by contributing one!

---

Vector3 emission_ring_axis

• void set_emission_ring_axis ( Vector3 value )

• Vector3 get_emission_ring_axis ( )

There is currently no description for this property. Please help us by contributing one!

---

float emission_ring_height

• void set_emission_ring_height ( float value )

• float get_emission_ring_height ( )

There is currently no description for this property. Please help us by contributing one!

---

float emission_ring_inner_radius

• void set_emission_ring_inner_radius ( float value )

• float get_emission_ring_inner_radius ( )

There is currently no description for this property. Please help us by contributing one!

---

float emission_ring_radius

• void set_emission_ring_radius ( float value )

• float get_emission_ring_radius ( )

There is currently no description for this property. Please help us by contributing one!

---

EmissionShape emission_shape = 0

• void set_emission_shape ( EmissionShape value )

• EmissionShape get_emission_shape ( )

There is currently no description for this property. Please help us by contributing one!

---

float emission_sphere_radius

• void set_emission_sphere_radius ( float value )

• float get_emission_sphere_radius ( )

There is currently no description for this property. Please help us by contributing one!

---

bool emitting = true

• void set_emitting ( bool value )

• bool is_emitting ( )

There is currently no description for this property. Please help us by contributing one!

---

float explosiveness = 0.0

• void set_explosiveness_ratio ( float value )

• float get_explosiveness_ratio ( )

There is currently no description for this property. Please help us by contributing one!

---

int fixed_fps = 0

• void set_fixed_fps ( int value )

• int get_fixed_fps ( )

There is currently no description for this property. Please help us by contributing one!

---

float flatness = 0.0

• void set_flatness ( float value )

• float get_flatness ( )

There is currently no description for this property. Please help us by contributing one!

---

bool fract_delta = true

• void set_fractional_delta ( bool value )

• bool get_fractional_delta ( )

There is currently no description for this property. Please help us by contributing one!

---

Vector3 gravity = Vector3(0, -9.8, 0)

• void set_gravity ( Vector3 value )

• Vector3 get_gravity ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve hue_variation_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float hue_variation_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float hue_variation_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float initial_velocity_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float initial_velocity_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float lifetime = 1.0

• void set_lifetime ( float value )

• float get_lifetime ( )

There is currently no description for this property. Please help us by contributing one!

---

float lifetime_randomness = 0.0

• void set_lifetime_randomness ( float value )

• float get_lifetime_randomness ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve linear_accel_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float linear_accel_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float linear_accel_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

bool local_coords = false

• void set_use_local_coordinates ( bool value )

• bool get_use_local_coordinates ( )

There is currently no description for this property. Please help us by contributing one!

---

Mesh mesh

• void set_mesh ( Mesh value )

• Mesh get_mesh ( )

There is currently no description for this property. Please help us by contributing one!

---

bool one_shot = false

• void set_one_shot ( bool value )

• bool get_one_shot ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve orbit_velocity_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float orbit_velocity_max

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float orbit_velocity_min

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

bool particle_flag_align_y = false

• void set_particle_flag ( ParticleFlags particle_flag, bool enable )

• bool get_particle_flag ( ParticleFlags particle_flag ) const

There is currently no description for this property. Please help us by contributing one!

---

bool particle_flag_disable_z = false

• void set_particle_flag ( ParticleFlags particle_flag, bool enable )

• bool get_particle_flag ( ParticleFlags particle_flag ) const

There is currently no description for this property. Please help us by contributing one!

---

bool particle_flag_rotate_y = false

• void set_particle_flag ( ParticleFlags particle_flag, bool enable )

• bool get_particle_flag ( ParticleFlags particle_flag ) const

There is currently no description for this property. Please help us by contributing one!

---

float preprocess = 0.0

• void set_pre_process_time ( float value )

• float get_pre_process_time ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve radial_accel_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float radial_accel_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float radial_accel_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float randomness = 0.0

• void set_randomness_ratio ( float value )

• float get_randomness_ratio ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve scale_amount_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float scale_amount_max = 1.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float scale_amount_min = 1.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

Curve scale_curve_x

• void set_scale_curve_x ( Curve value )

• Curve get_scale_curve_x ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve scale_curve_y

• void set_scale_curve_y ( Curve value )

• Curve get_scale_curve_y ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve scale_curve_z

• void set_scale_curve_z ( Curve value )

• Curve get_scale_curve_z ( )

There is currently no description for this property. Please help us by contributing one!

---

float speed_scale = 1.0

• void set_speed_scale ( float value )

• float get_speed_scale ( )

There is currently no description for this property. Please help us by contributing one!

---

bool split_scale = false

• void set_split_scale ( bool value )

• bool get_split_scale ( )

There is currently no description for this property. Please help us by contributing one!

---

float spread = 45.0

• void set_spread ( float value )

• float get_spread ( )

There is currently no description for this property. Please help us by contributing one!

---

Curve tangential_accel_curve

• void set_param_curve ( Parameter param, Curve curve )

• Curve get_param_curve ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float tangential_accel_max = 0.0

• void set_param_max ( Parameter param, float value )

• float get_param_max ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

float tangential_accel_min = 0.0

• void set_param_min ( Parameter param, float value )

• float get_param_min ( Parameter param ) const

There is currently no description for this property. Please help us by contributing one!

---

AABB visibility_aabb = AABB(0, 0, 0, 0, 0, 0)

• void set_visibility_aabb ( AABB value )

• AABB get_visibility_aabb ( )

There is currently no description for this property. Please help us by contributing one!

---

Method Descriptions

void convert_from_particles ( Node particles )

There is currently no description for this method. Please help us by contributing one!

---

Curve get_param_curve ( Parameter param ) const

There is currently no description for this method. Please help us by contributing one!

---

float get_param_max ( Parameter param ) const

There is currently no description for this method. Please help us by contributing one!

---

float get_param_min ( Parameter param ) const

There is currently no description for this method. Please help us by contributing one!

---

bool get_particle_flag ( ParticleFlags particle_flag ) const

There is currently no description for this method. Please help us by contributing one!

---

void restart ( )

There is currently no description for this method. Please help us by contributing one!

---

void set_param_curve ( Parameter param, Curve curve )

There is currently no description for this method. Please help us by contributing one!

---

void set_param_max ( Parameter param, float value )

There is currently no description for this method. Please help us by contributing one!

---

void set_param_min ( Parameter param, float value )

There is currently no description for this method. Please help us by contributing one!

---

void set_particle_flag ( ParticleFlags particle_flag, bool enable )

There is currently no description for this method. Please help us by contributing one!