particles

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

ParticleAPI.addParticle

figura.docs.particles.add_particle
overload 1:
particles:addParticle(name, posVel)
typings.2002444083
Method Property Fluent Description Representation
name accepts a String
posVel accepts
Return Value a Particle
overload 2:
particles:addParticle(name, pos)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
Return Value a Particle
overload 3:
particles:addParticle(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:addParticle(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:addParticle(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:addParticle(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:addParticle(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