The WeatherMgr takes care of rain/snow and other goodies inside all the regions. More...

Public Member Functions
void	StartStorm ()
	This method forces the weather for this region to start with a random intensity, no matter if it is already active or not.
void	RestartStorm ()
	Restarts the storm with the current storm parameters.
void	StartStorm (uint x, uint duration, ushort speed, ushort fog, ushort intensity)
void	StopStorm ()
	This method forces the weather for this region to stop if it is running.
Static Public Member Functions
static WeatherMgr	GetWeatherForRegion (ushort regionID)
	Gets a specific weather manager for a region.
static void	UpdatePlayerWeather (GamePlayer player)
	This method will be called from the PlayerInitRequestHandler.
static void	SendWeather (WeatherMgr mgr, GamePlayer player)
static bool	Load ()
	Initializes all weather manager instances for the regions.
static void	AddRegion (ushort regionID)
	Adds and starts a weather timer for this region.
static void	RemoveRegion (ushort regionID)
	Stops and removes the weather timer for this region.
static void	Unload ()
	Stops all weather managers.
Properties
bool	IsActive `[get]`
	Gets if the weather manager currently is active.
uint	CurrentWeatherLine `[get]`
	Gets the weather line based on the time passed since the weather started.
uint	StartX `[get, set]`
uint	Width `[get, set]`
ushort	FogDiffusion `[get, set]`
ushort	Speed `[get, set]`
ushort	Intensity `[get, set]`

Detailed Description

The WeatherMgr takes care of rain/snow and other goodies inside all the regions.

Member Function Documentation

static void DOL.GS.WeatherMgr.AddRegion ( ushort regionID ) [static]

Adds and starts a weather timer for this region.

Parameters:

regionID

static WeatherMgr DOL.GS.WeatherMgr.GetWeatherForRegion ( ushort regionID ) [static]

Gets a specific weather manager for a region.

Parameters:

regionID The region to retrieve the weather manager for

static bool DOL.GS.WeatherMgr.Load ( ) [static]

Initializes all weather manager instances for the regions.

static void DOL.GS.WeatherMgr.RemoveRegion ( ushort regionID ) [static]

Stops and removes the weather timer for this region.

void DOL.GS.WeatherMgr.RestartStorm ( )

Restarts the storm with the current storm parameters.

void DOL.GS.WeatherMgr.StartStorm ( )

This method forces the weather for this region to start with a random intensity, no matter if it is already active or not.

void DOL.GS.WeatherMgr.StartStorm	(	uint	x,
		uint	duration,
		ushort	speed,
		ushort	fog,
		ushort	intensity
	)

Starts the storm in the region

Parameters:

void DOL.GS.WeatherMgr.StopStorm ( )

This method forces the weather for this region to stop if it is running.

static void DOL.GS.WeatherMgr.Unload ( ) [static]

Stops all weather managers.

static void DOL.GS.WeatherMgr.UpdatePlayerWeather ( GamePlayer player ) [static]

This method will be called from the PlayerInitRequestHandler.

Parameters:

player The player entering the region

uint DOL.GS.WeatherMgr.CurrentWeatherLine [get]

Gets the weather line based on the time passed since the weather started.

bool DOL.GS.WeatherMgr.IsActive [get]

Gets if the weather manager currently is active.

The documentation for this class was generated from the following file: