AdminCmdDataLocation Class Reference

Class for location command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataLocation ()
	Creates obj for specified command that needs a reason.
	AdminCmdDataLocation (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 the parsed data.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataLocation ()
Public Attributes
csString	locationName
	name of the location
csString	locationType
	type of the location
float	radius
	radius of the location
float	rotAngle
	rotation angle for this location
float	searchRadius
	The radius to search for the location.
csString	subCommand
	subcommand storage
AdminCmdSubCommandParser	subCommandList
	list of subcommands

---

Detailed Description

Class for location command.

Definition at line 2420 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataLocation::AdminCmdDataLocation

(

)

[inline]

Creates obj for specified command that needs a reason.

Definition at line 2433 of file adminmanager.h.

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

(

)

[inline, virtual]

Definition at line 2446 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object 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 AdminCmdData.

virtual csString AdminCmdDataLocation::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 AdminCmdDataLocation::locationName

name of the location

Definition at line 2426 of file adminmanager.h.

csString AdminCmdDataLocation::locationType

type of the location

Definition at line 2425 of file adminmanager.h.

float AdminCmdDataLocation::radius

radius of the location

Definition at line 2427 of file adminmanager.h.

float AdminCmdDataLocation::rotAngle

rotation angle for this location

Definition at line 2429 of file adminmanager.h.

float AdminCmdDataLocation::searchRadius

The radius to search for the location.

Definition at line 2428 of file adminmanager.h.

csString AdminCmdDataLocation::subCommand

subcommand storage

Definition at line 2424 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataLocation::subCommandList

list of subcommands

Definition at line 2423 of file adminmanager.h.

---

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

• server/adminmanager.h