Planeshift
psSimpleStringMessage Class Reference

Class to send a single arbitrary string to the client or server. More...

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psSimpleStringMessage (uint32_t client, MSG_TYPES type, const char *string)
 
 psSimpleStringMessage (MsgEntry *me)
 
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

csString str
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Class to send a single arbitrary string to the client or server.

Definition at line 6042 of file messages.h.

Constructor & Destructor Documentation

psSimpleStringMessage::psSimpleStringMessage ( uint32_t  client,
MSG_TYPES  type,
const char *  string 
)
psSimpleStringMessage::psSimpleStringMessage ( MsgEntry me)

Member Function Documentation

psSimpleStringMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psSimpleStringMessage::ToString ( NetBase::AccessPointers accessPointers)
inlinevirtual

Converts the message into human readable string.

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

Implements psMessageCracker.

Definition at line 6059 of file messages.h.

Member Data Documentation

csString psSimpleStringMessage::str

Definition at line 6046 of file messages.h.


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