Package ch.njol.skript.bukkitutil

Class ParticleUtils

java.lang.Object

ch.njol.skript.bukkitutil.ParticleUtils

public class ParticleUtils
extends Object

Utility class for Particles

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	HAS_TRAIL

Method Summary

Modifier and Type	Method	Description
static String	getName(Particle particle)	Get the Minecraft name of a particle
static String	getNamesAsString()	Returns a string for docs of all names of particles
static @Nullable Particle	parse(String key)	Parse a particle by its Minecraft name
static void	spawnParticle(@NotNull Particle particle, @Nullable Player[] players, @NotNull Location location, int count, Object data, Vector offset, double extra, boolean force)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HAS_TRAIL

public static final boolean HAS_TRAIL

Method Details

getNamesAsString

public static String getNamesAsString()

Returns a string for docs of all names of particles

Returns:

Names of all particles in one long string

getName

public static String getName(Particle particle)

Get the Minecraft name of a particle

Parameters:

particle - Particle to get name of

Returns:

Minecraft name of particle

parse

@Nullable
public static @Nullable Particle parse(String key)

Parse a particle by its Minecraft name

Parameters:

key - Minecraft name of particle

Returns:

Bukkit particle from Minecraft name (null if not available)

spawnParticle

public static void spawnParticle(@NotNull
 @NotNull Particle particle,
 @Nullable
 @Nullable Player[] players,
 @NotNull
 @NotNull Location location,
 int count,
 Object data,
 Vector offset,
 double extra,
 boolean force)