AdminCmdDataWeatherEffect Class Reference

Base class for manipulating weather effects. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataWeatherEffect (csString command)
	Creates obj for specified command that change weather effects.
	AdminCmdDataWeatherEffect (csString command, 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 weather effect data.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataWeatherEffect ()
Public Attributes
bool	enabled
	whether the weather effect is enabled or not
int	fadeTime
	in millisecs the time to have the particles fade
int	interval
	lenght of the weather effect
int	particleCount
	number of particles for the effect

---

Detailed Description

Base class for manipulating weather effects.

Definition at line 2003 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataWeatherEffect::AdminCmdDataWeatherEffect

(

csString

command

)

[inline]

Creates obj for specified command that change weather effects.

Parameters:

command

name of the command (e.g. /ban)

Definition at line 2014 of file adminmanager.h.

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

Parses the given message and stores its data.

Parameters:

command	name of the command (e.g. /ban)
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 AdminCmdDataWeatherEffect::~AdminCmdDataWeatherEffect

(

)

[inline, virtual]

Definition at line 2028 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed weather effect 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

Returns:

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

Reimplemented from AdminCmdDataSectorTarget.

virtual csString AdminCmdDataWeatherEffect::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 AdminCmdDataWeatherEffect::enabled

whether the weather effect is enabled or not

Definition at line 2006 of file adminmanager.h.

int AdminCmdDataWeatherEffect::fadeTime

in millisecs the time to have the particles fade

Definition at line 2009 of file adminmanager.h.

int AdminCmdDataWeatherEffect::interval

lenght of the weather effect

Definition at line 2008 of file adminmanager.h.

int AdminCmdDataWeatherEffect::particleCount

number of particles for the effect

Definition at line 2007 of file adminmanager.h.

---

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

• server/adminmanager.h