AdminCmdDataItemTarget Class Reference

Class for transfering items. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataItemTarget (csString command)
	Creates obj for specified command that transfers items.
	AdminCmdDataItemTarget (csString command, 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 transfer.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataItemTarget ()
Public Attributes
csString	itemName
	name of the item to transfer
int	stackCount
	amount to transfer

---

Detailed Description

Class for transfering items.

Definition at line 1816 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataItemTarget::AdminCmdDataItemTarget

(

csString

command

)

[inline]

Creates obj for specified command that transfers items.

Parameters:

command

name of the command (e.g. /ban)

Definition at line 1825 of file adminmanager.h.

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

Parses the given message and stores its data.

Parameters:

command	name of the command (e.g. /ban)
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 AdminCmdDataItemTarget::~AdminCmdDataItemTarget

(

)

[inline, virtual]

Definition at line 1839 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data for item transfer.

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.

Reimplemented in AdminCmdDataCheckItem.

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

Reimplemented in AdminCmdDataCheckItem.

---

Member Data Documentation

csString AdminCmdDataItemTarget::itemName

name of the item to transfer

Definition at line 1819 of file adminmanager.h.

int AdminCmdDataItemTarget::stackCount

amount to transfer

Definition at line 1820 of file adminmanager.h.

---

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

• server/adminmanager.h