Planeshift
Public Member Functions | Public Attributes

AdminCmdDataSetStackable Class Reference

Class for un/setting, displaying information on stackable items. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataSetStackable ()
 Creates obj for specified command that needs a reason.
 AdminCmdDataSetStackable (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 object of the current class containing parsed data.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataSetStackable ()

Public Attributes

csString stackableAction
 subcommand storage
AdminCmdSubCommandParser subCommandList
 list of subcommands

Detailed Description

Class for un/setting, displaying information on stackable items.

Definition at line 1120 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataSetStackable::AdminCmdDataSetStackable ( ) [inline]

Creates obj for specified command that needs a reason.

Definition at line 1128 of file adminmanager.h.

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

Definition at line 1141 of file adminmanager.h.


Member Function Documentation

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

Creates a object of the current class containing parsed 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
Returns:
AdminCmdData*: pointer to object containing parsed data. When parsing failed the valid flag is set to false.

Reimplemented from AdminCmdDataTarget.

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


Member Data Documentation

subcommand storage

Definition at line 1124 of file adminmanager.h.

list of subcommands

Definition at line 1123 of file adminmanager.h.


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