AdminCmdDataWeather Class Reference

Class for weather command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataWeather ()
	Creates obj for specified command that change the weather.
	AdminCmdDataWeather (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data.
virtual AdminCmdData *	CreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates an object containing the parsed data for weather control.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataWeather ()
Public Attributes
bool	enabled
	whether to enable/disable the effect
int	type
	Which weather effect we should disable or enable.

---

Detailed Description

Class for weather command.

Definition at line 1961 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataWeather::AdminCmdDataWeather

(

)

[inline]

Creates obj for specified command that change the weather.

Definition at line 1969 of file adminmanager.h.

AdminCmdDataWeather::AdminCmdDataWeather	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)

Parses the given message and stores its data.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

virtual AdminCmdDataWeather::~AdminCmdDataWeather

(

)

[inline, virtual]

Definition at line 1982 of file adminmanager.h.

---

Member Function Documentation

virtual AdminCmdData* AdminCmdDataWeather::CreateCmdData	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)		[virtual]

Creates an object containing the parsed data for weather control.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

Returns:

AdminCmdData* pointer to object containing parsed data. When parsing failed the valid flag is set to false.

Reimplemented from AdminCmdDataSectorTarget.

virtual csString AdminCmdDataWeather::GetHelpMessage

(

)

[virtual]

Returns a helpmessage that fits to the parser of the class.

Returns:

csString: a help message to send back to the client

Reimplemented from AdminCmdDataSectorTarget.

---

Member Data Documentation

bool AdminCmdDataWeather::enabled

whether to enable/disable the effect

Definition at line 1964 of file adminmanager.h.

int AdminCmdDataWeather::type

Which weather effect we should disable or enable.

Definition at line 1965 of file adminmanager.h.

---

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

• server/adminmanager.h