AdminCmdDataImpersonate Class Reference

Class for impersonation command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataImpersonate ()
	Creates obj for specified command that impersonates someone.
	AdminCmdDataImpersonate (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 impersonate.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataImpersonate ()
Public Attributes
csString	commandMod
	whether say,shout,worldshout should be used
int	duration
	The duration of the anim if any (0 default one run)
csString	text
	text to send impersonated

---

Detailed Description

Class for impersonation command.

Basically impersonation is for sending text in the name of someone else

Definition at line 1689 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataImpersonate::AdminCmdDataImpersonate

(

)

[inline]

Creates obj for specified command that impersonates someone.

Definition at line 1698 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 1711 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed data for impersonate.

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 AdminCmdDataImpersonate::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 AdminCmdDataImpersonate::commandMod

whether say,shout,worldshout should be used

Definition at line 1692 of file adminmanager.h.

int AdminCmdDataImpersonate::duration

The duration of the anim if any (0 default one run)

Definition at line 1694 of file adminmanager.h.

csString AdminCmdDataImpersonate::text

text to send impersonated

Definition at line 1693 of file adminmanager.h.

---

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

• server/adminmanager.h