AdminCmdDataList Class Reference

Class for list command. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataList ()
	Creates obj for specified command that needs a reason. More...
	AdminCmdDataList (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data. More...
virtual AdminCmdData *	CreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates a command data object of the current class containing the parsed data. More...
virtual csString	GetHelpMessage ()
	Returns the Helpmessageportion for the destination according to the type. More...
virtual	~AdminCmdDataList ()
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	subCommand
	given subcommand More...
AdminCmdSubCommandParser	subCommandList
	List of possible sub commands. 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 list command.

Currently lists only available maps.

Definition at line 3222 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataList::AdminCmdDataList ( )

inline

Creates obj for specified command that needs a reason.

Definition at line 3231 of file adminmanager.h.

AdminCmdDataList::AdminCmdDataList	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)

Parses the given message and stores its data.

Parameters

msgManager	message manager that handles this command
me	message entry
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

virtual AdminCmdDataList::~AdminCmdDataList ( )

inlinevirtual

Definition at line 3246 of file adminmanager.h.

Member Function Documentation

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

virtual

Creates a command data object of the current class containing the parsed data.

Parameters

msgManager	message manager that handles this command
me	message entry
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command 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 AdminCmdDataList::GetHelpMessage ( )

virtual

Returns the Helpmessageportion for the destination according to the type.

Returns

csString containg the helpmessage part for destination

Reimplemented from AdminCmdData.

Member Data Documentation

csString AdminCmdDataList::subCommand

given subcommand

Definition at line 3226 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataList::subCommandList

List of possible sub commands.

Definition at line 3225 of file adminmanager.h.

---

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

• server/adminmanager.h