Particle

Represents a particle that can be spawned and modified
Obtained by indexing the ParticleAPI
Exists as an object-oriented alternative to particles:addParticle()

Particle.remove

Removes this particle from the world

overload 1:
                        
Particle:remove()  
 Method Property Fluent Description Representation
Return Value a Particle Particle

Method Property	Fluent Description	Representation
Return Value	a Particle	`Particle`

Particle.scale

Sets this particle scale

overload 1:
                        
Particle:scale(scale)  
 Method Property Fluent Description Representation
scale accepts a Number Number 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
scale accepts	a Number	`Number`
Return Value	a Particle	`Particle`

Particle.isAlive

Checks if this particle is not flagged for removal

overload 1:
                        
Particle:isAlive()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Particle.pos

Sets this particle position
The position is given in world coordinates

overload 1:
                        
Particle:pos(pos)  
 Method Property Fluent Description Representation
pos accepts a Vector3 Vector3 
   
Return Value a Particle Particle 
   
overload 2:
                        
Particle:pos(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
pos accepts	a Vector3	`Vector3`
Return Value	a Particle	`Particle`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	a Particle	`Particle`

Particle.color

Sets this particle color
Accepts and alpha value, but most particles do not support it
Default RGBA of 1

overload 1:
                        
Particle:color(rgb)  
 Method Property Fluent Description Representation
rgb accepts a Vector3 Vector3 
   
Return Value a Particle Particle 
   
overload 2:
                        
Particle:color(rgba)  
 Method Property Fluent Description Representation
rgba accepts a Vector4 Vector4 
   
Return Value a Particle Particle 
   
overload 3:
                        
Particle:color(r, g, b, a)  
 Method Property Fluent Description Representation
r accepts a Number Number 
   
g accepts a Number Number 
   
b accepts a Number Number 
   
a accepts a Number Number 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
rgb accepts	a Vector3	`Vector3`
Return Value	a Particle	`Particle`

Method Property	Fluent Description	Representation
rgba accepts	a Vector4	`Vector4`
Return Value	a Particle	`Particle`

Method Property	Fluent Description	Representation
r accepts	a Number	`Number`
g accepts	a Number	`Number`
b accepts	a Number	`Number`
a accepts	a Number	`Number`
Return Value	a Particle	`Particle`

Particle.setColor

Sets this particle color
Accepts and alpha value, but most particles do not support it
Default RGBA of 1

overload 1:
                        
Particle:setColor(rgb)  
 Method Property Fluent Description Representation
rgb accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
Particle:setColor(rgba)  
 Method Property Fluent Description Representation
rgba accepts a Vector4 Vector4 
   
Return Value nil nil 
   
overload 3:
                        
Particle:setColor(r, g, b, a)  
 Method Property Fluent Description Representation
r accepts a Number Number 
   
g accepts a Number Number 
   
b accepts a Number Number 
   
a accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
rgb accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
rgba accepts	a Vector4	`Vector4`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
r accepts	a Number	`Number`
g accepts	a Number	`Number`
b accepts	a Number	`Number`
a accepts	a Number	`Number`
Return Value	nil	`nil`

Particle.setScale

Sets this particle scale

overload 1:
                        
Particle:setScale(scale)  
 Method Property Fluent Description Representation
scale accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
scale accepts	a Number	`Number`
Return Value	nil	`nil`

Particle.getVelocity

Gets the velocity of this particle

overload 1:
                        
Particle:getVelocity()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

Particle.getPos

Gets this particle position

overload 1:
                        
Particle:getPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

Particle.setPos

Sets this particle position
The position is given in world coordinates

overload 1:
                        
Particle:setPos(pos)  
 Method Property Fluent Description Representation
pos accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
Particle:setPos(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
pos accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

Particle.setLifetime

Sets this particle lifetime, which is how many ticks this particle should stay in the world

overload 1:
                        
Particle:setLifetime(lifetime)  
 Method Property Fluent Description Representation
lifetime accepts an Integer Integer 
   
Return Value nil nil

Method Property	Fluent Description	Representation
lifetime accepts	an Integer	`Integer`
Return Value	nil	`nil`

Particle.getPower

Gets this particle power

overload 1:
                        
Particle:getPower()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Particle.getLifetime

Gets this particle current lifetime

overload 1:
                        
Particle:getLifetime()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

Particle.setPower

Sets this particle power

overload 1:
                        
Particle:setPower(power)  
 Method Property Fluent Description Representation
power accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
power accepts	a Number	`Number`
Return Value	nil	`nil`

Particle.setVelocity

Sets the velocity of this particle
The velocity is given in world coordinates

overload 1:
                        
Particle:setVelocity(velocity)  
 Method Property Fluent Description Representation
velocity accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
Particle:setVelocity(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
velocity accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

Particle.velocity

Sets the velocity of this particle
The velocity is given in world coordinates

overload 1:
                        
Particle:velocity(velocity)  
 Method Property Fluent Description Representation
velocity accepts a Vector3 Vector3 
   
Return Value a Particle Particle 
   
overload 2:
                        
Particle:velocity(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
velocity accepts	a Vector3	`Vector3`
Return Value	a Particle	`Particle`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	a Particle	`Particle`

Particle.physics

Sets if this particle has physics

overload 1:
                        
Particle:physics(physics)  
 Method Property Fluent Description Representation
physics accepts a Boolean Boolean 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
physics accepts	a Boolean	`Boolean`
Return Value	a Particle	`Particle`

Particle.setPhysics

Sets if this particle has physics

overload 1:
                        
Particle:setPhysics(physics)  
 Method Property Fluent Description Representation
physics accepts a Boolean Boolean 
   
Return Value nil nil

Method Property	Fluent Description	Representation
physics accepts	a Boolean	`Boolean`
Return Value	nil	`nil`

Particle.setGravity

Sets this particle gravity

overload 1:
                        
Particle:setGravity(gravity)  
 Method Property Fluent Description Representation
gravity accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
gravity accepts	a Number	`Number`
Return Value	nil	`nil`

Particle.getGravity

Gets this particle gravity

overload 1:
                        
Particle:getGravity()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Particle.hasPhysics

Gets if this particle has physics

overload 1:
                        
Particle:hasPhysics()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

Particle.spawn

Spawns this particle with the current properties

overload 1:
                        
Particle:spawn()  
 Method Property Fluent Description Representation
Return Value a Particle Particle

Method Property	Fluent Description	Representation
Return Value	a Particle	`Particle`

Particle.getScale

Gets this particle scale

overload 1:
                        
Particle:getScale()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Particle.power

Sets this particle power

overload 1:
                        
Particle:power(power)  
 Method Property Fluent Description Representation
power accepts a Number Number 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
power accepts	a Number	`Number`
Return Value	a Particle	`Particle`

Particle.gravity

Sets this particle gravity

overload 1:
                        
Particle:gravity(gravity)  
 Method Property Fluent Description Representation
gravity accepts a Number Number 
   
Return Value a Particle Particle

Method Property	Fluent Description	Representation
gravity accepts	a Number	`Number`
Return Value	a Particle	`Particle`

Particle.getColor

Gets this particle color

overload 1:
                        
Particle:getColor()  
 Method Property Fluent Description Representation
Return Value a Vector4 Vector4

Method Property	Fluent Description	Representation
Return Value	a Vector4	`Vector4`

Particle.lifetime

Sets this particle lifetime, which is how many ticks this particle should stay in the world

overload 1:
                        
Particle:lifetime(lifetime)  
 Method Property Fluent Description Representation
lifetime accepts an Integer Integer 
   
Return Value a Particle Particle

Global Objects

Miscellaneous Types

Miscelanous

action_wheel

animations

nameplate

world

vanilla_model

models

player

events

keybinds

vectors

matrices

particles

sounds

pings

textures

Miscellaneous Enums