Particles2D

2D particle emitter.

2D particle node used to create a variety of particle systems and effects. Particles2D 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 Particles2D {

enum string _GODOT_internal_name;

union __anonymous;

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

bool opEquals(Particles2D other);

Particles2D opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static Particles2D _new();

enum DrawOrder;

enum Constants;

void setEmitting(bool emitting);

void setAmount(long amount);

void setLifetime(double secs);

void setOneShot(bool secs);

void setPreProcessTime(double secs);

void setExplosivenessRatio(double ratio);

void setRandomnessRatio(double ratio);

void setVisibilityRect(Rect2 visibility_rect);

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();

Rect2 getVisibilityRect();

bool getUseLocalCoordinates();

long getFixedFps();

bool getFractionalDelta();

Ref!Material getProcessMaterial();

double getSpeedScale();

void setDrawOrder(long order);

Particles2D.DrawOrder getDrawOrder();

void setTexture(Texture texture);

Ref!Texture getTexture();

void setNormalMap(Texture texture);

Ref!Texture getNormalMap();

Rect2 captureRect();

void setVFrames(long frames);

long getVFrames();

void setHFrames(long frames);

long getHFrames();

void restart();

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];

Rect2 visibilityRect [@property getter];

Rect2 visibilityRect [@property setter];

bool localCoords [@property getter];

bool localCoords [@property setter];

Particles2D.DrawOrder drawOrder [@property getter];

long drawOrder [@property setter];

Texture texture [@property getter];

Texture texture [@property setter];

Texture normalMap [@property getter];

Texture normalMap [@property setter];

long hFrames [@property getter];

long hFrames [@property setter];

long vFrames [@property getter];

long vFrames [@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

captureRect Rect2 captureRect()
getAmount long getAmount()
getDrawOrder Particles2D.DrawOrder getDrawOrder()
getExplosivenessRatio double getExplosivenessRatio()
getFixedFps long getFixedFps()
getFractionalDelta bool getFractionalDelta()
getHFrames long getHFrames()
getLifetime double getLifetime()
getNormalMap Ref!Texture getNormalMap()
getOneShot bool getOneShot()
getPreProcessTime double getPreProcessTime()
getProcessMaterial Ref!Material getProcessMaterial()
getRandomnessRatio double getRandomnessRatio()
getSpeedScale double getSpeedScale()
getTexture Ref!Texture getTexture()
getUseLocalCoordinates bool getUseLocalCoordinates()
getVFrames long getVFrames()
getVisibilityRect Rect2 getVisibilityRect()
isEmitting bool isEmitting()
opAssign Particles2D opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Particles2D 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()
setAmount void setAmount(long amount)
setDrawOrder void setDrawOrder(long order)
setEmitting void setEmitting(bool emitting)
setExplosivenessRatio void setExplosivenessRatio(double ratio)
setFixedFps void setFixedFps(long fps)
setFractionalDelta void setFractionalDelta(bool enable)
setHFrames void setHFrames(long frames)
setLifetime void setLifetime(double secs)
setNormalMap void setNormalMap(Texture texture)
setOneShot void setOneShot(bool secs)
setPreProcessTime void setPreProcessTime(double secs)
setProcessMaterial void setProcessMaterial(Material material)
setRandomnessRatio void setRandomnessRatio(double ratio)
setSpeedScale void setSpeedScale(double scale)
setTexture void setTexture(Texture texture)
setUseLocalCoordinates void setUseLocalCoordinates(bool enable)
setVFrames void setVFrames(long frames)
setVisibilityRect void setVisibilityRect(Rect2 visibility_rect)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

amount long amount [@property getter]
long amount [@property setter]: Number of particles emitted in one emission cycle.
drawOrder Particles2D.DrawOrder drawOrder [@property getter]
long drawOrder [@property setter]: Particle draw order. Uses DRAW_ORDER_* values. Default value: DRAW_ORDER_INDEX.
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]: 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. Default value: 0.
fixedFps long fixedFps [@property getter]
long fixedFps [@property setter]
fractDelta bool fractDelta [@property getter]
bool fractDelta [@property setter]
hFrames long hFrames [@property getter]
long hFrames [@property setter]: Number of horizontal frames in texture.
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.
normalMap Texture normalMap [@property getter]
Texture normalMap [@property setter]
oneShot bool oneShot [@property getter]
bool oneShot [@property setter]: If true only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle's end. Default value: false.
preprocess double preprocess [@property getter]
double preprocess [@property setter]: Particle system starts as if it had already run for this many seconds.
randomness double randomness [@property getter]
double randomness [@property setter]: Emission lifetime randomness ratio. Default value: 0.
speedScale double speedScale [@property getter]
double speedScale [@property setter]: Particle system's running speed scaling ratio. Default value: 1. A value of 0 can be used to pause the particles.
texture Texture texture [@property getter]
Texture texture [@property setter]: Particle texture. If null particles will be squares.
vFrames long vFrames [@property getter]
long vFrames [@property setter]: Number of vertical frames in texture.
visibilityRect Rect2 visibilityRect [@property getter]
Rect2 visibilityRect [@property setter]: Editor visibility helper.

Static functions

_new Particles2D _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 particles2d structs

Particles2D