org.rominos2.Seasons.api

Interface SeasonObject

public interface SeasonObject

Author:

Rominos2

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
int	getDayTime()
java.lang.Double[]	getLengths()
java.lang.String	getName()
int	getNightTime()
org.bukkit.Material	getNotificationDayMaterial()
org.bukkit.Material	getNotificationSeasonMaterial()
int	getRainToSnowPercentage()
java.lang.String	getShortName()
double	getSnowPlaceSpeed()
double	getSnowRemoveSpeed()
java.util.HashMap<java.lang.Integer,java.lang.String>	getSpecialDays()
java.lang.String	getTexture()
int[]	getWeatherPercentages()
int	hashCode()
void	setDayTime(int time) Change the Day duration of this Season.
void	setLengths(java.lang.Double[] lengths) Change the Lengths of the Season (Minecraft-Days).
void	setName(java.lang.String name) Change the Name of the Season.
void	setNightTime(int time) Change the Night duration of this Season.
void	setNotificationDayMaterial(org.bukkit.Material material) Change the Material displayed on the Notification on Special Day during the Season.
void	setNotificationSeasonMaterial(org.bukkit.Material material) Change the material displayed on the Notification on Season start.
void	setRainToSnowPercentage(int percentage) Change the Percentage of Rain replaced bu Snow.
void	setShortName(java.lang.String shortName) Change the shortName of the Season.
void	setSnowPlaceSpeed(double speed) Change the Speed of the placing on Rain/Snow Weather.
void	setSnowRemoveSpeed(double speed) Change the Speed of the removal on Sun Weather.
void	setSpecialDay(int day, java.lang.String name) Change/Put a special Day.
void	setSpecialDays(java.util.HashMap<java.lang.Integer,java.lang.String> days) Change the Special Days set.
void	setTexture(java.lang.String url) Change the URL to the Textures pack of the Season.
void	setWeatherPercentages(int[] percentages) Change the 3 Weather Percentages, please check that they make 100%.
java.lang.String	toString()

Method Detail

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

the HashCode if this Object (identifier).

equals

boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

Parameters:

object - Obect to compare

Returns:

true if it's a SeasonObject with the same name, else false.

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The Name of the Season, the one of the Plugin (Seasons) and the one of the author (Rominos2).

getName

java.lang.String getName()

Returns:

The Name of the Season.

See Also:

setName(String), getShortName(), setShortName(String)

setName

void setName(java.lang.String name)

Change the Name of the Season.

Parameters:

name - Name you want for the Season.

See Also:

getName(), getShortName(), setShortName(String)

getShortName

java.lang.String getShortName()

Returns:

The ShortName of the Season (used in the /season set command).

See Also:

setShortName(String), getName(), setName(String)

setShortName

void setShortName(java.lang.String shortName)

Change the shortName of the Season.

Parameters:

shortName - The shortName you want for the Season (used on /season set [shortName]).

See Also:

getShortName(), getName(), setName(String)

getWeatherPercentages

int[] getWeatherPercentages()

Returns:

The 3 Weather Percentages (sun, rain, thunder).

See Also:

setWeatherPercentages(int[]), getRainToSnowPercentage(), setRainToSnowPercentage(int)

setWeatherPercentages

void setWeatherPercentages(int[] percentages)

Change the 3 Weather Percentages, please check that they make 100%.

Parameters:

percentages - Percentages of Weathers {sun, rain, thunder}.

See Also:

getWeatherPercentages(), getRainToSnowPercentage(), setRainToSnowPercentage(int)

getLengths

java.lang.Double[] getLengths()

Returns:

The 2 Lengths in Minecraft-Days (Season, Weather).

See Also:

setLengths(Double[])

setLengths

void setLengths(java.lang.Double[] lengths)

Change the Lengths of the Season (Minecraft-Days).

Parameters:

lengths - Lengths of the Season {season, weather}.

See Also:

getLengths()

getSpecialDays

java.util.HashMap<java.lang.Integer,java.lang.String> getSpecialDays()

Returns:

The HashMap with the Special Days.

See Also:

setSpecialDays(HashMap), setSpecialDay(int, String)

setSpecialDays

void setSpecialDays(java.util.HashMap<java.lang.Integer,java.lang.String> days)

Change the Special Days set.

Parameters:

days - The Specials Day in a HashMap with the day number (starting at 0) and the name of the special Day.

See Also:

getSpecialDays(), setSpecialDay(int, String)

setSpecialDay

void setSpecialDay(int day,
                 java.lang.String name)

Change/Put a special Day.

Parameters:

day - The number of the day (starting at 0 for the first day of the season).

name - Name of the Special Day (example : Rominos2's Birthday).

See Also:

getSpecialDays(), setSpecialDays(HashMap)

getTexture

java.lang.String getTexture()

Returns:

The URL of the Textures Pack.

See Also:

setTexture(String)

setTexture

void setTexture(java.lang.String url)

Change the URL to the Textures pack of the Season.

Parameters:

url - The Internet URL of the zip TexturePack.

See Also:

getTexture()

getRainToSnowPercentage

int getRainToSnowPercentage()

Returns:

The Percentage of Rain replaced by Snow .

See Also:

setRainToSnowPercentage(int), getWeatherPercentages(), setWeatherPercentages(int[])

setRainToSnowPercentage

void setRainToSnowPercentage(int percentage)

Change the Percentage of Rain replaced bu Snow.

Parameters:

percentage - Percentage Chance of replacing Rain by Snow during this Season.

See Also:

getRainToSnowPercentage(), getWeatherPercentages(), setWeatherPercentages(int[])

getNotificationSeasonMaterial

org.bukkit.Material getNotificationSeasonMaterial()

Returns:

The Material displayed on the Notification on Season start.

See Also:

setNotificationSeasonMaterial(Material), getNotificationDayMaterial(), setNotificationDayMaterial(Material)

setNotificationSeasonMaterial

void setNotificationSeasonMaterial(org.bukkit.Material material)

Change the material displayed on the Notification on Season start.

Parameters:

material - Material shown on then Notification.

See Also:

getNotificationSeasonMaterial(), getNotificationDayMaterial(), setNotificationDayMaterial(Material)

getNotificationDayMaterial

org.bukkit.Material getNotificationDayMaterial()

Returns:

The Material displayed on the Notification on Special Day during the Season.

See Also:

setNotificationDayMaterial(Material), getNotificationSeasonMaterial(), setNotificationSeasonMaterial(Material)

setNotificationDayMaterial

void setNotificationDayMaterial(org.bukkit.Material material)

Change the Material displayed on the Notification on Special Day during the Season.

Parameters:

material - Material shown on then Notification.

See Also:

getNotificationDayMaterial(), getNotificationSeasonMaterial(), setNotificationSeasonMaterial(Material)

getDayTime

int getDayTime()

Returns:

The number of ticks of day during the whole Day.

See Also:

setDayTime(int), getNightTime(), setNightTime(int)

setDayTime

void setDayTime(int time)

Change the Day duration of this Season.

Parameters:

time - The number of ticks of Day Time.

See Also:

getDayTime(), getNightTime(), setNightTime(int)

getNightTime

int getNightTime()

Returns:

The number of ticks of night during the whole Day.

See Also:

setNightTime(int), getDayTime(), setDayTime(int)

setNightTime

void setNightTime(int time)

Change the Night duration of this Season.

Parameters:

time - The number of ticks of Night Time.

See Also:

getNightTime(), getDayTime(), setDayTime(int)

getSnowPlaceSpeed

double getSnowPlaceSpeed()

Returns:

The Speed of the placing on Rain/Snow Weather (number of blocks modified per chunk per second).

See Also:

setSnowPlaceSpeed(double), getSnowRemoveSpeed(), setSnowRemoveSpeed(double)

setSnowPlaceSpeed

void setSnowPlaceSpeed(double speed)

Change the Speed of the placing on Rain/Snow Weather.

Parameters:

The - Speed of the placing on Rain/Snow Weather (number of blocks modified per chunk per second).

See Also:

getSnowPlaceSpeed(), getSnowRemoveSpeed(), setSnowRemoveSpeed(double)

getSnowRemoveSpeed

double getSnowRemoveSpeed()

Returns:

The Speed of the removal on Sun Weather (number of blocks modified per chunk per second).

See Also:

setSnowRemoveSpeed(double), getSnowPlaceSpeed(), setSnowPlaceSpeed(double)

setSnowRemoveSpeed

void setSnowRemoveSpeed(double speed)

Change the Speed of the removal on Sun Weather.

Parameters:

The - Speed of the removal on Sun Weather (number of blocks modified per chunk per second).

See Also:

getSnowRemoveSpeed(), getSnowPlaceSpeed(), setSnowPlaceSpeed(double)