Message sent from server to client if login was valid. More...

#include <messages.h>

Public Member Functions
void	AddCharacter (const char fullname, const char race, const char mesh, const char traits, const char *equipment)
	Add another character definition to the buffer. More...

void	ConstructMsg ()
	Build the message. More...

void	GetCharacter (MsgEntry *message, csString &fullname, csString &race, csString &mesh, csString &traits, csString &equipment)
	Get the next character definition from the MsgEntry buffer. More...

	psAuthApprovedMessage (uint32_t clientnum, PID playerID, uint8_t numCharacters)
	Stores initial data, but does not construct the outbound message. More...

	psAuthApprovedMessage (MsgEntry *message)
	Crack incoming psMessageBytes struct for inbound use. More...

	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
uint32_t	msgClientValidToken
	This must be returned by the client in all future messages to validate sender. More...

uint8_t	msgNumOfChars
	The number of characters for this account. More...

PID	msgPlayerID
	This is the ID which must be requested to instantiate the client player. More...

Public Attributes inherited from psMessageCracker
int	filterNumber

csRef< MsgEntry >	msg

bool	valid

Additional Inherited Members
Static Public Attributes inherited from psMessageCracker
static MsgHandler *	msghandler

Detailed Description

Message sent from server to client if login was valid.

Definition at line 697 of file messages.h.

Constructor & Destructor Documentation

psAuthApprovedMessage::psAuthApprovedMessage	(	uint32_t	clientnum,
		PID	playerID,
		uint8_t	numCharacters
	)

Stores initial data, but does not construct the outbound message.

This allows a varying number of characters to be added via AddCharacter. Call ConstructMsg to create the actual message.

psAuthApprovedMessage::psAuthApprovedMessage ( MsgEntry * message )

Crack incoming psMessageBytes struct for inbound use.

void psAuthApprovedMessage::AddCharacter	(	const char *	fullname,
		const char *	race,
		const char *	mesh,
		const char *	traits,
		const char *	equipment
	)

Add another character definition to the buffer.

void psAuthApprovedMessage::ConstructMsg ( )

Build the message.

void psAuthApprovedMessage::GetCharacter	(	MsgEntry *	message,
		csString &	fullname,
		csString &	race,
		csString &	mesh,
		csString &	traits,
		csString &	equipment
	)

Get the next character definition from the MsgEntry buffer.

psAuthApprovedMessage::PSF_DECLARE_MSG_FACTORY ( )

virtual csString psAuthApprovedMessage::ToString ( NetBase::AccessPointers * accessPointers )

virtual

Converts the message into human readable string.

Parameters

accessPointers A struct to a number of access pointers.

uint32_t psAuthApprovedMessage::msgClientValidToken

This must be returned by the client in all future messages to validate sender.

Definition at line 703 of file messages.h.

uint8_t psAuthApprovedMessage::msgNumOfChars

The number of characters for this account.

Definition at line 710 of file messages.h.

PID psAuthApprovedMessage::msgPlayerID

This is the ID which must be requested to instantiate the client player.

Definition at line 707 of file messages.h.

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