AdminCmdDataFog Class Reference

Class for fog command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataFog ()
	Creates obj for specified command that control fog.
	AdminCmdDataFog (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 fog.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataFog ()
Public Attributes
int	b
	fog color, blue component
int	density
	density of the fog
bool	enabled
	whether the weather effect is enabled or not
int	fadeTime
	in millisecs the time to have the particles fade
int	g
	fog color, green component
int	interval
	lenght of the weather effect
int	r
	fog color, red component

---

Detailed Description

Class for fog command.

Definition at line 2049 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataFog::AdminCmdDataFog

(

)

[inline]

Creates obj for specified command that control fog.

Definition at line 2062 of file adminmanager.h.

AdminCmdDataFog::AdminCmdDataFog	(	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 AdminCmdDataFog::~AdminCmdDataFog

(

)

[inline, virtual]

Definition at line 2075 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data for fog.

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 AdminCmdDataFog::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

int AdminCmdDataFog::b

fog color, blue component

Definition at line 2058 of file adminmanager.h.

int AdminCmdDataFog::density

density of the fog

Definition at line 2053 of file adminmanager.h.

bool AdminCmdDataFog::enabled

whether the weather effect is enabled or not

Definition at line 2052 of file adminmanager.h.

int AdminCmdDataFog::fadeTime

in millisecs the time to have the particles fade

Definition at line 2054 of file adminmanager.h.

int AdminCmdDataFog::g

fog color, green component

Definition at line 2057 of file adminmanager.h.

int AdminCmdDataFog::interval

lenght of the weather effect

Definition at line 2055 of file adminmanager.h.

int AdminCmdDataFog::r

fog color, red component

Definition at line 2056 of file adminmanager.h.

---

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

• server/adminmanager.h