Package wbs.utils.util.particles

Class CircleParticleEffect

java.lang.Object

wbs.utils.util.particles.WbsParticleEffect

wbs.utils.util.particles.VelocityParticleEffect

wbs.utils.util.particles.CircleParticleEffect

Direct Known Subclasses:

DiscParticleEffect, RingParticleEffect, SphereParticleEffect, SpiralParticleEffect

public abstract class CircleParticleEffect
extends VelocityParticleEffect

A particle effect that has a radius, rotation, and axis of rotation

Nested Class Summary

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

WbsParticleEffect.WbsParticleType

Field Summary

Fields

Modifier and Type	Field	Description
protected VectorProvider	about
protected NumProvider	radius
protected NumProvider	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

Modifier	Constructor	Description
	CircleParticleEffect()
protected	CircleParticleEffect(org.bukkit.configuration.ConfigurationSection section, WbsSettings settings, String directory)

Method Summary

Modifier and Type	Method	Description
protected CircleParticleEffect	cloneInto(CircleParticleEffect cloned)
org.bukkit.util.Vector	getAbout()
VectorProvider	getAboutProvider()
double	getRadius()
NumProvider	getRadiusProvider()
double	getRotation()
NumProvider	getRotationProvider()
protected void	refreshProviders()	Refresh all providers for this object.
CircleParticleEffect	setAbout(org.bukkit.util.Vector about)	Sets the vector about which rotation occurs
CircleParticleEffect	setAbout(VectorProvider about)	Sets the about vector provider directly
CircleParticleEffect	setRadius(double radius)
CircleParticleEffect	setRadius(NumProvider radius)
CircleParticleEffect	setRotation(double rotation)
CircleParticleEffect	setRotation(NumProvider rotation)	Set the rotation as a provider directly
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.VelocityParticleEffect

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

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

build, buildAndPlay, buildParticleEffect, clone, 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

Field Details

about

protected VectorProvider about

radius

protected NumProvider radius

rotation

protected NumProvider rotation

Constructor Details

CircleParticleEffect

public CircleParticleEffect()

CircleParticleEffect

protected CircleParticleEffect(org.bukkit.configuration.ConfigurationSection section,
 WbsSettings settings,
 String directory)

Method Details

refreshProviders

protected void refreshProviders()

Description copied from class: WbsParticleEffect

Refresh all providers for this object. Subclasses may override this, but should call super.refreshProviders() at the start of the method

Overrides:

refreshProviders in class VelocityParticleEffect

cloneInto

protected CircleParticleEffect cloneInto(CircleParticleEffect cloned)

getRadius

public double getRadius()

getRadiusProvider

public NumProvider getRadiusProvider()

setRadius

public CircleParticleEffect setRadius(double radius)

setRadius

public CircleParticleEffect setRadius(NumProvider radius)

getAbout

public org.bukkit.util.Vector getAbout()

Returns:

The vector about which rotation occurs

getAboutProvider

public VectorProvider getAboutProvider()

setAbout

public CircleParticleEffect setAbout(org.bukkit.util.Vector about)

Sets the vector about which rotation occurs

Parameters:

about - The about vector

Returns:

The same particle effect

setAbout

public CircleParticleEffect setAbout(VectorProvider about)

Sets the about vector provider directly

Parameters:

about - The about vector provider

Returns:

The same particle effect

getRotation

public double getRotation()

Returns:

The rotation in degrees

getRotationProvider

public NumProvider getRotationProvider()

setRotation

public CircleParticleEffect setRotation(double rotation)

Parameters:

rotation - The rotation in degrees

Returns:

The same particle effect

setRotation

public CircleParticleEffect setRotation(NumProvider rotation)

Set the rotation as a provider directly

Parameters:

rotation - The new rotation NumProvider

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 VelocityParticleEffect

Parameters:

section - The section to write to

path - The field/path inside the given section