AdminCmdDataPetition Class Reference

Class for petitions. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataPetition ()
	Creates obj for specified command that creates petitions.
	AdminCmdDataPetition (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 of a petition.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataPetition ()
Public Attributes
csString	petition
	text of the petition

---

Detailed Description

Class for petitions.

Definition at line 1646 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataPetition::AdminCmdDataPetition

(

)

[inline]

Creates obj for specified command that creates petitions.

Definition at line 1653 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 1666 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data of a petition.

Parameters:

msgManager	message manager that handles this command
msg	psAdminCmdMessage containing the message
me	The incoming message from the GM
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 AdminCmdData.

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

---

Member Data Documentation

csString AdminCmdDataPetition::petition

text of the petition

Definition at line 1649 of file adminmanager.h.

---

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

• server/adminmanager.h