Class for commands with a sector target. More...

Public Member Functions
	AdminCmdDataSectorTarget (csString command)
	Creates obj for specified command that target a sector.
	AdminCmdDataSectorTarget (csString command, 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 targeting a sector.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual bool	GetSectorOfClient (Client *client)
	Retrieves the current sector of the command issuing client.
virtual bool	ParseTarget (AdminManager msgManager, MsgEntry me, psAdminCmdMessage &msg, Client *client, csString target)
	Tries to parse the supplied string as a destination.
virtual	~AdminCmdDataSectorTarget ()
Public Attributes
bool	isClientSector
	true when sector of client is stored
psSectorInfo *	sectorInfo
	sector either found by sectorname or client position
csString	sectorName
	name of the sector (when parsed successfully)

Detailed Description

Class for commands with a sector target.

Definition at line 1899 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataSectorTarget::AdminCmdDataSectorTarget ( csString command ) [inline]

Creates obj for specified command that target a sector.

Parameters:

command name of the command (e.g. /ban)

Definition at line 1909 of file adminmanager.h.

AdminCmdDataSectorTarget::AdminCmdDataSectorTarget	(	csString	command,
		AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)

Parses the given message and stores its data.

Parameters:

command	name of the command (e.g. /ban)
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 AdminCmdDataSectorTarget::~AdminCmdDataSectorTarget ( ) [inline, virtual]

Definition at line 1923 of file adminmanager.h.

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

Creates an object containing the parsed data targeting a sector.

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 AdminCmdData.

virtual csString AdminCmdDataSectorTarget::GetHelpMessage ( ) [virtual]

Returns a helpmessage that fits to the parser of the class.

Reimplemented from AdminCmdData.

virtual bool AdminCmdDataSectorTarget::GetSectorOfClient ( Client * client ) [virtual]

Retrieves the current sector of the command issuing client.

Parameters:

client is the gm client issuing the command

virtual bool AdminCmdDataSectorTarget::ParseTarget	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		csString	target
	)		`[virtual]`

Tries to parse the supplied string as a destination.

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
target	string to parse as a destination