Planeshift
Public Member Functions

AdminCmdDataSimple Class Reference

Simple one word commands. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataSimple (csString commandName)
 Creates obj for specified command that ends the server.
 AdminCmdDataSimple (csString commandName, AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Parses the given message and stores its data.
virtual AdminCmdDataCreateCmdData (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 ~AdminCmdDataSimple ()

Detailed Description

Simple one word commands.

Definition at line 3130 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataSimple::AdminCmdDataSimple ( csString  commandName) [inline]

Creates obj for specified command that ends the server.

Definition at line 3135 of file adminmanager.h.

AdminCmdDataSimple::AdminCmdDataSimple ( csString  commandName,
AdminManager msgManager,
MsgEntry me,
psAdminCmdMessage msg,
Client client,
WordArray words 
)

Parses the given message and stores its data.

Parameters:
commandNamename of the command
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 AdminCmdDataSimple::~AdminCmdDataSimple ( ) [inline, virtual]

Definition at line 3151 of file adminmanager.h.


Member Function Documentation

virtual AdminCmdData* AdminCmdDataSimple::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 AdminCmdDataSimple::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: