Planeshift
psDialogMenuMessage Class Reference

The message sent from server to client when a menu of possible responses is available. More...

#include <messages.h>

Classes

struct  DialogResponse
 

Public Member Functions

void AddResponse (uint32_t id, const csString &menuText, const csString &triggerText, uint32_t flags=0x00)
 
void BuildMsg (int clientnum)
 
 psDialogMenuMessage ()
 
 psDialogMenuMessage (MsgEntry *message)
 
 PSF_DECLARE_MSG_FACTORY ()
 
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

csArray< DialogResponseresponses
 
csString xml
 
- 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 client when a menu of possible responses is available.

Definition at line 6005 of file messages.h.

Constructor & Destructor Documentation

psDialogMenuMessage::psDialogMenuMessage ( )
psDialogMenuMessage::psDialogMenuMessage ( MsgEntry message)

Member Function Documentation

void psDialogMenuMessage::AddResponse ( uint32_t  id,
const csString &  menuText,
const csString &  triggerText,
uint32_t  flags = 0x00 
)
void psDialogMenuMessage::BuildMsg ( int  clientnum)
psDialogMenuMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psDialogMenuMessage::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

csArray<DialogResponse> psDialogMenuMessage::responses

Definition at line 6036 of file messages.h.

csString psDialogMenuMessage::xml

Definition at line 6008 of file messages.h.


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