Class for game event command. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataGameMasterEvent ()
	Creates obj for specified command that concern game events. More...

	AdminCmdDataGameMasterEvent (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 an event. More...

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

virtual	~AdminCmdDataGameMasterEvent ()

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	commandMod
	subsubcommand More...

csString	gmeventDesc
	description of the event More...

csString	gmeventName
	name of the event More...

AdminCmdTargetParser	player
	when a playertarget needs to be parsed More...

float	range
	range to search for targets More...

RangeSpecifier	rangeSpecifier
	range type More...

AdminCmdRewardParser	rewardList
	rewards parser and storage More...

csString	subCmd
	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 game event command.

Definition at line 2528 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataGameMasterEvent::AdminCmdDataGameMasterEvent ( )

inline

Creates obj for specified command that concern game events.

Definition at line 2546 of file adminmanager.h.

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

inlinevirtual

Definition at line 2559 of file adminmanager.h.

Member Function Documentation

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

virtual

Creates an object containing the parsed data for an event.

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

subsubcommand

Definition at line 2540 of file adminmanager.h.

csString AdminCmdDataGameMasterEvent::gmeventDesc

description of the event

Definition at line 2538 of file adminmanager.h.

csString AdminCmdDataGameMasterEvent::gmeventName

name of the event

Definition at line 2537 of file adminmanager.h.

AdminCmdTargetParser AdminCmdDataGameMasterEvent::player

when a playertarget needs to be parsed

Definition at line 2534 of file adminmanager.h.

float AdminCmdDataGameMasterEvent::range

range to search for targets

Definition at line 2542 of file adminmanager.h.

RangeSpecifier AdminCmdDataGameMasterEvent::rangeSpecifier

range type

Definition at line 2541 of file adminmanager.h.

AdminCmdRewardParser AdminCmdDataGameMasterEvent::rewardList

rewards parser and storage

Definition at line 2535 of file adminmanager.h.

csString AdminCmdDataGameMasterEvent::subCmd

subcommand storage

Definition at line 2532 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataGameMasterEvent::subCommandList

list of subcommands

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