Package wbs.utils.util.providers.generator.num

Class CycleGenerator

java.lang.Object

wbs.utils.util.providers.generator.num.DoubleGenerator

wbs.utils.util.providers.generator.num.CycleGenerator

All Implemented Interfaces:

Provider, Refreshable

public class CycleGenerator
extends DoubleGenerator

A generator that moves between two NumProviders in one direction over a given period, where it takes period calls to DoubleGenerator.refresh() to go form start to end

Constructor Summary

Constructors

Constructor	Description
CycleGenerator(double start, double end, double period, double initialProgress)
CycleGenerator(org.bukkit.configuration.ConfigurationSection section, WbsSettings settings, String directory)	Create this generator from a ConfigurationSection, logging errors in the given settings
CycleGenerator(CycleGenerator clone)	Clone constructor.
CycleGenerator(NumProvider start, NumProvider end, NumProvider period, double initialProgress)

Method Summary

Modifier and Type	Method	Description
CycleGenerator	clone()
protected double	getNewValue()	Generate a new value to override the current one
protected void	refreshInternal()	An internal method called before DoubleGenerator.getNewValue(), to allow implementing classes to refresh the provider in a controlled way.
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 wbs.utils.util.providers.generator.num.DoubleGenerator

getValue, refresh

Methods inherited from class java.lang.Object

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

Constructor Details

CycleGenerator

public CycleGenerator(CycleGenerator clone)

Clone constructor.

Parameters:

clone - The object to clone from.

CycleGenerator

public CycleGenerator(double start,
 double end,
 double period,
 double initialProgress)

Parameters:

start - The starting value of the cycle

end - The end value of the cycle

period - The amount of steps needed to go from start to end

initialProgress - The initial progress from 0 to 1, where 0 is start, and 1 is end.

CycleGenerator

public CycleGenerator(NumProvider start,
 NumProvider end,
 NumProvider period,
 double initialProgress)

Parameters:

start - The starting value of the cycle

end - The end value of the cycle

period - The amount of steps needed to go from start to end

initialProgress - The initial progress from 0 to 1, where 0 is start, and 1 is end.

CycleGenerator

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

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

Parameters:

section - The section where this generator 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

refreshInternal

protected void refreshInternal()

Description copied from class: DoubleGenerator

An internal method called before DoubleGenerator.getNewValue(), to allow implementing classes to refresh the provider in a controlled way.

Overrides:

refreshInternal in class DoubleGenerator

getNewValue

protected double getNewValue()

Description copied from class: DoubleGenerator

Generate a new value to override the current one

Specified by:

getNewValue in class DoubleGenerator

Returns:

The new value

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

Specified by:

writeToConfig in class DoubleGenerator

Parameters:

section - The section to write to

path - The field/path inside the given section

clone

public CycleGenerator clone()

Specified by:

clone in class DoubleGenerator