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

figura.docs.particle.scale
overload 1:
Particle:scale(scale)
Method Property Fluent Description Representation
scale accepts a Number
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.pos

figura.docs.particle.pos
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.color

figura.docs.particle.color
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.lifetime

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

Particle.power

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

Particle.spawn

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

Particle.gravity

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

Particle.velocity

figura.docs.particle.velocity
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.getLifetime

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

Particle.physics

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