Table of Contents

Class GPUParticlesAttractor3D

Abstract base class for 3D particle attractors.

Inheritance
GPUParticlesAttractor3D
Derived

Remarks

Particle attractors can be used to attract particles towards the attractor's origin, or to push them away from the attractor's origin.

Particle attractors work in real-time and can be moved, rotated and scaled during gameplay. Unlike collision shapes, non-uniform scaling of attractors is also supported.

Attractors can be temporarily disabled by hiding them, or by setting their strength to 0.0.

Note: Particle attractors only affect GPUParticles3D, not CPUParticles3D.

Properties

attenuation

The particle attractor's attenuation. Higher values result in more gradual pushing of particles as they come closer to the attractor's origin. Zero or negative values will cause particles to be pushed very fast as soon as the touch the attractor's edges.

var attenuation : float = 1.0

Property Value

float

Remarks

  • void set_attenuation(float value)
  • float get_attenuation

cull_mask

The particle rendering layers (layers) that will be affected by the attractor. By default, all particles are affected by an attractor.

After configuring particle nodes accordingly, specific layers can be unchecked to prevent certain particles from being affected by attractors. For example, this can be used if you're using an attractor as part of a spell effect but don't want the attractor to affect unrelated weather particles at the same position.

Particle attraction can also be disabled on a per-process material basis by setting attractor_interaction_enabled on the GPUParticles3D node.

var cull_mask : int = 4294967295

Property Value

int

Remarks

  • void set_cull_mask(int value)
  • int get_cull_mask

directionality

Adjusts how directional the attractor is. At 0.0, the attractor is not directional at all: it will attract particles towards its center. At 1.0, the attractor is fully directional: particles will always be pushed towards local -Z (or +Z if strength is negative).

Note: If directionality is greater than 0.0, the direction in which particles are pushed can be changed by rotating the GPUParticlesAttractor3D node.

var directionality : float = 0.0

Property Value

float

Remarks

  • void set_directionality(float value)
  • float get_directionality

strength

Adjusts the strength of the attractor. If strength is negative, particles will be pushed in the opposite direction. Particles will be pushed away from the attractor's origin if directionality is 0.0, or towards local +Z if directionality is greater than 0.0.

var strength : float = 1.0

Property Value

float

Remarks

  • void set_strength(float value)
  • float get_strength