Planeshift
Public Member Functions | Public Attributes

AdminCmdDataList Class Reference

Class for list command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataList ()
 Creates obj for specified command that needs a reason.
 AdminCmdDataList (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 a command data object of the current class containing the parsed data.
virtual csString GetHelpMessage ()
 Returns the Helpmessageportion for the destination according to the type.
virtual ~AdminCmdDataList ()

Public Attributes

csString subCommand
 given subcommand
AdminCmdSubCommandParser subCommandList
 List of possible sub commands.

Detailed Description

Class for list command.

Currently lists only available maps.

Definition at line 3222 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataList::AdminCmdDataList ( ) [inline]

Creates obj for specified command that needs a reason.

Definition at line 3231 of file adminmanager.h.

AdminCmdDataList::AdminCmdDataList ( 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
memessage entry
msgpsAdminCmdMessage containing the message
clientclient of the network communication
wordscommand message to parse
virtual AdminCmdDataList::~AdminCmdDataList ( ) [inline, virtual]

Definition at line 3246 of file adminmanager.h.


Member Function Documentation

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

Creates a command data object of the current class containing the parsed data.

Parameters:
msgManagermessage manager that handles this command
memessage entry
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 AdminCmdDataList::GetHelpMessage ( ) [virtual]

Returns the Helpmessageportion for the destination according to the type.

Returns:
csString containg the helpmessage part for destination

Reimplemented from AdminCmdData.


Member Data Documentation

given subcommand

Definition at line 3226 of file adminmanager.h.

List of possible sub commands.

Definition at line 3225 of file adminmanager.h.


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