particles

The global instance of ParticleAPI

field signature:
particles 
 Method Property Fluent Description Representation
Field Type a ParticleAPI ParticleAPI 
   
ParticleAPI.addParticle 
figura.docs.particles.add_particle
overload 1:
                        
particles:addParticle(name, posVel)  
 typings.2002444083Method Property Fluent Description Representation
name accepts a String String 
   
posVel accepts   
Return Value a Particle Particle 
   
overload 2:
                        
particles:addParticle(name, pos)  
 Method Property Fluent Description Representation
name accepts a String String 
   
pos accepts a Vector3 Vector3 
   
Return Value a Particle Particle 
   
overload 3:
                        
particles:addParticle(name, pos, vel)  
 Method Property Fluent Description Representation
name accepts a String String 
   
pos accepts a Vector3 Vector3 
   
vel accepts a Vector3 Vector3 
   
Return Value a Particle Particle 
   
overload 4:
                        
particles:addParticle(name, posX, posY, posZ)  
 Method Property Fluent Description Representation
name accepts a String String 
   
posX accepts a Number Number 
   
posY accepts a Number Number 
   
posZ accepts a Number Number 
   
Return Value a Particle Particle 
   
overload 5:
                        
particles:addParticle(name, pos, velX, velY, velZ)  
 Method Property Fluent Description Representation
name accepts a String String 
   
pos accepts a Vector3 Vector3 
   
velX accepts a Number Number 
   
velY accepts a Number Number 
   
velZ accepts a Number Number 
   
Return Value a Particle Particle 
   
overload 6:
                        
particles:addParticle(name, posX, posY, posZ, vel)  
 Method Property Fluent Description Representation
name accepts a String String 
   
posX accepts a Number Number 
   
posY accepts a Number Number 
   
posZ accepts a Number Number 
   
vel accepts a Vector3 Vector3 
   
Return Value a Particle Particle 
   
overload 7:
                        
particles:addParticle(name, posX, posY, posZ, velX, velY, velZ)  
 Method Property Fluent Description Representation
name accepts a String String 
   
posX accepts a Number Number 
   
posY accepts a Number Number 
   
posZ accepts a Number Number 
   
velX accepts a Number Number 
   
velY accepts a Number Number 
   
velZ accepts a Number Number 
   
Return Value a Particle Particle 
   
ParticleAPI.removeParticles 
Removes all particles spawned from this avatar
overload 1:
                        
particles:removeParticles()  
 Method Property Fluent Description Representation
Return Value nil nil

Global Objects

Miscellaneous Types

Miscelanous

action_wheel

animations

nameplate

world

vanilla_model

models

player

events

keybind

vectors

matrices

particles

sounds

pings

textures

Miscellaneous Enums

particles

ParticleAPI.addParticle

ParticleAPI.removeParticles

Method Property	Fluent Description	Representation
name accepts	a String	`String`
posVel accepts
Return Value	a Particle	`Particle`