Planeshift
psNameCheckMessage Class Reference

Used to check to see if a name chosen is a valid name to be picked from. More...

#include <messages.h>

Public Member Functions

void FromClient (MsgEntry *me)
 
void FromServer (MsgEntry *me)
 
 PSF_DECLARE_MSG_FACTORY ()
 
 psNameCheckMessage ()
 
 psNameCheckMessage (const char *name)
 
 psNameCheckMessage (const char *firstName, const char *lastName)
 Constructor. More...
 
 psNameCheckMessage (uint32_t client, bool accepted, const char *reason)
 
 psNameCheckMessage (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

bool accepted
 
csString firstName
 
csString lastName
 
csString reason
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Used to check to see if a name chosen is a valid name to be picked from.

Definition at line 4873 of file messages.h.

Constructor & Destructor Documentation

psNameCheckMessage::psNameCheckMessage ( )
inline

Definition at line 4876 of file messages.h.

psNameCheckMessage::psNameCheckMessage ( const char *  name)
psNameCheckMessage::psNameCheckMessage ( const char *  firstName,
const char *  lastName 
)

Constructor.

Prepares a message to be sent to the server with a first and last name. This is done to ask the server if the choosen name is usable.

Parameters
firstNameThe first name to be tried.
lastNameThe last name to be tried.
psNameCheckMessage::psNameCheckMessage ( uint32_t  client,
bool  accepted,
const char *  reason 
)
psNameCheckMessage::psNameCheckMessage ( MsgEntry me)

Member Function Documentation

void psNameCheckMessage::FromClient ( MsgEntry me)
void psNameCheckMessage::FromServer ( MsgEntry me)
psNameCheckMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psNameCheckMessage::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

bool psNameCheckMessage::accepted

Definition at line 4904 of file messages.h.

csString psNameCheckMessage::firstName

Definition at line 4901 of file messages.h.

csString psNameCheckMessage::lastName

Definition at line 4902 of file messages.h.

csString psNameCheckMessage::reason

Definition at line 4903 of file messages.h.


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