Package wbs.utils.util.particles

Class DiscParticleEffect

java.lang.Object

wbs.utils.util.particles.WbsParticleEffect

wbs.utils.util.particles.VelocityParticleEffect

wbs.utils.util.particles.CircleParticleEffect

wbs.utils.util.particles.DiscParticleEffect

public class DiscParticleEffect
extends CircleParticleEffect

A particle effect that appears in a disc

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

Modifier	Constructor	Description
	DiscParticleEffect()	Create this effect with default values.
protected	DiscParticleEffect(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
DiscParticleEffect	build()	Generate the particle set based on current settings.
DiscParticleEffect	clone()
boolean	getRandom()
DiscParticleEffect	setRandom(boolean random)
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, 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

DiscParticleEffect

public DiscParticleEffect()

Create this effect with default values.

DiscParticleEffect

protected DiscParticleEffect(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 DiscParticleEffect clone()

Specified by:

clone in class WbsParticleEffect

build

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

getRandom

public boolean getRandom()

Returns:

Whether or not to randomly distribute points on the disc

setRandom

public DiscParticleEffect setRandom(boolean random)

Parameters:

random - Whether or not to randomly distribute points on the disc

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