psNameCheckMessage Class Reference

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

#include <messages.h>

List of all members.

Public Member Functions
void	FromClient (MsgEntry *me)
void	FromServer (MsgEntry *me)
	PSF_DECLARE_MSG_FACTORY ()
	psNameCheckMessage ()
	psNameCheckMessage (uint32_t client, bool accepted, const char *reason)
	psNameCheckMessage (MsgEntry *me)
	psNameCheckMessage (const char *name)
	psNameCheckMessage (const char *firstName, const char *lastName)
	Constructor.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string.
Public Attributes
bool	accepted
csString	firstName
csString	lastName
csString	reason

---

Detailed Description

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

Definition at line 4866 of file messages.h.

---

Constructor & Destructor Documentation

psNameCheckMessage::psNameCheckMessage

(

)

[inline]

Definition at line 4869 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:

firstName	The first name to be tried.
lastName	The 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:

accessPointers

A 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 4897 of file messages.h.

csString psNameCheckMessage::firstName

Definition at line 4894 of file messages.h.

csString psNameCheckMessage::lastName

Definition at line 4895 of file messages.h.

csString psNameCheckMessage::reason

Definition at line 4896 of file messages.h.

---

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

• common/net/messages.h