Class for game event command. More...

#include <adminmanager.h>

Public Member Functions
	AdminCmdDataHire ()
	Creates obj for specified command that concern hire. More...

	AdminCmdDataHire (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 hire. More...

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

virtual	~AdminCmdDataHire ()

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
gemNPC *	hiredNPC

PID	masterPID
	master PID storage More...

gemActor *	owner

csString	subCmd
	subcommand storage More...

AdminCmdSubCommandParser	subCommandList
	list of subcommands More...

csString	typeName
	type name storage More...

csString	typeNPCType
	type NPC type storage 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 2580 of file adminmanager.h.

Constructor & Destructor Documentation

AdminCmdDataHire::AdminCmdDataHire ( )

inline

Creates obj for specified command that concern hire.

Definition at line 2594 of file adminmanager.h.

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

inlinevirtual

Definition at line 2607 of file adminmanager.h.

Member Function Documentation

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

virtual

Creates an object containing the parsed data for hire.

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 AdminCmdDataHire::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

gemNPC* AdminCmdDataHire::hiredNPC

Definition at line 2590 of file adminmanager.h.

PID AdminCmdDataHire::masterPID

master PID storage

Definition at line 2587 of file adminmanager.h.

gemActor* AdminCmdDataHire::owner

Definition at line 2589 of file adminmanager.h.

csString AdminCmdDataHire::subCmd

subcommand storage

Definition at line 2584 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataHire::subCommandList

list of subcommands

Definition at line 2583 of file adminmanager.h.

csString AdminCmdDataHire::typeName

type name storage

Definition at line 2585 of file adminmanager.h.

csString AdminCmdDataHire::typeNPCType

type NPC type storage

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