Class for location command. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataLocation ()
	Creates obj for specified command that needs a reason. More...

	AdminCmdDataLocation (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 the parsed data. More...

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

virtual	~AdminCmdDataLocation ()

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	locationName
	name of the location More...

csString	locationType
	type of the location More...

float	radius
	radius of the location More...

float	rotAngle
	rotation angle for this location More...

float	searchRadius
	The radius to search for the location. More...

csString	subCommand
	subcommand storage More...

AdminCmdSubCommandParser	subCommandList
	list of subcommands 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 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 ( )

inlinevirtual

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation