Planeshift
psQuestionMessage Class Reference

#include <messages.h>

Public Types

enum  questionType_t { generalConfirm, secretGuildNotify, duelConfirm, marriageConfirm }
 Various questions that are posed to the user. More...
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psQuestionMessage (int clientnum, uint32_t questionID, const char *question, questionType_t type)
 
 psQuestionMessage (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 question
 
uint32_t questionID
 
questionType_t type
 
- 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 3718 of file messages.h.

Member Enumeration Documentation

Various questions that are posed to the user.

If a specific type is not below, use the generic generalConfirm type.

Enumerator
generalConfirm 

A general question that may concern anything.

secretGuildNotify 

Used to hide members of secret guilds.

Always denied on client side

duelConfirm 

Asks the user if they would like to duel.

marriageConfirm 

Asks the user if they would like to be married.

Definition at line 3726 of file messages.h.

Constructor & Destructor Documentation

psQuestionMessage::psQuestionMessage ( int  clientnum,
uint32_t  questionID,
const char *  question,
questionType_t  type 
)
inline

Definition at line 3738 of file messages.h.

psQuestionMessage::psQuestionMessage ( MsgEntry me)
inline

Definition at line 3752 of file messages.h.

Member Function Documentation

psQuestionMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psQuestionMessage::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 psQuestionMessage::question

Definition at line 3735 of file messages.h.

uint32_t psQuestionMessage::questionID

Definition at line 3734 of file messages.h.

questionType_t psQuestionMessage::type

Definition at line 3736 of file messages.h.


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