Click or drag to resize

CPUParticles Properties

The CPUParticles type exposes the following members.

Properties
  NameDescription
Public property_ImportPath (Inherited from Node.)
Public propertyAmount

The number of particles emitted in one emission cycle (corresponding to the Lifetime).

Note: Changing Amount will reset the particle emission, therefore removing all particles that were already emitted before changing Amount.

Public propertyAngle

Initial rotation applied to each particle, in degrees.

Public propertyAngleCurve

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

Public propertyAngleRandom

Rotation randomness ratio.

Public propertyAngularVelocity

Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.

Public propertyAngularVelocityCurve

Each particle's angular velocity will vary along this Curve.

Public propertyAngularVelocityRandom

Angular velocity randomness ratio.

Public propertyAnimOffset

Particle animation offset.

Public propertyAnimOffsetCurve

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

Public propertyAnimOffsetRandom

Animation offset randomness ratio.

Public propertyAnimSpeed

Particle animation speed.

Public propertyAnimSpeedCurve

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

Public propertyAnimSpeedRandom

Animation speed randomness ratio.

Public propertyCastShadow (Inherited from GeometryInstance.)
Public propertyColor

Unused for 3D particles.

Public propertyColorRamp

Unused for 3D particles.

Public propertyCustomMultiplayer

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

(Inherited from Node.)
Public propertyDamping

The rate at which particles lose velocity.

Public propertyDampingCurve

Damping will vary along this Curve.

Public propertyDampingRandom

Damping randomness ratio.

Public propertyDirection

Unit vector specifying the particles' emission direction.

Public propertyDrawOrder
Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyEditorDescription (Inherited from Node.)
Public propertyEmissionBoxExtents

The rectangle's extents if EmissionShape is set to .

Public propertyEmissionColors

Sets the Colors to modulate particles by when using or .

Public propertyEmissionNormals

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

Public propertyEmissionPoints

Sets the initial positions to spawn particles when using or .

Public propertyEmissionShape

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

Public propertyEmissionSphereRadius
Public propertyEmitting

If true, particles are being emitted.

Public propertyExplosiveness

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.

Public propertyExtraCullMargin

The extra distance added to the GeometryInstance's bounding box (AABB) to increase its cull box.

(Inherited from GeometryInstance.)
Public propertyFilename

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

(Inherited from Node.)
Public propertyFixedFps

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

Public propertyFlagAlignY

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

Public propertyFlagDisableZ

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

Public propertyFlagRotateY

If true, particles rotate around Y axis by Angle.

Public propertyFlatness

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

Public propertyFractDelta

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

Public propertyGenerateLightmap

When disabled, the mesh will be taken into account when computing indirect lighting, but the resulting lightmap will not be saved. Useful for emissive only materials or shadow casters.

(Inherited from GeometryInstance.)
Public propertyGizmo

The SpatialGizmo for this node. Used for example in [!:Godot.EditorSpatialGizmo] as custom visualization and editing handles in Editor.

(Inherited from Spatial.)
Public propertyGlobalTransform

World space (global) Transform of this node.

(Inherited from Spatial.)
Public propertyGravity

Gravity applied to every particle.

Public propertyHueVariation

Initial hue variation applied to each particle.

Public propertyHueVariationCurve

Each particle's hue will vary along this Curve.

Public propertyHueVariationRandom

Hue variation randomness ratio.

Public propertyInitialVelocity

Initial velocity magnitude for each particle. Direction comes from Spread and the node's orientation.

Public propertyInitialVelocityRandom

Initial velocity randomness ratio.

Public propertyLayers

The render layer(s) this VisualInstance is drawn on.

This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.

(Inherited from VisualInstance.)
Public propertyLifetime

The amount of time each particle will exist (in seconds).

Public propertyLifetimeRandomness

Particle lifetime randomness ratio.

Public propertyLightmapScale

Scale factor for the generated baked lightmap. Useful for adding detail to certain mesh instances.

(Inherited from GeometryInstance.)
Public propertyLinearAccel

Linear acceleration applied to each particle in the direction of motion.

Public propertyLinearAccelCurve

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

Public propertyLinearAccelRandom

Linear acceleration randomness ratio.

Public propertyLocalCoords

If true, particles use the parent node's coordinate space. If false, they use global coordinates.

Public propertyLodMaxDistance

The GeometryInstance's max LOD distance.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyLodMaxHysteresis

The GeometryInstance's max LOD margin.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyLodMinDistance

The GeometryInstance's min LOD distance.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyLodMinHysteresis

The GeometryInstance's min LOD margin.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyMaterialOverride

The material override for the whole geometry.

If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

(Inherited from GeometryInstance.)
Public propertyMesh

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

Public propertyMultiplayer

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

(Inherited from Node.)
Public propertyName

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

(Inherited from Node.)
Public propertyNativeInstance (Inherited from Object.)
Public propertyOneShot

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

Public propertyOrbitVelocity

Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second.

This property is only available when FlagDisableZ is true.

Public propertyOrbitVelocityCurve

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

Public propertyOrbitVelocityRandom

Orbital velocity randomness ratio.

Public propertyOwner

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

(Inherited from Node.)
Public propertyPauseMode

Pause mode. How the node will behave if the SceneTree is paused.

(Inherited from Node.)
Public propertyPreprocess

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

Public propertyProcessPriority

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

(Inherited from Node.)
Public propertyRadialAccel

Radial acceleration applied to each particle. Makes particle accelerate away from origin.

Public propertyRadialAccelCurve

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

Public propertyRadialAccelRandom

Radial acceleration randomness ratio.

Public propertyRandomness

Emission lifetime randomness ratio.

Public propertyRotation

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

(Inherited from Spatial.)
Public propertyRotationDegrees

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

(Inherited from Spatial.)
Public propertyScale

Scale part of the local transformation.

(Inherited from Spatial.)
Public propertyScaleAmount

Initial scale applied to each particle.

Public propertyScaleAmountCurve

Each particle's scale will vary along this Curve.

Public propertyScaleAmountRandom

Scale randomness ratio.

Public propertySpeedScale

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

Public propertySpread

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

Public propertyTangentialAccel

Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.

Public propertyTangentialAccelCurve

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

Public propertyTangentialAccelRandom

Tangential acceleration randomness ratio.

Public propertyTransform

Local space Transform of this node, with respect to the parent node.

(Inherited from Spatial.)
Public propertyTranslation

Local translation of this node.

(Inherited from Spatial.)
Public propertyUseInBakedLight

If true, this GeometryInstance will be used when baking lights using a GIProbe or BakedLightmap.

(Inherited from GeometryInstance.)
Public propertyVisible

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

(Inherited from Spatial.)
Top
See Also