Planeshift
psMOTDMessage Class Reference

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psMOTDMessage (uint32_t clientNum, const csString &tipMsg, const csString &motdMsg, const csString &guildMsg, const csString &guild)
 
 psMOTDMessage (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 guild
 
csString guildmotd
 
csString motd
 
csString tip
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Definition at line 3623 of file messages.h.

Constructor & Destructor Documentation

psMOTDMessage::psMOTDMessage ( uint32_t  clientNum,
const csString &  tipMsg,
const csString &  motdMsg,
const csString &  guildMsg,
const csString &  guild 
)
inline

Definition at line 3626 of file messages.h.

psMOTDMessage::psMOTDMessage ( MsgEntry me)
inline

Definition at line 3639 of file messages.h.

Member Function Documentation

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

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.

Member Data Documentation

csString psMOTDMessage::guild

Definition at line 3660 of file messages.h.

csString psMOTDMessage::guildmotd

Definition at line 3659 of file messages.h.

csString psMOTDMessage::motd

Definition at line 3658 of file messages.h.

csString psMOTDMessage::tip

Definition at line 3657 of file messages.h.


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