Package wbs.utils.util.particles.data

Class DustOptionsProvider

java.lang.Object

org.bukkit.Particle.DustOptions

wbs.utils.util.particles.data.DustOptionsProvider

All Implemented Interfaces:

Provider, Refreshable

@Beta
public class DustOptionsProvider
extends org.bukkit.Particle.DustOptions
implements Provider

Provider that implements Particle.DustOptions for the purpose of allowing particle data to be refreshed and written to a config.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DustOptionsProvider.ColourType	Determines how the VectorProvider is treated as a colour

Constructor Summary

Constructors

Constructor	Description
DustOptionsProvider(@NotNull VectorProvider colourProvider, NumProvider sizeProvider, DustOptionsProvider.ColourType type)
DustOptionsProvider(org.bukkit.configuration.ConfigurationSection section, String path, WbsSettings settings, String directory)
DustOptionsProvider(VectorProvider colourProvider, float size, DustOptionsProvider.ColourType type)

Method Summary

Modifier and Type	Method	Description
@NotNull org.bukkit.Color	getColor()
float	getSize()
void	refresh()	Refreshes this object, whatever that means for a given implementation - typically an internal value that may be retrieved over time, but not necessarily.
void	writeToConfig(org.bukkit.configuration.ConfigurationSection section, String path)	Save this provider in a config (that can often by read by its constructor)

Methods inherited from class java.lang.Object

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

Constructor Details

DustOptionsProvider

public DustOptionsProvider(@NotNull
 @NotNull VectorProvider colourProvider,
 NumProvider sizeProvider,
 DustOptionsProvider.ColourType type)

Parameters:

colourProvider - A vector provider that represents a colour, stored in format defined by DustOptionsProvider.ColourType.

sizeProvider - A number provider to represent the size of the redstone dust, between 0 (exclusive) and 2 (inclusive).

type - The format of the colour vector.

See Also:

• DustOptionsProvider.ColourType

DustOptionsProvider

public DustOptionsProvider(VectorProvider colourProvider,
 float size,
 DustOptionsProvider.ColourType type)

Parameters:

colourProvider - A vector provider that represents a colour, stored in format defined by DustOptionsProvider.ColourType.

size - A number to represent the size of the redstone dust, between 0 (exclusive) and 2 (inclusive).

type - The format of the colour vector.

See Also:

• DustOptionsProvider.ColourType

DustOptionsProvider

public DustOptionsProvider(org.bukkit.configuration.ConfigurationSection section,
 String path,
 WbsSettings settings,
 String directory)
                    throws InvalidConfigurationException

Parameters:

section - The config to read from.

path - The path within the given config section to read from.

settings - The settings for logging purposes.

directory - The path taken so far, for logging purposes.

Throws:

InvalidConfigurationException - If the config is misconfigured in an unrecoverable way.

Method Details

getColor

@NotNull
public @NotNull org.bukkit.Color getColor()

Overrides:

getColor in class org.bukkit.Particle.DustOptions

getSize

public float getSize()

Overrides:

getSize in class org.bukkit.Particle.DustOptions

refresh

public void refresh()

Description copied from interface: Refreshable

Refreshes this object, whatever that means for a given implementation - typically an internal value that may be retrieved over time, but not necessarily.

Specified by:

refresh in interface Refreshable

writeToConfig

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

Description copied from interface: Provider

Save this provider in a config (that can often by read by its constructor)

Specified by:

writeToConfig in interface Provider

Parameters:

section - The section to write to

path - The field/path inside the given section