Planeshift
AdminCmdDataReload Class Reference

Class for reloading item stats. More...

#include <adminmanager.h>

Public Member Functions

 AdminCmdDataReload ()
 Creates obj for specified command that reloads item stats. More...
 
 AdminCmdDataReload (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Parses the given message and stores its data. More...
 
virtual AdminCmdDataCreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Creates an object containing the parsed data for item reloading. More...
 
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class. More...
 
virtual ~AdminCmdDataReload ()
 
- Public Member Functions inherited from AdminCmdData
 AdminCmdData (csString commandName)
 creates data object for the specified command. More...
 
 AdminCmdData (csString commandName, WordArray &words)
 Parses the given message and stores its data. More...
 
virtual bool IsQuietInvalid ()
 Used for overriding. More...
 
virtual bool LogGMCommand (Client *gmClient, const char *cmd)
 Logs the game master command. More...
 
void ParseError (MsgEntry *me, const char *errmsg)
 Sends the error message to the gm and invalidates the object. More...
 
virtual ~AdminCmdData ()
 

Public Attributes

int itemID
 item id More...
 
csString subCmd
 sub command More...
 
AdminCmdSubCommandParser subCommandList
 list of subcommands More...
 
- Public Attributes inherited from AdminCmdData
csString command
 command name this obj contains data for More...
 
bool help
 flag for displaying help (true for displaying help) More...
 
bool valid
 flag for setting content valid/invalid More...
 

Additional Inherited Members

- Protected Member Functions inherited from AdminCmdData
bool IsHelp (const csString &word)
 Test for help word and store help state when found. More...
 
bool LogGMCommand (Client *gmClient, PID playerID, const char *cmd)
 logs the game master command and target to the database. More...
 

Detailed Description

Class for reloading item stats.

Definition at line 2842 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataReload::AdminCmdDataReload ( )
inline

Creates obj for specified command that reloads item stats.

Definition at line 2851 of file adminmanager.h.

AdminCmdDataReload::AdminCmdDataReload ( 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 AdminCmdDataReload::~AdminCmdDataReload ( )
inlinevirtual

Definition at line 2864 of file adminmanager.h.

Member Function Documentation

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

Creates an object containing the parsed data for item reloading.

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

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

Member Data Documentation

int AdminCmdDataReload::itemID

item id

Definition at line 2846 of file adminmanager.h.

csString AdminCmdDataReload::subCmd

sub command

Definition at line 2845 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataReload::subCommandList

list of subcommands

Definition at line 2847 of file adminmanager.h.


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