Planeshift
Public Member Functions | Public Attributes

AdminCmdDataTargetReason Class Reference

Class for commands that only need a target and a reason. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataTargetReason (csString command)
 Creates obj for specified command that needs a reason.
 AdminCmdDataTargetReason (csString command, AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Creates obj for specified command that needs a reason.
virtual AdminCmdDataCreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Parses the given message and stores its data.
virtual csString GetHelpMessage ()
 Retrieve help message for the command that fits to the data.
virtual ~AdminCmdDataTargetReason ()

Public Attributes

csString reason
 reason for this deletion command

Detailed Description

Class for commands that only need a target and a reason.

Definition at line 704 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataTargetReason::AdminCmdDataTargetReason ( csString  command) [inline]

Creates obj for specified command that needs a reason.

Parameters:
commandname of the command (e.g. /ban)

Definition at line 712 of file adminmanager.h.

AdminCmdDataTargetReason::AdminCmdDataTargetReason ( csString  command,
AdminManager msgManager,
MsgEntry me,
psAdminCmdMessage msg,
Client client,
WordArray words 
)

Creates obj for specified command that needs a reason.

Parameters:
commandname of the command (e.g. /ban)
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 AdminCmdDataTargetReason::~AdminCmdDataTargetReason ( ) [inline, virtual]

Definition at line 726 of file adminmanager.h.


Member Function Documentation

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

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

Reimplemented from AdminCmdDataTarget.

virtual csString AdminCmdDataTargetReason::GetHelpMessage ( ) [virtual]

Retrieve help message for the command that fits to the data.

Returns:
a help message to send back to the client

Reimplemented from AdminCmdDataTarget.


Member Data Documentation

reason for this deletion command

Definition at line 707 of file adminmanager.h.


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