psWeatherMessage Class Reference

Sends messages to the client indicating rain and time of day. More...

#include <messages.h>

List of all members.

Classes
struct	NetWeatherInfo
Public Types
enum	playerMode { DAYNIGHT = 1, WEATHER = 2 }
enum	Weather { RAIN = 4, SNOW = 8, FOG = 16, LIGHTNING = 32 }
Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psWeatherMessage (uint32_t client, psWeatherMessage::NetWeatherInfo info, uint clientnum=0)
	psWeatherMessage (uint32_t client, int minute, int hour, int day, int month, int year)
	psWeatherMessage (MsgEntry *message)
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string.
Public Attributes
uint	day
uint	hour
uint	minute
	For Day/Night events.
uint	month
int	type
	Holds the options that the window should display.
NetWeatherInfo	weather
uint	year

---

Detailed Description

Sends messages to the client indicating rain and time of day.

Definition at line 1595 of file messages.h.

---

Member Enumeration Documentation

enum psWeatherMessage::playerMode

Enumerator:

DAYNIGHT
WEATHER

Definition at line 1598 of file messages.h.

enum psWeatherMessage::Weather

Enumerator:

RAIN
SNOW
FOG
LIGHTNING

Definition at line 1604 of file messages.h.

---

Constructor & Destructor Documentation

psWeatherMessage::psWeatherMessage	(	uint32_t	client,
		psWeatherMessage::NetWeatherInfo	info,
		uint	clientnum = 0
	)

psWeatherMessage::psWeatherMessage	(	uint32_t	client,
		int	minute,
		int	hour,
		int	day,
		int	month,
		int	year
	)

psWeatherMessage::psWeatherMessage

(

MsgEntry *

message

)

---

Member Function Documentation

psWeatherMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psWeatherMessage::ToString

(

NetBase::AccessPointers *

accessPointers

)

[virtual]

Converts the message into human readable string.

Parameters:

accessPointers

A struct to a number of access pointers.

Returns:

Return a human readable string for the message.

Implements psMessageCracker.

---

Member Data Documentation

uint psWeatherMessage::day

Definition at line 1647 of file messages.h.

uint psWeatherMessage::hour

Definition at line 1646 of file messages.h.

uint psWeatherMessage::minute

For Day/Night events.

Definition at line 1645 of file messages.h.

uint psWeatherMessage::month

Definition at line 1648 of file messages.h.

int psWeatherMessage::type

Holds the options that the window should display.

Definition at line 1642 of file messages.h.

NetWeatherInfo psWeatherMessage::weather

Definition at line 1651 of file messages.h.

uint psWeatherMessage::year

Definition at line 1649 of file messages.h.

---

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

• common/net/messages.h