AdminCmdDataItem Class Reference

Class for commands creating items. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataItem ()
	Creates obj for specified command that needs a reason.
	AdminCmdDataItem (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	~AdminCmdDataItem ()
Public Attributes
int	quality
	quality in numbers for the item
int	quantity
	quantity of the item
bool	random
	random item modifiers are added

---

Detailed Description

Class for commands creating items.

Definition at line 1244 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataItem::AdminCmdDataItem

(

)

[inline]

Creates obj for specified command that needs a reason.

Definition at line 1253 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 1266 of file adminmanager.h.

---

Member Function Documentation

virtual AdminCmdData* AdminCmdDataItem::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 AdminCmdDataItem::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

int AdminCmdDataItem::quality

quality in numbers for the item

Definition at line 1248 of file adminmanager.h.

int AdminCmdDataItem::quantity

quantity of the item

Definition at line 1249 of file adminmanager.h.

bool AdminCmdDataItem::random

random item modifiers are added

Definition at line 1247 of file adminmanager.h.

---

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

• server/adminmanager.h