ParticlesMaterial

Particle properties for Particles and Particles2D nodes.

ParticlesMaterial defines particle properties and behavior. It is used in the process_material of Particles and Particles2D emitter nodes. Some of this material's properties are applied to each particle when emitted, while others can have a CurveTexture applied to vary values over the lifetime of the particle.

@GodotBaseClass
struct ParticlesMaterial {}

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

Constants
enum Constants
EmissionShape
enum EmissionShape
Flags
enum Flags
Parameter
enum Parameter

Functions

getColor
Color getColor()
getColorRamp
Ref!Texture getColorRamp()
getEmissionBoxExtents
Vector3 getEmissionBoxExtents()
getEmissionColorTexture
Ref!Texture getEmissionColorTexture()
getEmissionNormalTexture
Ref!Texture getEmissionNormalTexture()
getEmissionPointCount
long getEmissionPointCount()
getEmissionPointTexture
Ref!Texture getEmissionPointTexture()
getEmissionShape
ParticlesMaterial.EmissionShape getEmissionShape()
getEmissionSphereRadius
double getEmissionSphereRadius()
getFlag
bool getFlag(long flag)
getFlatness
double getFlatness()
getGravity
Vector3 getGravity()
getParam
double getParam(long param)
getParamRandomness
double getParamRandomness(long param)
getParamTexture
Ref!Texture getParamTexture(long param)
getSpread
double getSpread()
getTrailColorModifier
Ref!GradientTexture getTrailColorModifier()
getTrailDivisor
long getTrailDivisor()
getTrailSizeModifier
Ref!CurveTexture getTrailSizeModifier()
opAssign
ParticlesMaterial opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(ParticlesMaterial other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setColor
void setColor(Color color)
setColorRamp
void setColorRamp(Texture ramp)
setEmissionBoxExtents
void setEmissionBoxExtents(Vector3 extents)
setEmissionColorTexture
void setEmissionColorTexture(Texture texture)
setEmissionNormalTexture
void setEmissionNormalTexture(Texture texture)
setEmissionPointCount
void setEmissionPointCount(long point_count)
setEmissionPointTexture
void setEmissionPointTexture(Texture texture)
setEmissionShape
void setEmissionShape(long shape)
setEmissionSphereRadius
void setEmissionSphereRadius(double radius)
setFlag
void setFlag(long flag, bool enable)
setFlatness
void setFlatness(double amount)
setGravity
void setGravity(Vector3 accel_vec)
setParam
void setParam(long param, double value)
setParamRandomness
void setParamRandomness(long param, double randomness)
setParamTexture
void setParamTexture(long param, Texture texture)
setSpread
void setSpread(double degrees)
setTrailColorModifier
void setTrailColorModifier(GradientTexture texture)
setTrailDivisor
void setTrailDivisor(long divisor)
setTrailSizeModifier
void setTrailSizeModifier(CurveTexture texture)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

angle
double angle [@property setter]

Initial rotation applied to each particle.

angle
double angle [@property getter]

Initial rotation applied to each particle.

angleCurve
Texture angleCurve [@property setter]

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

angleCurve
Texture angleCurve [@property getter]

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

angleRandom
double angleRandom [@property setter]

Rotation randomness ratio. Default value: 0.

angleRandom
double angleRandom [@property getter]

Rotation randomness ratio. Default value: 0.

angularVelocity
double angularVelocity [@property getter]
double angularVelocity [@property setter]

Initial angular velocity applied to each particle.

angularVelocityCurve
Texture angularVelocityCurve [@property getter]
Texture angularVelocityCurve [@property setter]

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

angularVelocityRandom
double angularVelocityRandom [@property getter]
double angularVelocityRandom [@property setter]

Angular velocity randomness ratio. Default value: 0.

animLoop
bool animLoop [@property setter]

If true animation will loop. Default value: false.

animLoop
bool animLoop [@property getter]

If true animation will loop. Default value: false.

animOffset
double animOffset [@property setter]

Particle animation offset.

animOffset
double animOffset [@property getter]

Particle animation offset.

animOffsetCurve
Texture animOffsetCurve [@property setter]

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

animOffsetCurve
Texture animOffsetCurve [@property getter]

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

animOffsetRandom
double animOffsetRandom [@property setter]

Animation offset randomness ratio. Default value: 0.

animOffsetRandom
double animOffsetRandom [@property getter]

Animation offset randomness ratio. Default value: 0.

animSpeed
double animSpeed [@property setter]

Particle animation speed.

animSpeed
double animSpeed [@property getter]

Particle animation speed.

animSpeedCurve
Texture animSpeedCurve [@property setter]

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

animSpeedCurve
Texture animSpeedCurve [@property getter]

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

animSpeedRandom
double animSpeedRandom [@property setter]

Animation speed randomness ratio. Default value: 0.

animSpeedRandom
double animSpeedRandom [@property getter]

Animation speed randomness ratio. Default value: 0.

color
Color color [@property setter]

Each particle's initial color. If the Particle2D's texture is defined, it will be multiplied by this color.

color
Color color [@property getter]

Each particle's initial color. If the Particle2D's texture is defined, it will be multiplied by this color.

colorRamp
Texture colorRamp [@property setter]

Each particle's color will vary along this GradientTexture.

colorRamp
Texture colorRamp [@property getter]

Each particle's color will vary along this GradientTexture.

damping
double damping [@property getter]
double damping [@property setter]

The rate at which particles lose velocity.

dampingCurve
Texture dampingCurve [@property setter]

Damping will vary along this CurveTexture.

dampingCurve
Texture dampingCurve [@property getter]

Damping will vary along this CurveTexture.

dampingRandom
double dampingRandom [@property setter]

Damping randomness ratio. Default value: 0.

dampingRandom
double dampingRandom [@property getter]

Damping randomness ratio. Default value: 0.

emissionBoxExtents
Vector3 emissionBoxExtents [@property getter]
Vector3 emissionBoxExtents [@property setter]

The box's extents if emission_shape is set to EMISSION_SHAPE_BOX.

emissionColorTexture
Texture emissionColorTexture [@property getter]
Texture emissionColorTexture [@property setter]
emissionNormalTexture
Texture emissionNormalTexture [@property getter]
Texture emissionNormalTexture [@property setter]
emissionPointCount
long emissionPointCount [@property getter]
long emissionPointCount [@property setter]

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

emissionPointTexture
Texture emissionPointTexture [@property getter]
Texture emissionPointTexture [@property setter]
emissionShape
ParticlesMaterial.EmissionShape emissionShape [@property getter]
long emissionShape [@property setter]

Particles will be emitted inside this region. Use EMISSION_SHAPE_* constants for values. Default value: EMISSION_SHAPE_POINT.

emissionSphereRadius
double emissionSphereRadius [@property getter]
double emissionSphereRadius [@property setter]

The sphere's radius if emission_shape is set to EMISSION_SHAPE_SPHERE.

flagAlignY
bool flagAlignY [@property getter]
bool flagAlignY [@property setter]
flagDisableZ
bool flagDisableZ [@property getter]
bool flagDisableZ [@property setter]

If true particles will not move on the z axis. Default value: true for Particles2D, false for Particles.

flagRotateY
bool flagRotateY [@property getter]
bool flagRotateY [@property setter]
flatness
double flatness [@property getter]
double flatness [@property setter]
gravity
Vector3 gravity [@property setter]

Gravity applied to every particle. Default value: (0, 98, 0).

gravity
Vector3 gravity [@property getter]

Gravity applied to every particle. Default value: (0, 98, 0).

hueVariation
double hueVariation [@property getter]
double hueVariation [@property setter]

Initial hue variation applied to each particle.

hueVariationCurve
Texture hueVariationCurve [@property getter]
Texture hueVariationCurve [@property setter]

Each particle's hue will vary along this CurveTexture.

hueVariationRandom
double hueVariationRandom [@property getter]
double hueVariationRandom [@property setter]

Hue variation randomness ratio. Default value: 0.

initialVelocity
double initialVelocity [@property setter]

Initial velocity for each particle.

initialVelocity
double initialVelocity [@property getter]

Initial velocity for each particle.

initialVelocityRandom
double initialVelocityRandom [@property setter]

Initial velocity randomness ratio. Default value: 0.

initialVelocityRandom
double initialVelocityRandom [@property getter]

Initial velocity randomness ratio. Default value: 0.

linearAccel
double linearAccel [@property setter]

Linear acceleration applied to each particle.

linearAccel
double linearAccel [@property getter]

Linear acceleration applied to each particle.

linearAccelCurve
Texture linearAccelCurve [@property getter]
Texture linearAccelCurve [@property setter]

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

linearAccelRandom
double linearAccelRandom [@property getter]
double linearAccelRandom [@property setter]

Linear acceleration randomness ratio. Default value: 0.

orbitVelocity
double orbitVelocity [@property setter]

Orbital velocity applied to each particle.

orbitVelocity
double orbitVelocity [@property getter]

Orbital velocity applied to each particle.

orbitVelocityCurve
Texture orbitVelocityCurve [@property setter]

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

orbitVelocityCurve
Texture orbitVelocityCurve [@property getter]

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

orbitVelocityRandom
double orbitVelocityRandom [@property setter]

Orbital velocity randomness ratio. Default value: 0.

orbitVelocityRandom
double orbitVelocityRandom [@property getter]

Orbital velocity randomness ratio. Default value: 0.

radialAccel
double radialAccel [@property getter]
double radialAccel [@property setter]

Radial acceleration applied to each particle.

radialAccelCurve
Texture radialAccelCurve [@property getter]
Texture radialAccelCurve [@property setter]

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

radialAccelRandom
double radialAccelRandom [@property getter]
double radialAccelRandom [@property setter]

Radial acceleration randomness ratio. Default value: 0.

scale
double scale [@property getter]
double scale [@property setter]

Initial scale applied to each particle.

scaleCurve
Texture scaleCurve [@property getter]
Texture scaleCurve [@property setter]

Each particle's scale will vary along this CurveTexture.

scaleRandom
double scaleRandom [@property getter]
double scaleRandom [@property setter]

Scale randomness ratio. Default value: 0.

spread
double spread [@property setter]

Each particle's initial direction range from +spread to -spread degrees. Default value: 45.

spread
double spread [@property getter]

Each particle's initial direction range from +spread to -spread degrees. Default value: 45.

tangentialAccel
double tangentialAccel [@property getter]
double tangentialAccel [@property setter]

Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity.

tangentialAccelCurve
Texture tangentialAccelCurve [@property getter]
Texture tangentialAccelCurve [@property setter]

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

tangentialAccelRandom
double tangentialAccelRandom [@property getter]
double tangentialAccelRandom [@property setter]

Tangential acceleration randomness ratio. Default value: 0.

trailColorModifier
GradientTexture trailColorModifier [@property setter]

Trail particles' color will vary along this GradientTexture.

trailColorModifier
GradientTexture trailColorModifier [@property getter]

Trail particles' color will vary along this GradientTexture.

trailDivisor
long trailDivisor [@property setter]

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

trailDivisor
long trailDivisor [@property getter]

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

trailSizeModifier
CurveTexture trailSizeModifier [@property setter]

Trail particles' size will vary along this CurveTexture.

trailSizeModifier
CurveTexture trailSizeModifier [@property getter]

Trail particles' size will vary along this CurveTexture.

Static functions

_new
ParticlesMaterial _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta