Package wbs.utils.util.particles

Class SpiralParticleEffect

java.lang.Object

wbs.utils.util.particles.WbsParticleEffect

wbs.utils.util.particles.VelocityParticleEffect

wbs.utils.util.particles.CircleParticleEffect

wbs.utils.util.particles.SpiralParticleEffect

public class SpiralParticleEffect
extends CircleParticleEffect

A particle effect that draws a ring but specifically controls speed to move outwards to draw a spiral

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

about, radius, rotation

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

direction, relative, speed, variation

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

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

Constructor Summary

Constructors

Constructor	Description
SpiralParticleEffect()
SpiralParticleEffect(org.bukkit.configuration.ConfigurationSection section, WbsSettings settings, String directory)	Create this effect from a ConfigurationSection, logging errors in the given settings

Method Summary

Modifier and Type	Method	Description
SpiralParticleEffect	build()	Generate the particle set based on current settings.
SpiralParticleEffect	clone()
boolean	getClockwise()
SpiralParticleEffect	play(org.bukkit.Particle particle, org.bukkit.Location loc)	Run the effect pattern at the given location with the given particle.
SpiralParticleEffect	setClockwise(boolean clockwise)
void	writeToConfig(org.bukkit.configuration.ConfigurationSection section, String path)	Save this effect in a config that can be read by WbsParticleEffect.buildParticleEffect(ConfigurationSection, WbsSettings, String)

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

cloneInto, getAbout, getAboutProvider, getRadius, getRadiusProvider, getRotation, getRotationProvider, refreshProviders, setAbout, setAbout, setRadius, setRadius, setRotation, setRotation

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

cloneInto, getDirection, getDirectionProvider, getRelative, getSpeed, getSpeedProvider, getVariation, getVariationProvider, play, setDirection, setDirection, setRelative, setSpeed, setSpeed, setVariation, setVariation

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SpiralParticleEffect

public SpiralParticleEffect()

SpiralParticleEffect

public SpiralParticleEffect(org.bukkit.configuration.ConfigurationSection section,
 WbsSettings settings,
 String directory)

Create this effect from a ConfigurationSection, logging errors in the given settings

Parameters:

section - The section where this effect is defined

settings - The settings to log errors against

directory - The path taken through the config to get to this point, for logging purposes

Method Details

clone

public SpiralParticleEffect clone()

Specified by:

clone in class WbsParticleEffect

build

public SpiralParticleEffect 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 SpiralParticleEffect 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.

Overrides:

play in class VelocityParticleEffect

Parameters:

particle - The particle type to use

loc - The location at which to run the effect.

Returns:

The same object.

getClockwise

public boolean getClockwise()

Returns:

Whether or not to draw clockwise

setClockwise

public SpiralParticleEffect setClockwise(boolean clockwise)

Parameters:

clockwise - Whether or not to draw clockwise

Returns:

The same particle effect

writeToConfig

public void writeToConfig(org.bukkit.configuration.ConfigurationSection section,
 String path)

Description copied from class: WbsParticleEffect

Save this effect in a config that can be read by WbsParticleEffect.buildParticleEffect(ConfigurationSection, WbsSettings, String)

Overrides:

writeToConfig in class CircleParticleEffect

Parameters:

section - The section to write to

path - The field/path inside the given section