Click or drag to resize

ParticlesMaterial Properties

The ParticlesMaterial type exposes the following members.

Properties
  NameDescription
Public propertyAngle

Initial rotation applied to each particle, in degrees.

Only applied when FlagDisableZ or FlagRotateY are true or the SpatialMaterial being used to draw the particle is using .

Public propertyAngleCurve

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

Public propertyAngleRandom

Rotation randomness ratio.

Public propertyAngularVelocity

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

Only applied when FlagDisableZ or FlagRotateY are true or the SpatialMaterial being used to draw the particle is using .

Public propertyAngularVelocityCurve

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

Public propertyAngularVelocityRandom

Angular velocity randomness ratio.

Public propertyAnimOffset

Particle animation offset.

Public propertyAnimOffsetCurve

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

Public propertyAnimOffsetRandom

Animation offset randomness ratio.

Public propertyAnimSpeed

Particle animation speed.

Public propertyAnimSpeedCurve

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

Public propertyAnimSpeedRandom

Animation speed randomness ratio.

Public propertyColor

Each particle's initial color. If the Particles2D's texture is defined, it will be multiplied by this color. To have particle display color in a SpatialMaterial make sure to set VertexColorUseAsAlbedo to true.

Public propertyColorRamp

Each particle's color will vary along this GradientTexture.

Public propertyDamping

The rate at which particles lose velocity.

Public propertyDampingCurve

Damping will vary along this CurveTexture.

Public propertyDampingRandom

Damping randomness ratio.

Public propertyDirection

Unit vector specifying the particles' emission direction.

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

The box's extents if emission_shape is set to .

Public propertyEmissionColorTexture

Particle color will be modulated by color determined by sampling this texture at the same point as the EmissionPointTexture.

Public propertyEmissionNormalTexture

Particle velocity and rotation will be set by sampling this texture at the same point as the EmissionPointTexture. Used only in . Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.

Public propertyEmissionPointCount

The number of emission points if emission_shape is set to or .

Public propertyEmissionPointTexture

Particles will be emitted at positions determined by sampling this texture at a random position. Used with and . Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.

Public propertyEmissionShape

Particles will be emitted inside this region. Use ParticlesMaterialEmissionShapeEnum constants for values.

Public propertyEmissionSphereRadius

The sphere's radius if emission_shape is set to .

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

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 propertyLifetimeRandomness

Particle lifetime randomness ratio.

Public propertyLinearAccel

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

Public propertyLinearAccelCurve

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

Public propertyLinearAccelRandom

Linear acceleration randomness ratio.

Public propertyNativeInstance (Inherited from Object.)
Public propertyNextPass

Sets the Material to be used for the next pass. This renders the object again using a different material.

Note: only applies to SpatialMaterials and ShaderMaterials with type "Spatial".

(Inherited from Material.)
Public propertyOrbitVelocity

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

Only available when FlagDisableZ is true.

Public propertyOrbitVelocityCurve

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

Public propertyOrbitVelocityRandom

Orbital velocity randomness ratio.

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

Public propertyRadialAccelRandom

Radial acceleration randomness ratio.

Public propertyRenderPriority

Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects.

Note: this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).

(Inherited from Material.)
Public propertyResourceLocalToScene

If true, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

(Inherited from Resource.)
Public propertyResourceName

The name of the resource. This is an optional identifier. If ResourceName is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the ResourceName will be displayed as the tab name in the script editor.

(Inherited from Resource.)
Public propertyResourcePath

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

(Inherited from Resource.)
Public propertyScale

Initial scale applied to each particle.

Public propertyScaleCurve

Each particle's scale will vary along this CurveTexture.

Public propertyScaleRandom

Scale randomness ratio.

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

Public propertyTangentialAccelRandom

Tangential acceleration randomness ratio.

Public propertyTrailColorModifier

Trail particles' color will vary along this GradientTexture.

Public propertyTrailDivisor

Emitter will emit amount divided by trail_divisor particles. The remaining particles will be used as trail(s).

Public propertyTrailSizeModifier

Trail particles' size will vary along this CurveTexture.

Top
See Also