listFiles
action_wheel
Action
BlockRaycastTypes Represents a particle that can be spawned and modified
Obtained by indexing the ParticleAPI
Exists as an object-oriented alternative to particles:addParticle() 
Sets this particle color
Accepts and alpha value, but most particles do not support it
Default RGBA of 1
overload 1:
Particle.color(rgb: Vector3): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.1253495462
overload 2:
Particle.color(rgba: Vector4): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.1253495462
overload 3:
Particle.color(r: Number, g: Number, b: Number, a: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.1253495462
Gets this particle color
overload 1:
Particle.getColor(): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444081
Gets this particle gravity
overload 1:
Particle.getGravity(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets this particle current lifetime
overload 1:
Particle.getLifetime(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Gets this particle position
overload 1:
Particle.getPos(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Gets this particle power
overload 1:
Particle.getPower(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets this particle scale
overload 1:
Particle.getScale(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets this particle scale
overload 1:
Particle.getSize(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets the velocity of this particle
overload 1:
Particle.getVelocity(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Sets this particle gravity
overload 1:
Particle.gravity(gravity: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| gravity accepts | typings.-1950496919||
| Return Value | typings.1253495462
Gets if this particle has physics
overload 1:
Particle.hasPhysics(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if this particle is not flagged for removal
overload 1:
Particle.isAlive(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Sets this particle lifetime, which is how many ticks this particle should stay in the world
overload 1:
Particle.lifetime(lifetime: Integer): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| lifetime accepts | typings.-672261858||
| Return Value | typings.1253495462
Sets if this particle has physics
overload 1:
Particle.physics(physics: Boolean): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| physics accepts | typings.1729365000||
| Return Value | typings.1253495462
Sets this particle position
The position is given in world coordinates
overload 1:
Particle.pos(pos: Vector3): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.1253495462
overload 2:
Particle.pos(x: Number, y: Number, z: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle power
overload 1:
Particle.power(power: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| power accepts | typings.-1950496919||
| Return Value | typings.1253495462
Removes this particle from the world
overload 1:
Particle.remove(): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1253495462
Sets this particle scale
overload 1:
Particle.scale(scale: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle color
Accepts and alpha value, but most particles do not support it
Default RGBA of 1
overload 1:
Particle.setColor(rgb: Vector3): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.1253495462
overload 2:
Particle.setColor(rgba: Vector4): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.1253495462
overload 3:
Particle.setColor(r: Number, g: Number, b: Number, a: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle gravity
overload 1:
Particle.setGravity(gravity: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| gravity accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle lifetime, which is how many ticks this particle should stay in the world
overload 1:
Particle.setLifetime(lifetime: Integer): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| lifetime accepts | typings.-672261858||
| Return Value | typings.1253495462
Sets if this particle has physics
overload 1:
Particle.setPhysics(physics: Boolean): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| physics accepts | typings.1729365000||
| Return Value | typings.1253495462
Sets this particle position
The position is given in world coordinates
overload 1:
Particle.setPos(pos: Vector3): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.1253495462
overload 2:
Particle.setPos(x: Number, y: Number, z: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle power
overload 1:
Particle.setPower(power: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| power accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle scale
overload 1:
Particle.setScale(scale: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle scale
overload 1:
Particle.setSize(scale: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets the velocity of this particle
The velocity is given in world coordinates
overload 1:
Particle.setVelocity(velocity: Vector3): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| velocity accepts | typings.2002444080||
| Return Value | typings.1253495462
overload 2:
Particle.setVelocity(x: Number, y: Number, z: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1253495462
Sets this particle scale
overload 1:
Particle.size(scale: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.-1950496919||
| Return Value | typings.1253495462
Spawns this particle with the current properties
overload 1:
Particle.spawn(): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1253495462
Sets the velocity of this particle
The velocity is given in world coordinates
overload 1:
Particle.velocity(velocity: Vector3): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| velocity accepts | typings.2002444080||
| Return Value | typings.1253495462
overload 2:
Particle.velocity(x: Number, y: Number, z: Number): Particle | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1253495462