Planeshift
psNPCWorkDoneMessage Class Reference

The message sent from server to superclient upon a successful work done. More...

#include <npcmessages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psNPCWorkDoneMessage (uint32_t clientToken, EID npcEID, const char *resource, const char *nick)
 
 psNPCWorkDoneMessage (MsgEntry *message)
 
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

const char * nick
 
EID npcEID
 
const char * resource
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

The message sent from server to superclient upon a successful work done.

Definition at line 343 of file npcmessages.h.

Constructor & Destructor Documentation

psNPCWorkDoneMessage::psNPCWorkDoneMessage ( uint32_t  clientToken,
EID  npcEID,
const char *  resource,
const char *  nick 
)
psNPCWorkDoneMessage::psNPCWorkDoneMessage ( MsgEntry message)

Member Function Documentation

psNPCWorkDoneMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psNPCWorkDoneMessage::ToString ( NetBase::AccessPointers accessPointers)
virtual

Converts the message into human readable string.

Used when a message is Logged. Every message should implement a version of this function that print all data that was decoded when the message was initiated from a NetEntry. See psDRMessage::ToString for an example.

Parameters
accessPointersA struct to a number of access pointers.
Returns
Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

const char* psNPCWorkDoneMessage::nick

Definition at line 348 of file npcmessages.h.

EID psNPCWorkDoneMessage::npcEID

Definition at line 346 of file npcmessages.h.

const char* psNPCWorkDoneMessage::resource

Definition at line 347 of file npcmessages.h.


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