Base class for manipulating weather effects. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataWeatherEffect (csString command)
	Creates obj for specified command that change weather effects. More...

	AdminCmdDataWeatherEffect (csString command, 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 weather effect data. More...

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

virtual	~AdminCmdDataWeatherEffect ()

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
bool	enabled
	whether the weather effect is enabled or not More...

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

int	interval
	lenght of the weather effect More...

int	particleCount
	number of particles for the effect 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

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

inlinevirtual

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation