AdminCmdDataInfo Class Reference

Class for commands creating items. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataInfo ()
	Creates obj for specified command that needs a reason.
	AdminCmdDataInfo (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data.
virtual AdminCmdData *	CreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates an object of the current class containing parsed data.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataInfo ()
Public Attributes
csString	subCmd
	Sub of commands.

---

Detailed Description

Class for commands creating items.

Definition at line 1203 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataInfo::AdminCmdDataInfo

(

)

[inline]

Creates obj for specified command that needs a reason.

Definition at line 1210 of file adminmanager.h.

AdminCmdDataInfo::AdminCmdDataInfo	(	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	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

virtual AdminCmdDataInfo::~AdminCmdDataInfo

(

)

[inline, virtual]

Definition at line 1223 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object of the current class containing parsed data.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
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 AdminCmdDataTarget.

virtual csString AdminCmdDataInfo::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 AdminCmdDataTarget.

---

Member Data Documentation

csString AdminCmdDataInfo::subCmd

Sub of commands.

Definition at line 1206 of file adminmanager.h.

---

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

• server/adminmanager.h