org.rominos2.Seasons.api

Interface SeasonsSettings

public interface SeasonsSettings

Author:

Rominos2

Method Summary

Methods

Modifier and Type	Method and Description
void	addSeason(SeasonObject season) Add a Season to the rotative List.
java.lang.String	getChangeMessage()
org.bukkit.ChatColor	getColor()
java.lang.Double	getResolution()
SeasonObject	getSeason(java.lang.String name)
java.lang.String	getSeasonMessage()
java.util.ArrayList<SeasonObject>	getSeasons()
java.lang.String[]	getSignLines()
java.lang.String	getSpecialDayMessage()
java.lang.String	getSpoutNotificationDayMessage()
java.lang.String	getSpoutNotificationSeasonMessage()
int	getTimeCheck()
java.lang.String	getWeatherMessage()
org.bukkit.World	getWorld()
boolean	isActive()
boolean	isDebug()
boolean	isIceRegen()
boolean	isLog()
boolean	isSnowRegen()
void	setChangeMessage(java.lang.String message) Change the Message on Season changing.
void	setColor(org.bukkit.ChatColor color) Change the Message of Seasons' Message.
void	setDebug(boolean debug) Change the logging of DEBUG Seasons' Messages in the Console.
void	setIceRegen(boolean regen) Change the natural Ice Regen on Snow Biomes.
void	setResolution(double resolution) Change the numbers' resolution in Messages.
void	setSeasonMessage(java.lang.String message) Change the Message on /season get command.
void	setSignLines(java.lang.String[] lines) Change the 3 lines on Seasons Signs.
void	setSnowRegen(boolean regen) Change the natural Snow Regen on Snow Biomes.
void	setSpecialDayMessage(java.lang.String message) Change the Message on Special Days (using ).
void	setSpoutNotificationDayMessage(java.lang.String message) Change the Message displayed on Notification on Special Days.
void	setSpoutNotificationSeasonMessage(java.lang.String message) Change the Message displayed on Notifications on Season start.
void	setWeatherMessage(java.lang.String message) Change the Message on /seaon weather command.

Method Detail

getWorld

org.bukkit.World getWorld()

Returns:

the World of these Settings.

isActive

boolean isActive()

Returns:

true if Seasons is active in the world of these Settings, else false.

isLog

boolean isLog()

Returns:

true if Seasons is logging the information in the Console (commands, changes,...), esle false.

getResolution

java.lang.Double getResolution()

Returns:

the numbers' resolution in Messages (like 0.01).

See Also:

setResolution(double)

setResolution

void setResolution(double resolution)

Change the numbers' resolution in Messages.

Parameters:

resolution - Resolution (example : 0.01).

See Also:

getResolution()

getTimeCheck

int getTimeCheck()

Returns:

the number of ticks between a Seasons' Runnable's check.

getChangeMessage

java.lang.String getChangeMessage()

Returns:

the Message on Season changing.

See Also:

setChangeMessage(String)

setChangeMessage

void setChangeMessage(java.lang.String message)

Change the Message on Season changing.

Parameters:

message - Message displayed (example : "It's now .").

See Also:

getChangeMessage()

getSeasonMessage

java.lang.String getSeasonMessage()

Returns:

the Message on /season get command.

See Also:

setSeasonMessage(String)

setSeasonMessage

void setSeasonMessage(java.lang.String message)

Change the Message on /season get command.

Parameters:

message - Message displayed (example : "It's for another days.").

See Also:

getSeasonMessage()

getWeatherMessage

java.lang.String getWeatherMessage()

Returns:

the Message displayed on /season weather command.

See Also:

setWeatherMessage(String)

setWeatherMessage

void setWeatherMessage(java.lang.String message)

Change the Message on /seaon weather command.

Parameters:

message - Message displayed (example : "The current weather is .").

See Also:

getWeatherMessage()

getSpecialDayMessage

java.lang.String getSpecialDayMessage()

Returns:

the Message on Special Days.

See Also:

setSpecialDayMessage(String)

setSpecialDayMessage

void setSpecialDayMessage(java.lang.String message)

Change the Message on Special Days (using ).

Parameters:

message - Message displayed (example : "It's .").

See Also:

getSpecialDayMessage()

getColor

org.bukkit.ChatColor getColor()

Returns:

the color of Seasons' Message

See Also:

setColor(ChatColor)

setColor

void setColor(org.bukkit.ChatColor color)

Change the Message of Seasons' Message.

Parameters:

color - Color of the Chat (example : ChatColor.AQUA).

See Also:

getColor()

isSnowRegen

boolean isSnowRegen()

Returns:

true if the Snow is naturally regening on Snow Biomes, else false.

See Also:

setSnowRegen(boolean)

setSnowRegen

void setSnowRegen(boolean regen)

Change the natural Snow Regen on Snow Biomes.

Parameters:

regen - Do you want natural Snow behavior on Snow Biomes ?

See Also:

isSnowRegen()

isIceRegen

boolean isIceRegen()

Returns:

true if the Ice is naturally regening on Snow Biomes, else false.

See Also:

setIceRegen(boolean)

setIceRegen

void setIceRegen(boolean regen)

Change the natural Ice Regen on Snow Biomes.

Parameters:

regen - Do you want natural Ice behavior on Snow Biomes ?

See Also:

isIceRegen()

isDebug

boolean isDebug()

Returns:

true if Seasons is logging DEBUG Messages in the Console, else false.

See Also:

setDebug(boolean)

setDebug

void setDebug(boolean debug)

Change the logging of DEBUG Seasons' Messages in the Console.

Parameters:

debug - Do you want Debug messages in Console ?

See Also:

isDebug()

getSeasons

java.util.ArrayList<SeasonObject> getSeasons()

Returns:

the Seasons of this world.

See Also:

getSeason(String), addSeason(SeasonObject)

getSeason

SeasonObject getSeason(java.lang.String name)

Parameters:

name - Name of the season you want.

Returns:

the Season depending on the name, null if not in the list.

See Also:

getSeasons(), addSeason(SeasonObject)

addSeason

void addSeason(SeasonObject season)

Add a Season to the rotative List.

Parameters:

season - The Season you want to add.

See Also:

getSeasons(), getSeason(String)

getSpoutNotificationSeasonMessage

java.lang.String getSpoutNotificationSeasonMessage()

Returns:

the Message displayed on Notifications on Season start.

See Also:

setSpoutNotificationSeasonMessage(String), getSpoutNotificationDayMessage(), setSpoutNotificationDayMessage(String)

setSpoutNotificationSeasonMessage

void setSpoutNotificationSeasonMessage(java.lang.String message)

Change the Message displayed on Notifications on Season start.

Parameters:

message - Message displayed in the Notification on Seasons starting (example : "New Season").

See Also:

getSpoutNotificationSeasonMessage(), getSpoutNotificationDayMessage(), setSpoutNotificationDayMessage(String)

getSpoutNotificationDayMessage

java.lang.String getSpoutNotificationDayMessage()

Returns:

the Message displayed on Notifications on Special Days.

See Also:

setSpoutNotificationDayMessage(String), getSpoutNotificationSeasonMessage(), setSpoutNotificationSeasonMessage(String)

setSpoutNotificationDayMessage

void setSpoutNotificationDayMessage(java.lang.String message)

Change the Message displayed on Notification on Special Days.

Parameters:

message - Message displayed in the Notification on Seasons starting (example : "Special Day !").

See Also:

getSpoutNotificationDayMessage(), getSpoutNotificationSeasonMessage(), setSpoutNotificationSeasonMessage(String)

getSignLines

java.lang.String[] getSignLines()

Returns:

the 3 lines on Seasons Signs.

See Also:

setSignLines(String[])

setSignLines

void setSignLines(java.lang.String[] lines)

Change the 3 lines on Seasons Signs.

Parameters:

lines - 3 Lines of the Signs (example : { ", It's " , "Day over " , "It's " }.

See Also:

getSignLines()