Class for handling path commands. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataPath ()
	Creates obj for specified command that manipulate paths. More...

	AdminCmdDataPath (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 containing the parsed data for paths. More...

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

virtual	~AdminCmdDataPath ()

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	alias
	waypoint alias name More...

csString	aliasSubCmd
	storage for alias subcommand More...

AdminCmdSubCommandParser	aliasSubCommandList
	subsubcmds of alias More...

csString	cmdTarget
	'W' or 'P' as a target for hide/show More...

float	defaultRadius
	default radius for the case radius == 0.0 More...

int	firstIndex
	index for waypoint paths More...

csString	flagName
	single flag name More...

float	newRadius
	The radius to set for new radius for wps. More...

csString	pathFlags
	path flags More...

float	radius
	radius for waypoint/path operations More...

float	rotationAngle
	The rotation angle of a alias. More...

csString	subCmd
	storage for subcommand More...

AdminCmdSubCommandParser	subCommandList
	allowed subcommands More...

csString	waypoint
	waypoint name More...

csString	waypointFlags
	waypoint flags More...

int	waypointPathIndex
	Index of the wp or point. More...

csString	waypointPathName
	pathname for waypoints More...

AdminCmdSubCommandParser	wpList
	targetnames of hide/show More...

bool	wpOrPathIsIndex
	True when an index is used. More...

bool	wpOrPathIsWP
	Is it the path or the wp that should be updated. 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 handling path commands.

Definition at line 2467 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataPath::AdminCmdDataPath ( )

inline

Creates obj for specified command that manipulate paths.

Definition at line 2494 of file adminmanager.h.

AdminCmdDataPath::AdminCmdDataPath	(	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 AdminCmdDataPath::~AdminCmdDataPath ( )

inlinevirtual

Definition at line 2507 of file adminmanager.h.

Member Function Documentation

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

virtual

Creates an object containing the parsed data for paths.

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 AdminCmdDataPath::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 AdminCmdDataPath::alias

waypoint alias name

Definition at line 2480 of file adminmanager.h.

csString AdminCmdDataPath::aliasSubCmd

storage for alias subcommand

Definition at line 2474 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataPath::aliasSubCommandList

subsubcmds of alias

Definition at line 2471 of file adminmanager.h.

csString AdminCmdDataPath::cmdTarget

'W' or 'P' as a target for hide/show

Definition at line 2486 of file adminmanager.h.

float AdminCmdDataPath::defaultRadius

default radius for the case radius == 0.0

Definition at line 2476 of file adminmanager.h.

int AdminCmdDataPath::firstIndex

index for waypoint paths

Definition at line 2483 of file adminmanager.h.

csString AdminCmdDataPath::flagName

single flag name

Definition at line 2481 of file adminmanager.h.

float AdminCmdDataPath::newRadius

The radius to set for new radius for wps.

Definition at line 2478 of file adminmanager.h.

csString AdminCmdDataPath::pathFlags

path flags

Definition at line 2485 of file adminmanager.h.

float AdminCmdDataPath::radius

radius for waypoint/path operations

Definition at line 2477 of file adminmanager.h.

float AdminCmdDataPath::rotationAngle

The rotation angle of a alias.

Definition at line 2489 of file adminmanager.h.

csString AdminCmdDataPath::subCmd

storage for subcommand

Definition at line 2473 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataPath::subCommandList

allowed subcommands

Definition at line 2470 of file adminmanager.h.

csString AdminCmdDataPath::waypoint

waypoint name

Definition at line 2479 of file adminmanager.h.

csString AdminCmdDataPath::waypointFlags

waypoint flags

Definition at line 2484 of file adminmanager.h.

int AdminCmdDataPath::waypointPathIndex

Index of the wp or point.

Definition at line 2487 of file adminmanager.h.

csString AdminCmdDataPath::waypointPathName

pathname for waypoints

Definition at line 2482 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataPath::wpList

targetnames of hide/show

Definition at line 2472 of file adminmanager.h.

bool AdminCmdDataPath::wpOrPathIsIndex

True when an index is used.

Definition at line 2488 of file adminmanager.h.

bool AdminCmdDataPath::wpOrPathIsWP

Is it the path or the wp that should be updated.

Definition at line 2475 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