Up to date

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

GPUParticles3D

Inherits: GeometryInstance3D < VisualInstance3D < Node3D < Node < Object

3D particle emitter.

Description

3D particle node used to create a variety of particle systems and effects. GPUParticles3D features an emitter that generates some number of particles at a given rate.

Use the process_material property to add a ParticleProcessMaterial to configure particle appearance and behavior. Alternatively, you can add a ShaderMaterial which will be applied to all particles.

Tutorials

• Controlling thousands of fish with Particles

• Third Person Shooter Demo

Properties

Methods

Enumerations

enum DrawOrder:

DrawOrder DRAW_ORDER_INDEX = 0

Particles are drawn in the order emitted.

DrawOrder DRAW_ORDER_LIFETIME = 1

Particles are drawn in order of remaining lifetime.

DrawOrder DRAW_ORDER_REVERSE_LIFETIME = 2

DrawOrder DRAW_ORDER_VIEW_DEPTH = 3

Particles are drawn in order of depth.

enum EmitFlags:

EmitFlags EMIT_FLAG_POSITION = 1

Particle starts at the specified position.

EmitFlags EMIT_FLAG_ROTATION_SCALE = 2

Particle starts with specified rotation and scale.

EmitFlags EMIT_FLAG_VELOCITY = 4

Particle starts with the specified velocity vector, which defines the emission direction and speed.

EmitFlags EMIT_FLAG_COLOR = 8

Particle starts with specified color.

EmitFlags EMIT_FLAG_CUSTOM = 16

Particle starts with specified CUSTOM data.

enum TransformAlign:

TransformAlign TRANSFORM_ALIGN_DISABLED = 0

TransformAlign TRANSFORM_ALIGN_Z_BILLBOARD = 1

TransformAlign TRANSFORM_ALIGN_Y_TO_VELOCITY = 2

TransformAlign TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY = 3

Constants

MAX_DRAW_PASSES = 4

Maximum number of draw passes supported.

Property Descriptions

int amount = 8

• void set_amount ( int value )

• int get_amount ( )

Number of particles to emit.

float collision_base_size = 0.01

• void set_collision_base_size ( float value )

• float get_collision_base_size ( )

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 ( )

Particle draw order. Uses DrawOrder values.

Mesh draw_pass_1

• void set_draw_pass_mesh ( int pass, Mesh mesh )

• Mesh get_draw_pass_mesh ( int pass ) const

Mesh that is drawn for the first draw pass.

Mesh draw_pass_2

• void set_draw_pass_mesh ( int pass, Mesh mesh )

• Mesh get_draw_pass_mesh ( int pass ) const

Mesh that is drawn for the second draw pass.

Mesh draw_pass_3

• void set_draw_pass_mesh ( int pass, Mesh mesh )

• Mesh get_draw_pass_mesh ( int pass ) const

Mesh that is drawn for the third draw pass.

Mesh draw_pass_4

• void set_draw_pass_mesh ( int pass, Mesh mesh )

• Mesh get_draw_pass_mesh ( int pass ) const

Mesh that is drawn for the fourth draw pass.

int draw_passes = 1

• void set_draw_passes ( int value )

• int get_draw_passes ( )

The number of draw passes when rendering particles.

Skin draw_skin

• void set_skin ( Skin value )

• Skin get_skin ( )

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 ( )

If true, particles are being emitted.

float explosiveness = 0.0

• void set_explosiveness_ratio ( float value )

• float get_explosiveness_ratio ( )

Time ratio between each emission. If 0, particles are emitted continuously. If 1, all particles are emitted simultaneously.

int fixed_fps = 30

• void set_fixed_fps ( int value )

• int get_fixed_fps ( )

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 simulation of the particle system itself.

bool fract_delta = true

• void set_fractional_delta ( bool value )

• bool get_fractional_delta ( )

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

bool interpolate = true

• void set_interpolate ( bool value )

• bool get_interpolate ( )

Enables particle interpolation, which makes the particle movement smoother when their fixed_fps is lower than the screen refresh rate.

float lifetime = 1.0

• void set_lifetime ( float value )

• float get_lifetime ( )

Amount of time each particle will exist.

bool local_coords = false

• void set_use_local_coordinates ( bool value )

• bool get_use_local_coordinates ( )

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

bool one_shot = false

• void set_one_shot ( bool value )

• bool get_one_shot ( )

If true, only amount particles will be emitted.

float preprocess = 0.0

• void set_pre_process_time ( float value )

• float get_pre_process_time ( )

Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.

Material process_material

• void set_process_material ( Material value )

• Material get_process_material ( )

Material for processing particles. Can be a ParticleProcessMaterial or a ShaderMaterial.

float randomness = 0.0

• void set_randomness_ratio ( float value )

• float get_randomness_ratio ( )

Emission randomness ratio.

float speed_scale = 1.0

• void set_speed_scale ( float value )

• float get_speed_scale ( )

Speed scaling ratio. A value of 0 can be used to pause the particles.

NodePath sub_emitter = NodePath("")

• void set_sub_emitter ( NodePath value )

• NodePath get_sub_emitter ( )

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

bool trail_enabled = false

• void set_trail_enabled ( bool value )

• bool is_trail_enabled ( )

If true, enables particle trails using a mesh skinning system. Designed to work with RibbonTrailMesh and TubeTrailMesh.

Note: BaseMaterial3D.use_particle_trails must also be enabled on the particle mesh’s material. Otherwise, setting trail_enabled to true will have no effect.

Note: Unlike GPUParticles2D, the number of trail sections and subdivisions is set in the RibbonTrailMesh or the TubeTrailMesh‘s properties.

float trail_lifetime = 0.3

• void set_trail_lifetime ( float value )

• float get_trail_lifetime ( )

The amount of time the particle’s trail should represent (in seconds). Only effective if trail_enabled is true.

TransformAlign transform_align = 0

• void set_transform_align ( TransformAlign value )

• TransformAlign get_transform_align ( )

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

AABB visibility_aabb = AABB(-4, -4, -4, 8, 8, 8)

• void set_visibility_aabb ( AABB value )

• AABB get_visibility_aabb ( )

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.

Method Descriptions

AABB capture_aabb ( ) const

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

void emit_particle ( Transform3D xform, Vector3 velocity, Color color, Color custom, int flags )

Emits a single particle. Whether xform, velocity, color and custom are applied depends on the value of flags. See EmitFlags.

Mesh get_draw_pass_mesh ( int pass ) const

Returns the Mesh that is drawn at index pass.

void restart ( )

Restarts the particle emission, clearing existing particles.

void set_draw_pass_mesh ( int pass, Mesh mesh )

Sets the Mesh that is drawn at index pass.