Package wbs.utils.util.particles

Class CustomParticleEffect

java.lang.Object

wbs.utils.util.particles.WbsParticleEffect

wbs.utils.util.particles.CustomParticleEffect

public abstract class CustomParticleEffect
extends WbsParticleEffect

An abstract particle effect to be overridden anonymously

Nested Class Summary

Nested classes/interfaces inherited from class wbs.utils.util.particles.WbsParticleEffect

WbsParticleEffect.WbsParticleType

Field Summary

Fields inherited from class wbs.utils.util.particles.WbsParticleEffect

amount, chance, force, options, pl, points, upVector

Constructor Summary

Constructors

Constructor	Description
CustomParticleEffect()

Method Summary

Modifier and Type	Method	Description
final CustomParticleEffect	build()	Generate the particle set based on current settings.
CustomParticleEffect	clone()
abstract CustomParticleEffect	play(org.bukkit.Particle particle, org.bukkit.Location loc)	Run the effect pattern at the given location with the given particle.
CustomParticleEffect	setPoints(List<org.bukkit.util.Vector> points)	Set the points to be used in play(Particle, Location)

Methods inherited from class wbs.utils.util.particles.WbsParticleEffect

buildAndPlay, buildParticleEffect, cloneInto, filterChances, getAmount, getAmountProvider, getForce, getLocations, play, rand, refreshProviders, scaleVector, setAmount, setAmount, setChance, setForce, setOptions, setPlugin, writeToConfig

Methods inherited from class java.lang.Object

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

Constructor Details

CustomParticleEffect

public CustomParticleEffect()

Method Details

setPoints

public CustomParticleEffect setPoints(List<org.bukkit.util.Vector> points)

Set the points to be used in play(Particle, Location)

Parameters:

points - The new list of points to play at

Returns:

The same particle effect

build

public final CustomParticleEffect build()

Description copied from class: WbsParticleEffect

Generate the particle set based on current settings. Call this before the first time it is run, or call buildAndRun each time to run based on current settings.

Specified by:

build in class WbsParticleEffect

Returns:

The same object.

play

public abstract CustomParticleEffect play(org.bukkit.Particle particle,
 org.bukkit.Location loc)

Description copied from class: WbsParticleEffect

Run the effect pattern at the given location with the given particle. For shapes needing two locations (such as Line), a random second location will be chosen a random number of blocks away from the given location.

Specified by:

play in class WbsParticleEffect

Parameters:

particle - The particle type to use

loc - The location at which to run the effect.

Returns:

The same object.

clone

public CustomParticleEffect clone()

Specified by:

clone in class WbsParticleEffect