Planeshift
Public Member Functions | Public Attributes

AdminCmdDataAction Class Reference

Class for some action (guildentrance creation). More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataAction ()
 Creates obj for specified command creating a guildentrance.
 AdminCmdDataAction (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 the action.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataAction ()

Public Attributes

csString description
 description for the guild entrance
csString guildName
 guildname for create_entrance
csString subCommand
 storage for the given subcommand
AdminCmdSubCommandParser subCommandList
 possible sub commands

Detailed Description

Class for some action (guildentrance creation).

Definition at line 2376 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataAction::AdminCmdDataAction ( ) [inline]

Creates obj for specified command creating a guildentrance.

Definition at line 2386 of file adminmanager.h.

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

Definition at line 2399 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for the action.

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

virtual csString AdminCmdDataAction::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 AdminCmdDataSectorTarget.


Member Data Documentation

description for the guild entrance

Definition at line 2382 of file adminmanager.h.

guildname for create_entrance

Definition at line 2381 of file adminmanager.h.

storage for the given subcommand

Definition at line 2380 of file adminmanager.h.

possible sub commands

Definition at line 2379 of file adminmanager.h.


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