particleemitter: members
42 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”addemitmodifier
Section titled “addemitmodifier”particleemitter.addemitmodifier(type: string, rangemin: number, rangemax: number, variable: string, operation: string, valuemin: number, valuemax: number) -> particlemodifier
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Changes every template of future particles on the clock of the emitter; returns the modifier.
findimg(5).emitter.addemitmodifier("range", 0, 5, "zoom", "replace", 1, 2);Specification: particles.md§2.4.
addglobalmodifier
Section titled “addglobalmodifier”particleemitter.addglobalmodifier(type: string, rangemin: number, rangemax: number, variable: string, operation: string, valuemin: number, valuemax: number) -> particlemodifier
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Changes all live particles at once on the clock of the emitter; returns the modifier.
findimg(5).emitter.addglobalmodifier("once", 1, 2, "red", "replace", 0, 1);Specification: particles.md§2.4.
addlocalmodifier
Section titled “addlocalmodifier”particleemitter.addlocalmodifier(type: string, rangemin: number, rangemax: number, variable: string, operation: string, valuemin: number, valuemax: number) -> particlemodifier
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Changes each particle on its own clock; returns the modifier or an empty value when the call is refused.
findimg(5).emitter.addlocalmodifier("range", 1, 3, "alpha", "replace", 0.8, 0);Specification: particles.md§2.1.
advancetime
Section titled “advancetime”particleemitter.advancetime(seconds: number)
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Runs the emitter ahead by the given number of seconds.
findimg(5).emitter.advancetime(2);Specification: particles.md§1.2.
attachposition
Section titled “attachposition”particleemitter.attachposition: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when particles move together with the emitter.
echo(findimg(5).emitter.attachposition);Specification: particles.md§1.2.
autorotation
Section titled “autorotation”particleemitter.autorotation: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when particles turn to face their direction of travel.
echo(findimg(5).emitter.autorotation);Specification: particles.md§1.2.
checkbelowterrain
Section titled “checkbelowterrain”particleemitter.checkbelowterrain: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when particles below the ground are destroyed.
echo(findimg(5).emitter.checkbelowterrain);Specification: particles.md§1.2.
clippingbox
Section titled “clippingbox”particleemitter.clippingbox: array
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Box {x, y, w, h} that particles may not leave.
echo(findimg(5).emitter.clippingbox);Specification: particles.md§1.2.
cliptoscreen
Section titled “cliptoscreen”particleemitter.cliptoscreen: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when the clipping box is the visible area.
echo(findimg(5).emitter.cliptoscreen);Specification: particles.md§1.2.
continueafterdestroy
Section titled “continueafterdestroy”particleemitter.continueafterdestroy: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when live particles finish after their image is destroyed.
echo(findimg(5).emitter.continueafterdestroy);Specification: particles.md§1.2.
currentparticlecount
Section titled “currentparticlecount”particleemitter.currentparticlecount: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no. read-only.
Number of live particles. Read-only.
echo(findimg(5).emitter.currentparticlecount);Specification: particles.md§1.2.
delaymax
Section titled “delaymax”particleemitter.delaymax: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Most seconds between automatic emissions.
echo(findimg(5).emitter.delaymax);Specification: particles.md§1.2.
delaymin
Section titled “delaymin”particleemitter.delaymin: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Fewest seconds between automatic emissions.
echo(findimg(5).emitter.delaymin);Specification: particles.md§1.2.
dimension
Section titled “dimension”particleemitter.dimension: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Stored for later; it has no effect yet.
echo(findimg(5).emitter.particle.dimension);Specification: particles.md§1.3.
dropemitter
Section titled “dropemitter”particleemitter.dropemitter: particleemitter
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Emitter that fires where a particle touches the ground or ends its life.
echo(findimg(5).emitter.dropemitter);Specification: particles.md§1.2.
dropwateremitter
Section titled “dropwateremitter”particleemitter.dropwateremitter: particleemitter
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Emitter that fires where a particle touches water.
echo(findimg(5).emitter.dropwateremitter);Specification: particles.md§1.2.
emissionoffset
Section titled “emissionoffset”particleemitter.emissionoffset: array
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Spawn point relative to the emitter as {x, y, z}.
echo(findimg(5).emitter.emissionoffset);Specification: particles.md§1.2.
particleemitter.emit()
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Emits one batch of particles now, apart from the timer.
findimg(5).emitter.emit();Specification: particles.md§1.2.
emitat
Section titled “emitat”particleemitter.emitat(position: string)
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Emits one batch of particles now with the origin at the given position in tiles written {x, y, z}.
findimg(5).emitter.emitat("{20, 30, 0}");Specification: standard-library.md§17.5.5.
emitatterrainheight
Section titled “emitatterrainheight”particleemitter.emitatterrainheight: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Stored for scripts to read back; it has no visible effect because the terrain is flat.
findimg(5).emitter.emitatterrainheight = true;Specification: standard-library.md§17.5.5.
emitautomatically
Section titled “emitautomatically”particleemitter.emitautomatically: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when the emitter emits on its timer.
echo(findimg(5).emitter.emitautomatically);Specification: particles.md§1.2.
emittedparticles
Section titled “emittedparticles”particleemitter.emittedparticles: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no. read-only.
Number of particles emitted so far. Read-only.
echo(findimg(5).emitter.emittedparticles);Specification: particles.md§1.2.
firstinfront
Section titled “firstinfront”particleemitter.firstinfront: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when older particles are drawn in front of younger ones.
echo(findimg(5).emitter.firstinfront);Specification: particles.md§1.2.
forceaboveterrain
Section titled “forceaboveterrain”particleemitter.forceaboveterrain: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
When true a particle that would sink below the ground is lifted back to it.
findimg(5).emitter.forceaboveterrain = true;Specification: standard-library.md§17.5.5.
isfrozen
Section titled “isfrozen”particleemitter.isfrozen: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True while the emitter and its particles are stopped.
echo(findimg(5).emitter.isfrozen);Specification: particles.md§1.2.
lifetime
Section titled “lifetime”particleemitter.lifetime: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Seconds a particle lives.
echo(findimg(5).emitter.particle.lifetime);Specification: particles.md§1.3.
maxparticles
Section titled “maxparticles”particleemitter.maxparticles: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Most live particles of the emitter, 0 to 100000 (default 100000); emissions beyond it are skipped.
echo(findimg(5).emitter.maxparticles);Specification: particles.md§1.2.
movementfactor
Section titled “movementfactor”particleemitter.movementfactor: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Stored for scripts to read back; the default is 1 and it has no visible effect.
findimg(5).emitter.movementfactor = 1;Specification: standard-library.md§17.5.5.
movementvector
Section titled “movementvector”particleemitter.movementvector: array
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Velocity {x, y, z} added to the particle each second.
echo(findimg(5).emitter.particle.movementvector);Specification: particles.md§1.3.
noclipping
Section titled “noclipping”particleemitter.noclipping: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
When true the particles ignore the clipping box.
findimg(5).emitter.noclipping = true;Specification: standard-library.md§17.5.5.
nrofparticles
Section titled “nrofparticles”particleemitter.nrofparticles: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Particles made by each emission, 0 to 1000 (default 0).
echo(findimg(5).emitter.nrofparticles);Specification: particles.md§1.2.
particle
Section titled “particle”particleemitter.particle: object
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Template of new particles; the same object as particles[0].
echo(findimg(5).emitter.particle);Specification: particles.md§1.2.
particles
Section titled “particles”particleemitter.particles: array
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
The particle templates, particletypes of them; particles[0] is particle.
echo(findimg(5).emitter.particles);Specification: particles.md§1.2.
particletypes
Section titled “particletypes”particleemitter.particletypes: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Number of templates, 1 to 100 (default 1); each new particle uses a random one. New templates copy particles[0].
echo(findimg(5).emitter.particletypes);Specification: particles.md§1.2.
removemodifiers
Section titled “removemodifiers”particleemitter.removemodifiers()
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Forgets every local, global, and emit modifier and removes the live particles.
findimg(5).emitter.removemodifiers();Specification: particles.md§1.2.
removeparticles
Section titled “removeparticles”particleemitter.removeparticles()
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Destroys the live particles of the emitter without firing drop emitters.
findimg(5).emitter.removeparticles();Specification: particles.md§1.2.
showonground
Section titled “showonground”particleemitter.showonground: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Stored for scripts to read back; it has no visible effect.
findimg(5).emitter.showonground = true;Specification: standard-library.md§17.5.5.
showontop
Section titled “showontop”particleemitter.showontop: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Stored for scripts to read back; it has no visible effect.
findimg(5).emitter.showontop = true;Specification: standard-library.md§17.5.5.
particleemitter.spin: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Rotation per second in radians.
echo(findimg(5).emitter.particle.spin);Specification: particles.md§1.3.
switchyandzaxis
Section titled “switchyandzaxis”particleemitter.switchyandzaxis: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Stored for scripts to read back; it has no visible effect.
findimg(5).emitter.switchyandzaxis = true;Specification: standard-library.md§17.5.5.
wraptoclippingbox
Section titled “wraptoclippingbox”particleemitter.wraptoclippingbox: boolean
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
True when particles leaving the box enter again on the other side.
echo(findimg(5).emitter.wraptoclippingbox);Specification: particles.md§1.2.
zangle
Section titled “zangle”particleemitter.zangle: number
Runs on: client only. Origin: compatibility. Since: M10. Playground: no.
Elevation of the direction of travel in radians.
echo(findimg(5).emitter.particle.zangle);Specification: particles.md§1.3.
Engine version 0.1.0. Built 2026-11-18.