Planeshift
Public Member Functions

AdminCmdDataNPCClientQuit Class Reference

Class for terminating the server. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataNPCClientQuit ()
 Creates obj for specified command that ends the server.
 AdminCmdDataNPCClientQuit (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 server stop.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataNPCClientQuit ()

Detailed Description

Class for terminating the server.

Definition at line 3091 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataNPCClientQuit::AdminCmdDataNPCClientQuit ( ) [inline]

Creates obj for specified command that ends the server.

Definition at line 3096 of file adminmanager.h.

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

Parses the given message and stores its data.

Parameters:
msgManagermessage manager that handles this command
meThe incoming message from the GM
msgpsAdminCmdMessage containing the message
clientclient of the network communication
wordscommand message to parse
virtual AdminCmdDataNPCClientQuit::~AdminCmdDataNPCClientQuit ( ) [inline, virtual]

Definition at line 3109 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for server stop.

Parameters:
msgManagermessage manager that handles this command
meThe incoming message from the GM
msgpsAdminCmdMessage containing the message
clientclient of the network communication
wordscommand 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 AdminCmdDataNPCClientQuit::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 AdminCmdData.


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