AdminCmdDataRunScript Class Reference

Class for a command running a script. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataRunScript ()
	Creates obj for specified command that execute a script.
	AdminCmdDataRunScript (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.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataRunScript ()
Public Attributes
AdminCmdTargetParser	origObj
	Optional argument to specify a different origin for the script being run.
csString	scriptName
	name of the script to execute

---

Detailed Description

Class for a command running a script.

Definition at line 1334 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataRunScript::AdminCmdDataRunScript

(

)

[inline]

Creates obj for specified command that execute a script.

Definition at line 1342 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 1355 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed 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

Returns:

AdminCmdData* pointer to object containing parsed data. When parsing failed the valid flag is set to false.

Reimplemented from AdminCmdDataTarget.

virtual csString AdminCmdDataRunScript::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

AdminCmdTargetParser AdminCmdDataRunScript::origObj

Optional argument to specify a different origin for the script being run.

Definition at line 1338 of file adminmanager.h.

csString AdminCmdDataRunScript::scriptName

name of the script to execute

Definition at line 1337 of file adminmanager.h.

---

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

• server/adminmanager.h