Package games.stendhal.server.core.rp

Class WeatherUpdater

java.lang.Object

games.stendhal.server.core.rp.WeatherUpdater

All Implemented Interfaces:

TurnListener

public class WeatherUpdater
extends Object
implements TurnListener

Manager for zones with changing weather.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WEATHER_KEYWORD	The keyword used by the weather adjustments parser.

Method Summary

Modifier and Type	Method	Description
static WeatherUpdater	get()	Get the WeatherUpdater instance.
Set<String>	getTypes()	Retrieves names of available weather types.
void	manageAttributes(ZoneAttributes attr, String desc)	Make a zone weather managed by the weather updater.
final void	onTurnReached(int currentTurn)	This method is called when the turn number is reached.
void	updateAndNotify(StendhalRPZone zone, Pair<String,Boolean> weather)	Update a zone's weather attribute for debugging, and notify players of the changes.

Methods inherited from class java.lang.Object

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

Field Details

WEATHER_KEYWORD

public static final String WEATHER_KEYWORD

The keyword used by the weather adjustments parser.

See Also:

• Constant Field Values

Method Details

get

public static WeatherUpdater get()

Get the WeatherUpdater instance.

Returns:

singleton instance

getTypes

public Set<String> getTypes()

Retrieves names of available weather types.

Returns:

List of weather.

manageAttributes

public void manageAttributes(ZoneAttributes attr,
 String desc)

Make a zone weather managed by the weather updater. Modifiers to the default weather can be described in form "varying(rain=value1, temperature=value2, fog=value3)", where any or all of the modifiers can be omitted, and their order does not matter. Description parameter "varying" is interpreted as "varying()", that is, no weather modifiers.
The values are interpreted so that:

• One step of rain corresponds to adding about 5% to rain probability
• One step of temperature corresponds roughly to one month of time difference (compared to coldest month).
• One step of fog corresponds to adding about 5% to fog probability

Negative values are interpreted as corresponding decreases. Note that rain and especially fog have low probabilities to begin with, so they get easily turned off completely.
If a modifier is specified more than once, the last one takes effect.

Parameters:

attr - Attributes of the zone

desc - The weather attribute value specified for the zone. This is used to determine any zone specific modifiers

onTurnReached

public final void onTurnReached(int currentTurn)

Description copied from interface: TurnListener

This method is called when the turn number is reached.

Specified by:

onTurnReached in interface TurnListener

Parameters:

currentTurn - current turn number

updateAndNotify

public void updateAndNotify(StendhalRPZone zone,
 Pair<String,Boolean> weather)

Update a zone's weather attribute for debugging, and notify players of the changes.

Parameters:

zone - Zone where weather is being updated.

weather - Weather description.