Class for terminating the server. More...

Public Member Functions
	AdminCmdDataServerQuit ()
	Creates obj for specified command that ends the server. More...

	AdminCmdDataServerQuit (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 server stop. More...

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

virtual	~AdminCmdDataServerQuit ()

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
csString	reason
	reason for the shutdown More...

int	time
	time until shutdown 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 terminating the server.

Definition at line 3049 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataServerQuit::AdminCmdDataServerQuit ( )

inline

Creates obj for specified command that ends the server.

Definition at line 3057 of file adminmanager.h.

AdminCmdDataServerQuit::AdminCmdDataServerQuit	(	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 AdminCmdDataServerQuit::~AdminCmdDataServerQuit ( )

inlinevirtual

Definition at line 3070 of file adminmanager.h.

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

virtual

Creates an object containing the parsed data for server stop.

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 AdminCmdData.

virtual csString AdminCmdDataServerQuit::GetHelpMessage ( )

virtual

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

Reimplemented from AdminCmdData.

csString AdminCmdDataServerQuit::reason

reason for the shutdown

Definition at line 3052 of file adminmanager.h.

int AdminCmdDataServerQuit::time

time until shutdown

Definition at line 3053 of file adminmanager.h.

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