AdminCmdDataSet Class Reference

Class for setting attributes on a player. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataSet ()
	Creates obj for specified command that set attribute values.
	AdminCmdDataSet (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 attributes.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataSet ()
Public Attributes
csString	attribute
	the parsed attribute name if any
AdminCmdSubCommandParser	attributeList
	list of valid attributes
AdminCmdOnOffToggleParser	setting
	the specified setting on|off|toggle
csString	subCommand
	the parsed subcommand if any
AdminCmdSubCommandParser	subCommandList
	list of valid subcommands

---

Detailed Description

Class for setting attributes on a player.

Definition at line 2287 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataSet::AdminCmdDataSet

(

)

[inline]

Creates obj for specified command that set attribute values.

Definition at line 2299 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 2312 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data for attributes.

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 AdminCmdDataSet::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 AdminCmdDataSet::attribute

the parsed attribute name if any

Definition at line 2295 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataSet::attributeList

list of valid attributes

Definition at line 2291 of file adminmanager.h.

AdminCmdOnOffToggleParser AdminCmdDataSet::setting

the specified setting on|off|toggle

Definition at line 2292 of file adminmanager.h.

csString AdminCmdDataSet::subCommand

the parsed subcommand if any

Definition at line 2294 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataSet::subCommandList

list of valid subcommands

Definition at line 2290 of file adminmanager.h.

---

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

• server/adminmanager.h