From d950cafe2a9d935c61264e0ca6d947529a03fbf4 Mon Sep 17 00:00:00 2001 From: bluefireoly Date: Mon, 28 Sep 2020 19:11:39 +0200 Subject: [PATCH] Documentation for KSpigotParticle --- .../kotlin/net/axay/kspigot/particles/KSpigotParticles.kt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/main/kotlin/net/axay/kspigot/particles/KSpigotParticles.kt b/src/main/kotlin/net/axay/kspigot/particles/KSpigotParticles.kt index 7f76dbe2..d427d974 100644 --- a/src/main/kotlin/net/axay/kspigot/particles/KSpigotParticles.kt +++ b/src/main/kotlin/net/axay/kspigot/particles/KSpigotParticles.kt @@ -6,6 +6,14 @@ import org.bukkit.Particle import org.bukkit.entity.Player import org.bukkit.util.Vector +/** + * @param particle The type of [Particle]. + * @param amount The amount of particles. + * @param offset The offset at which particles should appear. + * @param extra Particle specific data, often specifying an aspect like speed. + * @param data Particle specific data, often specifying BlockData or an ItemStack. + * @param force Determines whether the client should be encouraged to display the particles. + */ data class KSpigotParticle( val particle: Particle, var amount: Int = 1,