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 Particle.

Constructors

KSpigotParticle

The type of Particle.

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

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, offset: Vector?, extra: Number, data: Any?, force: Boolean): KSpigotParticle

equals

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

hashCode

open override fun hashCode(): Int

spawnAt

Spawns the particle at the location. It will be visible for everyone near it.

fun spawnAt(loc: Location)

spawnFor

Spawns the particle at the location of the player. It will be only visible for the player.

fun spawnFor(player: Player)

toString

open override fun toString(): String

Properties

amount

The amount of particles.

var amount: Int

data

Particle specific data, often specifying BlockData or an ItemStack.

var data: Any?

extra

Particle specific data, often specifying an aspect like speed.

var extra: Number

force

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

var force: Boolean

offset

The offset at which particles should appear.

var offset: Vector?

particle

The type of Particle.

val particle: Particle