KSpigot/net.axay.kspigot.particles/KSpigotParticle

KSpigotParticle

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

Parameters

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 the particle.

Constructors

KSpigotParticle

fun KSpigotParticle(particle: Particle, amount: Int = 1, offset: Vector? = null, extra: Number = 1.0, data: Any? = null, force: Boolean = false)

The type of the particle.

Functions

component1

operator fun component1(): Particle

component2

operator fun component2(): Int

component3

operator fun component3(): Vector?

component4

operator fun component4(): Number

component5

operator fun component5(): Any?

component6

operator fun component6(): Boolean

copy

fun copy(particle: Particle, amount: Int = 1, offset: Vector? = null, extra: Number = 1.0, data: Any? = null, force: Boolean = false): KSpigotParticle

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

spawnAt

fun spawnAt(loc: Location)

Spawns the particle at the location.

spawnFor

fun spawnFor(player: Player)

Spawns the particle at the location of the player.

toString

open override fun toString(): String

Properties

amount

var amount: Int = 1

The amount of particles.

data

var data: Any? = null

Particle specific data, often specifying BlockData or an ItemStack.

extra

var extra: Number = 1.0

Particle specific data, often specifying an aspect like speed.

force

var force: Boolean = false

Determines whether the client should be encouraged to display the particles.

offset

var offset: Vector? = null

The offset at which particles should appear.

particle

val particle: Particle

The type of the particle.