KSpigot/docs/-k-spigot/net.axay.kspigot.particles/-k-spigot-particle/index.md

title

title
KSpigotParticle -

//KSpigot/net.axay.kspigot.particles/KSpigotParticle

KSpigotParticle

[jvm] data class KSpigotParticle(particle: Particle, amount: Int, offset: Vector?, extra: Number, data: Any?, force: Boolean)

Parameters

jvm

Name	Summary
amount	The amount of particles.
data	Particle specific data, often specifying BlockData or an ItemStack.
extra	Particle specific data, often specifying an aspect like speed.
force	Determines whether the client should be encouraged to display the particles.
offset	The offset at which particles should appear.
particle	The type of Particle.

Constructors

Name	Summary
KSpigotParticle	[jvm] The type of Particle. fun KSpigotParticle(particle: Particle, amount: Int, offset: Vector?, extra: Number, data: Any?, force: Boolean)

Functions

Name	Summary
component1	[jvm] Content operator fun component1(): Particle
component2	[jvm] Content operator fun component2(): Int
component3	[jvm] Content operator fun component3(): Vector?
component4	[jvm] Content operator fun component4(): Number
component5	[jvm] Content operator fun component5(): Any?
component6	[jvm] Content operator fun component6(): Boolean
copy	[jvm] Content fun copy(particle: Particle, amount: Int, offset: Vector?, extra: Number, data: Any?, force: Boolean): KSpigotParticle
equals	[jvm] Content open operator override fun equals(other: Any?): Boolean
hashCode	[jvm] Content open override fun hashCode(): Int
spawnAt	[jvm] Brief description Spawns the particle at the location. It will be visible for everyone near it. Content fun spawnAt(loc: Location)
spawnFor	[jvm] Brief description Spawns the particle at the location of the player. It will be only visible for the player. Content fun spawnFor(player: Player)
toString	[jvm] Content open override fun toString(): String

Properties

Name	Summary
amount	[jvm] The amount of particles. var amount: Int
data	[jvm] Particle specific data, often specifying BlockData or an ItemStack. var data: Any?
extra	[jvm] Particle specific data, often specifying an aspect like speed. var extra: Number
force	[jvm] Determines whether the client should be encouraged to display the particles. var force: Boolean
offset	[jvm] The offset at which particles should appear. var offset: Vector?
particle	[jvm] The type of Particle. val particle: Particle