Index · Object → Node → Node3D → VisualInstance3D → GeometryInstance3D → CPUParticles3D

CPUParticles3D

A CPU-based 3D particle emitter.

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

Properties

var amount: int = 8

Number of particles emitted in one emission cycle.

var angle_curve: Curve

Each particle's rotation will be animated along this Curve. Should be a unit Curve.

var angle_max: float = 0.0

Maximum angle.

var angle_min: float = 0.0

Minimum angle.

var angular_velocity_curve: Curve

Each particle's angular velocity (rotation speed) will vary along this Curve over its lifetime. Should be a unit Curve.

var angular_velocity_max: float = 0.0

Maximum initial angular velocity (rotation speed) applied to each particle in degrees per second.

var angular_velocity_min: float = 0.0

Minimum initial angular velocity (rotation speed) applied to each particle in degrees per second.

var anim_offset_curve: Curve

Each particle's animation offset will vary along this Curve. Should be a unit Curve.

var anim_offset_max: float = 0.0

Maximum animation offset.

var anim_offset_min: float = 0.0

Minimum animation offset.

var anim_speed_curve: Curve

Each particle's animation speed will vary along this Curve. Should be a unit Curve.

var anim_speed_max: float = 0.0

Maximum particle animation speed.

var anim_speed_min: float = 0.0

Minimum particle animation speed.

var color: Color = Color(1, 1, 1, 1)

Each particle's initial color.

Note: color multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, color will have no visible effect.

var color_initial_ramp: Gradient

Each particle's initial color will vary along this Gradient (multiplied with color).

Note: color_initial_ramp multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, color_initial_ramp will have no visible effect.

var color_ramp: Gradient

Each particle's color will vary along this Gradient over its lifetime (multiplied with color).

Note: color_ramp multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, color_ramp will have no visible effect.

var damping_curve: Curve

Damping will vary along this Curve. Should be a unit Curve.

var damping_max: float = 0.0

Maximum damping.

var damping_min: float = 0.0

Minimum damping.

var direction: Vector3 = Vector3(1, 0, 0)

Unit vector specifying the particles' emission direction.

var draw_order: CPUParticles3D.DrawOrder = 0

Particle draw order.

var emission_box_extents: Vector3

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

var emission_colors: PackedColorArray = PackedColorArray()

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

Note: emission_colors multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, emission_colors will have no visible effect.

var emission_normals: PackedVector3Array

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

var emission_points: PackedVector3Array

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

var emission_ring_axis: Vector3

The axis of the ring when using the emitter EMISSION_SHAPE_RING.

var emission_ring_cone_angle: float

The angle of the cone when using the emitter EMISSION_SHAPE_RING. The default angle of 90 degrees results in a ring, while an angle of 0 degrees results in a cone. Intermediate values will result in a ring where one end is larger than the other.

Note: Depending on emission_ring_height, the angle may be clamped if the ring's end is reached to form a perfect cone.

var emission_ring_height: float

The height of the ring when using the emitter EMISSION_SHAPE_RING.

var emission_ring_inner_radius: float

The inner radius of the ring when using the emitter EMISSION_SHAPE_RING.

var emission_ring_radius: float

The radius of the ring when using the emitter EMISSION_SHAPE_RING.

var emission_shape: CPUParticles3D.EmissionShape = 0

Particles will be emitted inside this region.

var emission_sphere_radius: float

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

var emitting: bool = true

If true, particles are being emitted. emitting can be used to start and stop particles from emitting. However, if one_shot is true setting emitting to true will not restart the emission cycle until after all active particles finish processing. You can use the finished signal to be notified once all active particles finish processing.

var explosiveness: float = 0.0

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.

var fixed_fps: int = 0

The particle system's frame rate is fixed to a value. For example, 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.

var flatness: float = 0.0

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

var fract_delta: bool = true

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

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

Gravity applied to every particle.

var hue_variation_curve: Curve

Each particle's hue will vary along this Curve. Should be a unit Curve.

var hue_variation_max: float = 0.0

Maximum hue variation.

var hue_variation_min: float = 0.0

Minimum hue variation.

var initial_velocity_max: float = 0.0

Maximum value of the initial velocity.

var initial_velocity_min: float = 0.0

Minimum value of the initial velocity.

var lifetime: float = 1.0

Amount of time each particle will exist.

var lifetime_randomness: float = 0.0

Particle lifetime randomness ratio.

var linear_accel_curve: Curve

Each particle's linear acceleration will vary along this Curve. Should be a unit Curve.

var linear_accel_max: float = 0.0

Maximum linear acceleration.

var linear_accel_min: float = 0.0

Minimum linear acceleration.

var local_coords: bool = false

If true, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the CPUParticles3D node (and its parents) when it is moved or rotated. If false, particles use global coordinates; they will not move or rotate along the CPUParticles3D node (and its parents) when it is moved or rotated.

var mesh: Mesh

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

var one_shot: bool = false

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

var orbit_velocity_curve: Curve

Each particle's orbital velocity will vary along this Curve. Should be a unit Curve.

var orbit_velocity_max: float

Maximum orbit velocity.

var orbit_velocity_min: float

Minimum orbit velocity.

var particle_flag_align_y: bool = false

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

var particle_flag_disable_z: bool = false

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

var particle_flag_rotate_y: bool = false

If true, particles rotate around Y axis by angle_min.

var preprocess: float = 0.0

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

var radial_accel_curve: Curve

Each particle's radial acceleration will vary along this Curve. Should be a unit Curve.

var radial_accel_max: float = 0.0

Maximum radial acceleration.

var radial_accel_min: float = 0.0

Minimum radial acceleration.

var randomness: float = 0.0

Emission lifetime randomness ratio.

var scale_amount_curve: Curve

Each particle's scale will vary along this Curve. Should be a unit Curve.

var scale_amount_max: float = 1.0

Maximum scale.

var scale_amount_min: float = 1.0

Minimum scale.

var scale_curve_x: Curve

Curve for the scale over life, along the x axis.

var scale_curve_y: Curve

Curve for the scale over life, along the y axis.

var scale_curve_z: Curve

Curve for the scale over life, along the z axis.

var seed: int = 0

Sets the random seed used by the particle system. Only effective if use_fixed_seed is true.

var speed_scale: float = 1.0

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

var split_scale: bool = false

If set to true, three different scale curves can be specified, one per scale axis.

var spread: float = 45.0

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

var tangential_accel_curve: Curve

Each particle's tangential acceleration will vary along this Curve. Should be a unit Curve.

var tangential_accel_max: float = 0.0

Maximum tangent acceleration.

var tangential_accel_min: float = 0.0

Minimum tangent acceleration.

var use_fixed_seed: bool = false

If true, particles will use the same seed for every simulation using the seed defined in seed. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode.

var visibility_aabb: AABB = AABB(0, 0, 0, 0, 0, 0)

The AABB that determines the node's region which needs to be visible on screen for the particle system to be active.

Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The AABB can be grown via code or with the Particles → Generate AABB editor tool.

Inherited from GeometryInstance3D (16)
var custom_aabb: AABB = AABB(0, 0, 0, 0, 0, 0)
var lod_bias: float = 1.0
var transparency: float = 0.0
Inherited from VisualInstance3D (3)
var layers: int = 1
Inherited from Node3D (17)
var position: Vector3 = Vector3(0, 0, 0)
var rotation: Vector3 = Vector3(0, 0, 0)
var rotation_order: EulerOrder = 2
var scale: Vector3 = Vector3(1, 1, 1)
var top_level: bool = false
var transform: Transform3D = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)
var visibility_parent: NodePath = NodePath("")
var visible: bool = true
Inherited from Node (14)
var owner: Node

Methods

func capture_aabb() -> AABB

Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.

func convert_from_particles(particles: Node) -> void

Sets this node's properties to match a given GPUParticles3D node with an assigned ParticleProcessMaterial.

func get_param_curve(param: CPUParticles3D.Parameter) -> Curve

Returns the Curve of the parameter specified by Parameter.

func get_param_max(param: CPUParticles3D.Parameter) -> float

Returns the maximum value range for the given parameter.

func get_param_min(param: CPUParticles3D.Parameter) -> float

Returns the minimum value range for the given parameter.

func get_particle_flag(particle_flag: CPUParticles3D.ParticleFlags) -> bool

Returns the enabled state of the given particle flag.

func request_particles_process(process_time: float, process_time_residual: float = 0.0) -> void

Requests the particles to process for extra process time during a single frame.

process_time defines the time that the particles will process while emitting is on. process_time_residual defines the time that particles will process with emitting turned off for the simulation. When combined with speed_scale set to 0.0, this is useful to be able to seek a particle system timeline.

func restart(keep_seed: bool = false) -> void

Restarts the particle emitter.

If keep_seed is true, the current random seed will be preserved. Useful for seeking and playback.

func set_param_curve(param: CPUParticles3D.Parameter, curve: Curve) -> void

Sets the Curve of the parameter specified by Parameter. Should be a unit Curve.

func set_param_max(param: CPUParticles3D.Parameter, value: float) -> void

Sets the maximum value for the given parameter.

func set_param_min(param: CPUParticles3D.Parameter, value: float) -> void

Sets the minimum value for the given parameter.

func set_particle_flag(particle_flag: CPUParticles3D.ParticleFlags, enable: bool) -> void

Enables or disables the given particle flag.

Inherited from GeometryInstance3D (2)
Inherited from VisualInstance3D (7)
func _get_aabb() -> AABB
func get_aabb() -> AABB
func get_base() -> RID
func get_instance() -> RID
func get_layer_mask_value(layer_number: int) -> bool
func set_base(base: RID) -> void
func set_layer_mask_value(layer_number: int, value: bool) -> void
Inherited from Node3D (37)
func add_gizmo(gizmo: Node3DGizmo) -> void
func clear_gizmos() -> void
func force_update_transform() -> void
func get_gizmos() -> Node3DGizmo[]
func global_rotate(axis: Vector3, angle: float) -> void
func global_scale(scale: Vector3) -> void
func global_translate(offset: Vector3) -> void
func hide() -> void
func look_at(target: Vector3, up: Vector3 = Vector3(0, 1, 0), use_model_front: bool = false) -> void
func look_at_from_position(position: Vector3, target: Vector3, up: Vector3 = Vector3(0, 1, 0), use_model_front: bool = false) -> void
func orthonormalize() -> void
func rotate(axis: Vector3, angle: float) -> void
func rotate_object_local(axis: Vector3, angle: float) -> void
func rotate_x(angle: float) -> void
func rotate_y(angle: float) -> void
func rotate_z(angle: float) -> void
func scale_object_local(scale: Vector3) -> void
func set_disable_scale(disable: bool) -> void
func set_identity() -> void
func set_notify_local_transform(enable: bool) -> void
func set_notify_transform(enable: bool) -> void
func set_subgizmo_selection(gizmo: Node3DGizmo, id: int, transform: Transform3D) -> void
func show() -> void
func to_global(local_point: Vector3) -> Vector3
func to_local(global_point: Vector3) -> Vector3
func translate(offset: Vector3) -> void
func translate_object_local(offset: Vector3) -> void
func update_gizmos() -> void
Inherited from Node (106)
func _enter_tree() -> void
func _exit_tree() -> void
func _input(event: InputEvent) -> void
func _physics_process(delta: float) -> void
func _process(delta: float) -> void
func _ready() -> void
func _shortcut_input(event: InputEvent) -> void
func _unhandled_input(event: InputEvent) -> void
func _unhandled_key_input(event: InputEvent) -> void
func add_child(node: Node, force_readable_name: bool = false, internal: Node.InternalMode = 0) -> void
func add_sibling(sibling: Node, force_readable_name: bool = false) -> void
func add_to_group(group: StringName, persistent: bool = false) -> void
func atr(message: String, context: StringName = "") -> String
func atr_n(message: String, plural_message: StringName, n: int, context: StringName = "") -> String
func can_process() -> bool
func duplicate(flags: int = 15) -> Node
func find_child(pattern: String, recursive: bool = true, owned: bool = true) -> Node
func find_children(pattern: String, type: String = "", recursive: bool = true, owned: bool = true) -> Node[]
func find_parent(pattern: String) -> Node
func get_child(idx: int, include_internal: bool = false) -> Node
func get_child_count(include_internal: bool = false) -> int
func get_children(include_internal: bool = false) -> Node[]
func get_groups() -> StringName[]
func get_index(include_internal: bool = false) -> int
func get_node(path: NodePath) -> Node
func get_orphan_node_ids() -> int[]
func get_parent() -> Node
func get_path() -> NodePath
func get_path_to(node: Node, use_unique_path: bool = false) -> NodePath
func get_window() -> Window
func has_node(path: NodePath) -> bool
func is_ancestor_of(node: Node) -> bool
func is_greater_than(node: Node) -> bool
func is_in_group(group: StringName) -> bool
func move_child(child_node: Node, to_index: int) -> void
func notify_deferred_thread_group(what: int) -> void
func notify_thread_safe(what: int) -> void
func print_orphan_nodes() -> void
func print_tree() -> void
func print_tree_pretty() -> void
func propagate_call(method: StringName, args: Array = [], parent_first: bool = false) -> void
func propagate_notification(what: int) -> void
func queue_free() -> void
func remove_child(node: Node) -> void
func remove_from_group(group: StringName) -> void
func reparent(new_parent: Node, keep_global_transform: bool = true) -> void
func replace_by(node: Node, keep_groups: bool = false) -> void
func request_ready() -> void
func rpc(method: StringName) -> Error
func rpc_config(method: StringName, config: Variant) -> void
func rpc_id(peer_id: int, method: StringName) -> Error
func set_deferred_thread_group(property: StringName, value: Variant) -> void
func set_display_folded(fold: bool) -> void
func set_editable_instance(node: Node, is_editable: bool) -> void
func set_multiplayer_authority(id: int, recursive: bool = true) -> void
func set_physics_process(enable: bool) -> void
func set_physics_process_internal(enable: bool) -> void
func set_process(enable: bool) -> void
func set_process_input(enable: bool) -> void
func set_process_internal(enable: bool) -> void
func set_process_shortcut_input(enable: bool) -> void
func set_process_unhandled_input(enable: bool) -> void
func set_scene_instance_load_placeholder(load_placeholder: bool) -> void
func set_thread_safe(property: StringName, value: Variant) -> void
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

signal finished()

Emitted when all active particles have finished processing. When one_shot is disabled, particles will process continuously, so this is never emitted.

Inherited from Node3D (1)
Inherited from Node (11)
signal child_entered_tree(node: Node)
signal child_exiting_tree(node: Node)
signal ready()
signal renamed()
signal replacing_by(node: Node)
signal tree_entered()
signal tree_exited()
signal tree_exiting()
Inherited from Object (2)

Enums & Constants

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. In other words, the particle with the highest lifetime is drawn at the front.

DRAW_ORDER_VIEW_DEPTH = 2

Particles are drawn in order of depth.

enum Parameter
PARAM_INITIAL_LINEAR_VELOCITY = 0

Use with set_param_min(), set_param_max(), and set_param_curve() to set initial velocity properties.

PARAM_ANGULAR_VELOCITY = 1

Use with set_param_min(), set_param_max(), and set_param_curve() to set angular velocity properties.

PARAM_ORBIT_VELOCITY = 2

Use with set_param_min(), set_param_max(), and set_param_curve() to set orbital velocity properties.

PARAM_LINEAR_ACCEL = 3

Use with set_param_min(), set_param_max(), and set_param_curve() to set linear acceleration properties.

PARAM_RADIAL_ACCEL = 4

Use with set_param_min(), set_param_max(), and set_param_curve() to set radial acceleration properties.

PARAM_TANGENTIAL_ACCEL = 5

Use with set_param_min(), set_param_max(), and set_param_curve() to set tangential acceleration properties.

PARAM_DAMPING = 6

Use with set_param_min(), set_param_max(), and set_param_curve() to set damping properties.

PARAM_ANGLE = 7

Use with set_param_min(), set_param_max(), and set_param_curve() to set angle properties.

PARAM_SCALE = 8

Use with set_param_min(), set_param_max(), and set_param_curve() to set scale properties.

PARAM_HUE_VARIATION = 9

Use with set_param_min(), set_param_max(), and set_param_curve() to set hue variation properties.

PARAM_ANIM_SPEED = 10

Use with set_param_min(), set_param_max(), and set_param_curve() to set animation speed properties.

PARAM_ANIM_OFFSET = 11

Use with set_param_min(), set_param_max(), and set_param_curve() to set animation offset properties.

PARAM_MAX = 12

Represents the size of the Parameter enum.

enum ParticleFlags
PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY = 0

Use with set_particle_flag() to set particle_flag_align_y.

PARTICLE_FLAG_ROTATE_Y = 1

Use with set_particle_flag() to set particle_flag_rotate_y.

PARTICLE_FLAG_DISABLE_Z = 2

Use with set_particle_flag() to set particle_flag_disable_z.

PARTICLE_FLAG_MAX = 3

Represents the size of the ParticleFlags 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_SPHERE_SURFACE = 2

Particles will be emitted on the surface of a sphere.

EMISSION_SHAPE_BOX = 3

Particles will be emitted in the volume of a box.

EMISSION_SHAPE_POINTS = 4

Particles will be emitted at a position chosen randomly among emission_points. Particle color will be modulated by emission_colors.

EMISSION_SHAPE_DIRECTED_POINTS = 5

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_RING = 6

Particles will be emitted in a ring or cylinder.

EMISSION_SHAPE_MAX = 7

Represents the size of the EmissionShape enum.