Particles

3D particle emitter.

3D particle node used to create a variety of particle systems and effects. Particles features an emitter that generates some number of particles at a given rate. Use the process_material property to add a ParticlesMaterial to configure particle appearance and behavior. Alternatively, you can add a ShaderMaterial which will be applied to all particles.

@GodotBaseClass

struct Particles {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(Particles other);

Particles opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static Particles _new();

enum DrawOrder;

enum Constants;

void setEmitting(bool emitting);

void setAmount(long amount);

void setLifetime(double secs);

void setOneShot(bool enable);

void setPreProcessTime(double secs);

void setExplosivenessRatio(double ratio);

void setRandomnessRatio(double ratio);

void setVisibilityAabb(AABB aabb);

void setUseLocalCoordinates(bool enable);

void setFixedFps(long fps);

void setFractionalDelta(bool enable);

void setProcessMaterial(Material material);

void setSpeedScale(double scale);

bool isEmitting();

long getAmount();

double getLifetime();

bool getOneShot();

double getPreProcessTime();

double getExplosivenessRatio();

double getRandomnessRatio();

AABB getVisibilityAabb();

bool getUseLocalCoordinates();

long getFixedFps();

bool getFractionalDelta();

Ref!Material getProcessMaterial();

double getSpeedScale();

void setDrawOrder(long order);

Particles.DrawOrder getDrawOrder();

void setDrawPasses(long passes);

void setDrawPassMesh(long pass, Mesh mesh);

long getDrawPasses();

Ref!Mesh getDrawPassMesh(long pass);

void restart();

AABB captureAabb();

bool emitting [@property getter];

bool emitting [@property setter];

long amount [@property getter];

long amount [@property setter];

double lifetime [@property getter];

double lifetime [@property setter];

bool oneShot [@property getter];

bool oneShot [@property setter];

double preprocess [@property getter];

double preprocess [@property setter];

double speedScale [@property getter];

double speedScale [@property setter];

double explosiveness [@property getter];

double explosiveness [@property setter];

double randomness [@property getter];

double randomness [@property setter];

long fixedFps [@property getter];

long fixedFps [@property setter];

bool fractDelta [@property getter];

bool fractDelta [@property setter];

AABB visibilityAabb [@property getter];

AABB visibilityAabb [@property setter];

bool localCoords [@property getter];

bool localCoords [@property setter];

Particles.DrawOrder drawOrder [@property getter];

long drawOrder [@property setter];

long drawPasses [@property getter];

long drawPasses [@property setter];

Mesh drawPass1 [@property getter];

Mesh drawPass1 [@property setter];

Mesh drawPass2 [@property getter];

Mesh drawPass2 [@property setter];

Mesh drawPass3 [@property getter];

Mesh drawPass3 [@property setter];

Mesh drawPass4 [@property getter];

Mesh drawPass4 [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
DrawOrder enum DrawOrder

Functions

captureAabb AABB captureAabb()
getAmount long getAmount()
getDrawOrder Particles.DrawOrder getDrawOrder()
getDrawPassMesh Ref!Mesh getDrawPassMesh(long pass)
getDrawPasses long getDrawPasses()
getExplosivenessRatio double getExplosivenessRatio()
getFixedFps long getFixedFps()
getFractionalDelta bool getFractionalDelta()
getLifetime double getLifetime()
getOneShot bool getOneShot()
getPreProcessTime double getPreProcessTime()
getProcessMaterial Ref!Material getProcessMaterial()
getRandomnessRatio double getRandomnessRatio()
getSpeedScale double getSpeedScale()
getUseLocalCoordinates bool getUseLocalCoordinates()
getVisibilityAabb AABB getVisibilityAabb()
isEmitting bool isEmitting()
opAssign Particles opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Particles 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.
restart void restart(): Restarts the particle emmission, clearing existing particles.
setAmount void setAmount(long amount)
setDrawOrder void setDrawOrder(long order)
setDrawPassMesh void setDrawPassMesh(long pass, Mesh mesh)
setDrawPasses void setDrawPasses(long passes)
setEmitting void setEmitting(bool emitting)
setExplosivenessRatio void setExplosivenessRatio(double ratio)
setFixedFps void setFixedFps(long fps)
setFractionalDelta void setFractionalDelta(bool enable)
setLifetime void setLifetime(double secs)
setOneShot void setOneShot(bool enable)
setPreProcessTime void setPreProcessTime(double secs)
setProcessMaterial void setProcessMaterial(Material material)
setRandomnessRatio void setRandomnessRatio(double ratio)
setSpeedScale void setSpeedScale(double scale)
setUseLocalCoordinates void setUseLocalCoordinates(bool enable)
setVisibilityAabb void setVisibilityAabb(AABB aabb)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

amount long amount [@property getter]
long amount [@property setter]: Number of particles to emit.
drawOrder Particles.DrawOrder drawOrder [@property getter]
long drawOrder [@property setter]: Particle draw order. Uses DRAW_ORDER_* values. Default value: DRAW_ORDER_INDEX.
drawPass1 Mesh drawPass1 [@property getter]
Mesh drawPass1 [@property setter]: Mesh that is drawn for the first draw pass.
drawPass2 Mesh drawPass2 [@property getter]
Mesh drawPass2 [@property setter]: Mesh that is drawn for the second draw pass.
drawPass3 Mesh drawPass3 [@property getter]
Mesh drawPass3 [@property setter]: Mesh that is drawn for the third draw pass.
drawPass4 Mesh drawPass4 [@property getter]
Mesh drawPass4 [@property setter]: Mesh that is drawn for the fourth draw pass.
drawPasses long drawPasses [@property getter]
long drawPasses [@property setter]: The number of draw passes when rendering particles.
emitting bool emitting [@property getter]
bool emitting [@property setter]: If true particles are being emitted. Default value: true.
explosiveness double explosiveness [@property getter]
double explosiveness [@property setter]: Time ratio between each emission. If 0 particles are emitted continuously. If 1 all particles are emitted simultaneously. Default value: 0.
fixedFps long fixedFps [@property getter]
long fixedFps [@property setter]
fractDelta bool fractDelta [@property getter]
bool fractDelta [@property setter]
lifetime double lifetime [@property getter]
double lifetime [@property setter]: Amount of time each particle will exist. Default value: 1.
localCoords bool localCoords [@property getter]
bool localCoords [@property setter]: If true particles use the parent node's coordinate space. If false they use global coordinates. Default value: true.
oneShot bool oneShot [@property getter]
bool oneShot [@property setter]: If true only amount particles will be emitted. Default value: false.
preprocess double preprocess [@property getter]
double preprocess [@property setter]: Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.
randomness double randomness [@property getter]
double randomness [@property setter]: Emission randomness ratio. Default value: 0.
speedScale double speedScale [@property getter]
double speedScale [@property setter]: Speed scaling ratio. Default value: 1. A value of 0 can be used to pause the particles.
visibilityAabb AABB visibilityAabb [@property getter]
AABB visibilityAabb [@property setter]: The AABB that determines the area of the world part of which needs to be visible on screen for the particle system to be active.

Static functions

_new Particles _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

Source

See Implementation

godot particles structs

Particles