Parameter

Types

• enum DrawOrder
• enum EmissionShape
• enum ParticleFlags

Type members

• class var godotClassName: StringName

Instance members

• var amount: Int32

  Number of particles emitted in one emission cycle.

• var angleCurve: Curve?

  Each particle’s rotation will be animated along this Curve.

• var angleMax: Double

  Maximum angle.

• var angleMin: Double

  Minimum angle.

• var angularVelocityCurve: Curve?

  Each particle’s angular velocity (rotation speed) will vary along this Curve over its lifetime.

• var angularVelocityMax: Double

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

• var angularVelocityMin: Double

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

• var animOffsetCurve: Curve?

  Each particle’s animation offset will vary along this Curve.

• var animOffsetMax: Double

  Maximum animation offset.

• var animOffsetMin: Double

  Minimum animation offset.

• var animSpeedCurve: Curve?

  Each particle’s animation speed will vary along this Curve.

• var animSpeedMax: Double

  Maximum particle animation speed.

• var animSpeedMin: Double

  Minimum particle animation speed.

• var color: Color

  Each particle’s initial color.

• var colorInitialRamp: Gradient?

  Each particle’s initial color will vary along this GradientTexture1D (multiplied with color).

• var colorRamp: Gradient?

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

• var dampingCurve: Curve?

  Damping will vary along this Curve.

• var dampingMax: Double

  Maximum damping.

• var dampingMin: Double

  Minimum damping.

• var direction: Vector3

  Unit vector specifying the particles’ emission direction.

• var drawOrder: CPUParticles3D.DrawOrder

  Particle draw order. Uses DrawOrder values.

• var emissionBoxExtents: Vector3

  The rectangle’s extents if emissionShape is set to .box.

• var emissionColors: PackedColorArray

  Sets the Colors to modulate particles by when using .points or .directedPoints.

• var emissionNormals: PackedVector3Array

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

• var emissionPoints: PackedVector3Array

  Sets the initial positions to spawn particles when using .points or .directedPoints.

• var emissionRingAxis: Vector3

  The axis of the ring when using the emitter .ring.

• var emissionRingHeight: Double

  The height of the ring when using the emitter .ring.

• var emissionRingInnerRadius: Double

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

• var emissionRingRadius: Double

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

• var emissionShape: CPUParticles3D.EmissionShape

  Particles will be emitted inside this region. See EmissionShape for possible values.

• var emissionSphereRadius: Double

  The sphere’s radius if EmissionShape is set to .sphere.

• var emitting: Bool

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

• var explosiveness: Double

  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 finished: SimpleSignal

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

• var fixedFps: Int32

  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: Double

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

• var fractDelta: Bool

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

• var gravity: Vector3

  Gravity applied to every particle.

• var hueVariationCurve: Curve?

  Each particle’s hue will vary along this Curve.

• var hueVariationMax: Double

  Maximum hue variation.

• var hueVariationMin: Double

  Minimum hue variation.

• var initialVelocityMax: Double

  Maximum value of the initial velocity.

• var initialVelocityMin: Double

  Minimum value of the initial velocity.

• var lifetime: Double

  Amount of time each particle will exist.

• var lifetimeRandomness: Double

  Particle lifetime randomness ratio.

• var linearAccelCurve: Curve?

  Each particle’s linear acceleration will vary along this Curve.

• var linearAccelMax: Double

  Maximum linear acceleration.

• var linearAccelMin: Double

  Minimum linear acceleration.

• var localCoords: Bool

  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 oneShot: Bool

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

• var orbitVelocityCurve: Curve?

  Each particle’s orbital velocity will vary along this Curve.

• var orbitVelocityMax: Double

  Maximum orbit velocity.

• var orbitVelocityMin: Double

  Minimum orbit velocity.

• var particleFlagAlignY: Bool

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

• var particleFlagDisableZ: Bool

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

• var particleFlagRotateY: Bool

  If true, particles rotate around Y axis by angleMin.

• var preprocess: Double

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

• var radialAccelCurve: Curve?

  Each particle’s radial acceleration will vary along this Curve.

• var radialAccelMax: Double

  Maximum radial acceleration.

• var radialAccelMin: Double

  Minimum radial acceleration.

• var randomness: Double

  Emission lifetime randomness ratio.

• var scaleAmountCurve: Curve?

  Each particle’s scale will vary along this Curve.

• var scaleAmountMax: Double

  Maximum scale.

• var scaleAmountMin: Double

  Minimum scale.

• var scaleCurveX: Curve?

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

• var scaleCurveY: Curve?

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

• var scaleCurveZ: Curve?

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

• var speedScale: Double

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

• var splitScale: Bool

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

• var spread: Double

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

• var tangentialAccelCurve: Curve?

  Each particle’s tangential acceleration will vary along this Curve.

• var tangentialAccelMax: Double

  Maximum tangent acceleration.

• var tangentialAccelMin: Double

  Minimum tangent acceleration.

• func convertFromParticles(Node?)

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

• func restart()

  Restarts the particle emitter.