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.isAlive

Checks if this particle is not flagged for removal
overload 1:
Particle:isAlive()
Method Property Fluent Description Representation
Return Value a Boolean

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
Return Value a Particle
overload 2:
Particle:setColor(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value a Particle
overload 3:
Particle:setColor(r, g, b, a)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
a accepts a Number
Return Value a Particle

Particle.setScale

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

Particle.getPos

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

Particle.getVelocity

Gets the velocity of this particle
overload 1:
Particle:getVelocity()
Method Property Fluent Description Representation
Return Value a 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
Return Value a Particle
overload 2:
Particle:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Particle

Particle.getScale

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

Particle.getLifetime

Gets this particle current lifetime
overload 1:
Particle:getLifetime()
Method Property Fluent Description Representation
Return Value an Integer

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
Return Value a Particle
overload 2:
Particle:setVelocity(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Particle

Particle.getGravity

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

Particle.setGravity

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

Particle.setPower

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

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
Return Value a Particle

Particle.setPhysics

Sets if this particle has physics
overload 1:
Particle:setPhysics(physics)
Method Property Fluent Description Representation
physics accepts a Boolean
Return Value a Particle

Particle.hasPhysics

Gets if this particle has physics
overload 1:
Particle:hasPhysics()
Method Property Fluent Description Representation
Return Value a Boolean

Particle.getPower

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

Particle.spawn

Spawns this particle with the current properties
overload 1:
Particle:spawn()
Method Property Fluent Description Representation
Return Value a Particle

Particle.getColor

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

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
Return Value a Particle
overload 2:
Particle:color(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value a Particle
overload 3:
Particle:color(r, g, b, a)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
a accepts a Number
Return Value a Particle

Particle.scale

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

Particle.setSize

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

Particle.size

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

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
Return Value a Particle
overload 2:
Particle:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Particle

Particle.getSize

Gets this particle scale
overload 1:
Particle:getSize()
Method Property Fluent Description Representation
Return Value a Number

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
Return Value a Particle
overload 2:
Particle:velocity(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Particle

Particle.gravity

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

Particle.power

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

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
Return Value a Particle

Particle.physics

Sets if this particle has physics
overload 1:
Particle:physics(physics)
Method Property Fluent Description Representation
physics accepts a Boolean
Return Value a Particle
a a