Planeshift
AdminCmdDataChangeGuildName Class Reference

Class for name changing a guild. More...

#include <adminmanager.h>

Public Member Functions

 AdminCmdDataChangeGuildName ()
 Creates obj for specified command that changes a guild name. More...
 
 AdminCmdDataChangeGuildName (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 a guildname change. More...
 
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class. More...
 
virtual ~AdminCmdDataChangeGuildName ()
 
- 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

csString guildName
 name of the guild More...
 
csString newName
 new guildname 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 name changing a guild.

Definition at line 1563 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataChangeGuildName::AdminCmdDataChangeGuildName ( )
inline

Creates obj for specified command that changes a guild name.

Definition at line 1571 of file adminmanager.h.

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

Definition at line 1584 of file adminmanager.h.

Member Function Documentation

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

Creates an object containing the parsed data for a guildname change.

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 AdminCmdDataChangeGuildName::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

csString AdminCmdDataChangeGuildName::guildName

name of the guild

Definition at line 1566 of file adminmanager.h.

csString AdminCmdDataChangeGuildName::newName

new guildname

Definition at line 1567 of file adminmanager.h.


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