Planeshift
Public Member Functions

AdminCmdDataListWarnings Class Reference

Class for issuing player warnings. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataListWarnings ()
 Creates obj for specified command that issues a player warning.
 AdminCmdDataListWarnings (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 warnings.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataListWarnings ()

Detailed Description

Class for issuing player warnings.

Definition at line 2885 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataListWarnings::AdminCmdDataListWarnings ( ) [inline]

Creates obj for specified command that issues a player warning.

Definition at line 2890 of file adminmanager.h.

AdminCmdDataListWarnings::AdminCmdDataListWarnings ( 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 AdminCmdDataListWarnings::~AdminCmdDataListWarnings ( ) [inline, virtual]

Definition at line 2903 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for warnings.

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

virtual csString AdminCmdDataListWarnings::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 AdminCmdDataTarget.


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