Planeshift
AdminCmdDataRndMsgTest Class Reference

Class for sending sequenced test message. More...

#include <adminmanager.h>

Public Member Functions

 AdminCmdDataRndMsgTest ()
 Creates obj for specified command sending test message. More...
 
 AdminCmdDataRndMsgTest (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 the test message. More...
 
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class. More...
 
virtual ~AdminCmdDataRndMsgTest ()
 
- 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

bool sequential
 true is for sending messages in sequende, otherwise randomly More...
 
csString text
 msg to test send 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 sending sequenced test message.

Definition at line 3173 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataRndMsgTest::AdminCmdDataRndMsgTest ( )
inline

Creates obj for specified command sending test message.

Definition at line 3181 of file adminmanager.h.

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

Definition at line 3194 of file adminmanager.h.

Member Function Documentation

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

Creates an object the parsed data for the test message.

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

bool AdminCmdDataRndMsgTest::sequential

true is for sending messages in sequende, otherwise randomly

Definition at line 3177 of file adminmanager.h.

csString AdminCmdDataRndMsgTest::text

msg to test send

Definition at line 3176 of file adminmanager.h.


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