AdminCmdDataHire Class Reference

Class for game event command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataHire ()
	Creates obj for specified command that concern hire.
	AdminCmdDataHire (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 containing the parsed data for hire.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataHire ()
Public Attributes
gemNPC *	hiredNPC
PID	masterPID
	master PID storage
gemActor *	owner
csString	subCmd
	subcommand storage
AdminCmdSubCommandParser	subCommandList
	list of subcommands
csString	typeName
	type name storage
csString	typeNPCType
	type NPC type storage

---

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

(

)

[inline, virtual]

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