Show everything

Miscellaneous Types

math
Action Page
Animation
EntityNameplateCustomization NameplateCustomization NameplateCustomizationGroup
Biome BlockState ItemStack
VanillaModelGroup VanillaModelPart VanillaPart
BlockTask ItemTask RenderTask SpriteTask TextTask Vertex
LivingEntityAPI ViewerAPI
Event
Keybind
Vector2 Vector3 Vector4
Matrix2 Matrix3 Matrix4
Particle
Sound
PingFunction
Texture TextureAtlas
Made by applejuice

ParticleAPI
A global API which is used for dealing with Minecraft's particles
Particles instances are created when indexing their id
Accessed using the name "particles"

ParticleAPI.isPresent
Checks if this particle id is registered
overload 1:
particles:isPresent(id)
Method Property Fluent Description Representation
id accepts a String
Return Value a Boolean

ParticleAPI.removeParticles
Removes all particles spawned from this avatar
overload 1:
particles:removeParticles()
Method Property Fluent Description Representation
Return Value a ParticleAPI

ParticleAPI.newParticle
Creates a particle with the given name at the specified position, with the given velocity
Some particles have special properties, like the "dust" particle
For these particles, the special properties can be put into the "name" parameter, the same way as it works for commands
overload 1:
particles:newParticle(name, pos)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
Return Value a Particle
overload 2:
particles:newParticle(name, pos, vel)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
vel accepts a Vector3
Return Value a Particle
overload 3:
particles:newParticle(name, posX, posY, posZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value a Particle
overload 4:
particles:newParticle(name, pos, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value a Particle
overload 5:
particles:newParticle(name, posX, posY, posZ, vel)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
vel accepts a Vector3
Return Value a Particle
overload 6:
particles:newParticle(name, posX, posY, posZ, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value a Particle
a a