Planeshift
AdminCmdDataDisableQuest Class Reference

Class for disabling/enabling a quest. More...

#include <adminmanager.h>

Public Member Functions

 AdminCmdDataDisableQuest ()
 Creates obj for specified command for quest dis-/en-abling. More...
 
 AdminCmdDataDisableQuest (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 the parsed data for quest dis-/en-abling. More...
 
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class. More...
 
virtual ~AdminCmdDataDisableQuest ()
 
- 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 questName
 quest to disable More...
 
bool saveToDb
 whether to save this to the db or not 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 disabling/enabling a quest.

Definition at line 2924 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataDisableQuest::AdminCmdDataDisableQuest ( )
inline

Creates obj for specified command for quest dis-/en-abling.

Definition at line 2932 of file adminmanager.h.

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

Definition at line 2945 of file adminmanager.h.

Member Function Documentation

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

Creates an object the parsed data for quest dis-/en-abling.

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 AdminCmdDataDisableQuest::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 AdminCmdDataDisableQuest::questName

quest to disable

Definition at line 2927 of file adminmanager.h.

bool AdminCmdDataDisableQuest::saveToDb

whether to save this to the db or not

Definition at line 2928 of file adminmanager.h.


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