particles

The global instance of ParticleAPI
field signature:
particles
Method Property Fluent Description Representation
Field Type a ParticleAPI

ParticleAPI.newParticle

Creates a particle with the given name at the specified position, with the given velocity
Some particles have special properties,
like the "dust" particle
For these particles, the special properties can be put into the "name" parameter,
the same way as it works for commands
overload 1:
particles:newParticle(name, posVel)
typings.2002444083
Method Property Fluent Description Representation
name accepts a String
posVel accepts
Return Value a Particle
overload 2:
particles:newParticle(name, pos)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
Return Value a Particle
overload 3:
particles:newParticle(name, pos, vel)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
vel accepts a Vector3
Return Value a Particle
overload 4:
particles:newParticle(name, posX, posY, posZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value a Particle
overload 5:
particles:newParticle(name, pos, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value a Particle
overload 6:
particles:newParticle(name, posX, posY, posZ, vel)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
vel accepts a Vector3
Return Value a Particle
overload 7:
particles:newParticle(name, posX, posY, posZ, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value a Particle

ParticleAPI.removeParticles

Removes all particles spawned from this avatar
overload 1:
particles:removeParticles()
Method Property Fluent Description Representation
Return Value nil
a a