Handle scripting of hired NPCs. More...

#include <messages.h>

Public Types
enum	{ CANCEL, CHECK_WORK_LOCATION, CHECK_WORK_LOCATION_RESULT, COMMIT, COMMIT_REPLY, REQUEST, REQUEST_REPLY, VERIFY, VERIFY_REPLY, WORK_LOCATION, WORK_LOCATION_RESULT, WORK_LOCATION_UPDATE }

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()

	psHiredNPCScriptMessage (uint32_t client, uint8_t command, EID hiredEID)
	Constructor. More...

	psHiredNPCScriptMessage (uint32_t client, uint8_t command, EID hiredEID, bool choice, const char *errorMsg)
	Constructor. More...

	psHiredNPCScriptMessage (uint32_t client, uint8_t command, EID hiredEID, const char *script)
	Constructor. More...

	psHiredNPCScriptMessage (uint32_t client, uint8_t command, EID hiredEID, const char locationType, const char locationName)
	Constructor. More...

	psHiredNPCScriptMessage (uint32_t client, uint8_t command, EID hiredEID, const char workLocation, bool workLocationValid, const char script)
	Constructor. More...

	psHiredNPCScriptMessage (MsgEntry *me)
	Constuctor. More...

virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string. More...

Public Member Functions inherited from psMessageCracker
void	FireEvent ()
	Publishes the message to the local program. More...

virtual csString	GetMessageTypeName () const =0
	Gets the name of the message type. More...

void	Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
	Multicasts the message to all current connections. More...

	psMessageCracker ()

void	SendMessage ()
	Sends the message to the client/server. More...

virtual	~psMessageCracker ()

Public Attributes
bool	choice

uint8_t	command

csString	errorMessage

EID	hiredEID

csString	locationName

csString	locationType

csString	script

csString	workLocation

bool	workLocationValid

Public Attributes inherited from psMessageCracker
int	filterNumber

csRef< MsgEntry >	msg

bool	valid

Additional Inherited Members
Static Public Attributes inherited from psMessageCracker
static MsgHandler *	msghandler

Detailed Description

Handle scripting of hired NPCs.

Definition at line 6156 of file messages.h.

Member Enumeration Documentation

anonymous enum

Enumerator
CANCEL
CHECK_WORK_LOCATION
CHECK_WORK_LOCATION_RESULT
COMMIT
COMMIT_REPLY
REQUEST
REQUEST_REPLY
VERIFY
VERIFY_REPLY
WORK_LOCATION
WORK_LOCATION_RESULT
WORK_LOCATION_UPDATE

Definition at line 6161 of file messages.h.

Constructor & Destructor Documentation

psHiredNPCScriptMessage::psHiredNPCScriptMessage	(	uint32_t	client,
		uint8_t	command,
		EID	hiredEID
	)

Constructor.

For commands CANCEL, WORK_LOCATION, REQUEST and COMMIT.

psHiredNPCScriptMessage::psHiredNPCScriptMessage	(	uint32_t	client,
		uint8_t	command,
		EID	hiredEID,
		bool	choice,
		const char *	errorMsg
	)

Constructor.

For commands VERIFY_REPLY, WORK_LOCATION_RESULT, COMMIT_REPLY.

psHiredNPCScriptMessage::psHiredNPCScriptMessage	(	uint32_t	client,
		uint8_t	command,
		EID	hiredEID,
		const char *	script
	)

Constructor.

For commands VERIFY, WORK_LOCATION_UPDATE.

Parameters

script The script or work location for WORK_LOCATION_UPDATE.

psHiredNPCScriptMessage::psHiredNPCScriptMessage	(	uint32_t	client,
		uint8_t	command,
		EID	hiredEID,
		const char *	locationType,
		const char *	locationName
	)

Constructor.

For commands CHECK_WORK_LOCATION (From Server to NPC Client).

psHiredNPCScriptMessage::psHiredNPCScriptMessage	(	uint32_t	client,
		uint8_t	command,
		EID	hiredEID,
		const char *	workLocation,
		bool	workLocationValid,
		const char *	script
	)

Constructor.

For commands REQUEST_REPLY.

psHiredNPCScriptMessage::psHiredNPCScriptMessage ( MsgEntry * me )

Constuctor.

Construct for message entry.

Member Function Documentation

psHiredNPCScriptMessage::PSF_DECLARE_MSG_FACTORY ( )

virtual csString psHiredNPCScriptMessage::ToString ( NetBase::AccessPointers * accessPointers )

virtual

Converts the message into human readable string.

Parameters

accessPointers A struct to a number of access pointers.

Returns: Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

bool psHiredNPCScriptMessage::choice

Definition at line 6179 of file messages.h.

uint8_t psHiredNPCScriptMessage::command

Definition at line 6177 of file messages.h.

csString psHiredNPCScriptMessage::errorMessage

Definition at line 6185 of file messages.h.

EID psHiredNPCScriptMessage::hiredEID

Definition at line 6178 of file messages.h.

csString psHiredNPCScriptMessage::locationName

Definition at line 6184 of file messages.h.

csString psHiredNPCScriptMessage::locationType

Definition at line 6183 of file messages.h.

csString psHiredNPCScriptMessage::script

Definition at line 6182 of file messages.h.

csString psHiredNPCScriptMessage::workLocation

Definition at line 6180 of file messages.h.

bool psHiredNPCScriptMessage::workLocationValid

Definition at line 6181 of file messages.h.

The documentation for this class was generated from the following file:

common/net/messages.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation