AdminCmdDataSetItem Class Reference

Class for setting item names and descriptions. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataSetItem ()
	Creates obj for specified command changing item name/description.
	AdminCmdDataSetItem (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 containing the parsed data for item naming.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataSetItem ()
Public Attributes
csString	description
	description for the item
csString	name
	name for the item

---

Detailed Description

Class for setting item names and descriptions.

Definition at line 2800 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataSetItem::AdminCmdDataSetItem

(

)

[inline]

Creates obj for specified command changing item name/description.

Definition at line 2808 of file adminmanager.h.

AdminCmdDataSetItem::AdminCmdDataSetItem	(	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 AdminCmdDataSetItem::~AdminCmdDataSetItem

(

)

[inline, virtual]

Definition at line 2821 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data for item naming.

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 AdminCmdDataSetItem::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 AdminCmdDataSetItem::description

description for the item

Definition at line 2804 of file adminmanager.h.

csString AdminCmdDataSetItem::name

name for the item

Definition at line 2803 of file adminmanager.h.

---

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

• server/adminmanager.h