Class for petitions. More...

Public Member Functions
	AdminCmdDataPetition ()
	Creates obj for specified command that creates petitions. More...

	AdminCmdDataPetition (AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data. More...

virtual AdminCmdData *	CreateCmdData (AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates an object containing the parsed data of a petition. More...

virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class. More...

virtual	~AdminCmdDataPetition ()

Public Member Functions inherited from AdminCmdData
	AdminCmdData (csString commandName)
	creates data object for the specified command. More...

	AdminCmdData (csString commandName, WordArray &words)
	Parses the given message and stores its data. More...

virtual bool	IsQuietInvalid ()
	Used for overriding. More...

virtual bool	LogGMCommand (Client gmClient, const char cmd)
	Logs the game master command. More...

void	ParseError (MsgEntry me, const char errmsg)
	Sends the error message to the gm and invalidates the object. More...

virtual	~AdminCmdData ()

Public Attributes
csString	petition
	text of the petition More...

Public Attributes inherited from AdminCmdData
csString	command
	command name this obj contains data for More...

bool	help
	flag for displaying help (true for displaying help) More...

bool	valid
	flag for setting content valid/invalid More...

Additional Inherited Members
Protected Member Functions inherited from AdminCmdData
bool	IsHelp (const csString &word)
	Test for help word and store help state when found. More...

bool	LogGMCommand (Client gmClient, PID playerID, const char cmd)
	logs the game master command and target to the database. More...

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 ( )

inlinevirtual

Definition at line 1666 of file adminmanager.h.

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.

Reimplemented from AdminCmdData.

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: