Class for fog command. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataFog ()
	Creates obj for specified command that control fog. More...

	AdminCmdDataFog (AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data. More...

virtual AdminCmdData *	CreateCmdData (AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates an object containing the parsed data for fog. More...

virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class. More...

virtual	~AdminCmdDataFog ()

Public Member Functions inherited from AdminCmdDataSectorTarget
	AdminCmdDataSectorTarget (csString command)
	Creates obj for specified command that target a sector. More...

	AdminCmdDataSectorTarget (csString command, AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data. More...

virtual bool	GetSectorOfClient (Client *client)
	Retrieves the current sector of the command issuing client. More...

virtual bool	ParseTarget (AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, csString target)
	Tries to parse the supplied string as a destination. More...

virtual	~AdminCmdDataSectorTarget ()

Public Member Functions inherited from AdminCmdData
	AdminCmdData (csString commandName)
	creates data object for the specified command. More...

	AdminCmdData (csString commandName, WordArray &words)
	Parses the given message and stores its data. More...

virtual bool	IsQuietInvalid ()
	Used for overriding. More...

virtual bool	LogGMCommand (Client gmClient, const char cmd)
	Logs the game master command. More...

void	ParseError (MsgEntry me, const char errmsg)
	Sends the error message to the gm and invalidates the object. More...

virtual	~AdminCmdData ()

Public Attributes
int	b
	fog color, blue component More...

int	density
	density of the fog More...

bool	enabled
	whether the weather effect is enabled or not More...

int	fadeTime
	in millisecs the time to have the particles fade More...

int	g
	fog color, green component More...

int	interval
	lenght of the weather effect More...

int	r
	fog color, red component More...

Public Attributes inherited from AdminCmdDataSectorTarget
bool	isClientSector
	true when sector of client is stored More...

psSectorInfo *	sectorInfo
	sector either found by sectorname or client position More...

csString	sectorName
	name of the sector (when parsed successfully) More...

Public Attributes inherited from AdminCmdData
csString	command
	command name this obj contains data for More...

bool	help
	flag for displaying help (true for displaying help) More...

bool	valid
	flag for setting content valid/invalid More...

Additional Inherited Members
Protected Member Functions inherited from AdminCmdData
bool	IsHelp (const csString &word)
	Test for help word and store help state when found. More...

bool	LogGMCommand (Client gmClient, PID playerID, const char cmd)
	logs the game master command and target to the database. More...

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 ( )

inlinevirtual

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation