AdminCmdDataSetLabelColor Class Reference

Class for setting labels. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataSetLabelColor ()
	Creates obj for specified command setting labels.
	AdminCmdDataSetLabelColor (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 labelchange.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataSetLabelColor ()
Public Attributes
csString	labelType
	name of the label 'color'
AdminCmdSubCommandParser	labelTypeList
	list of valid label types

---

Detailed Description

Class for setting labels.

Definition at line 2333 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataSetLabelColor::AdminCmdDataSetLabelColor

(

)

[inline]

Creates obj for specified command setting labels.

Definition at line 2342 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 2355 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data for labelchange.

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 AdminCmdDataSetLabelColor::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 AdminCmdDataSetLabelColor::labelType

name of the label 'color'

Definition at line 2338 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataSetLabelColor::labelTypeList

list of valid label types

Definition at line 2336 of file adminmanager.h.

---

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

• server/adminmanager.h