psMessageCracker Class Reference

All net messages inherit from this class. More...

#include <messages.h>

List of all members.

Public Member Functions
void	FireEvent ()
	Publishes the message to the local program.
virtual csString	GetMessageTypeName () const =0
	Gets the name of the message type.
void	Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
	Multicasts the message to all current connections.
	psMessageCracker ()
void	SendMessage ()
	Sends the message to the client/server.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)=0
	Converts the message into human readable string.
virtual	~psMessageCracker ()
Public Attributes
int	filterNumber
csRef< MsgEntry >	msg
bool	valid
Static Public Attributes
static MsgHandler *	msghandler

---

Detailed Description

All net messages inherit from this class.

The constructors either take the parameters required to build the net message, or take the net message and pull out all the parameters.

Definition at line 343 of file messages.h.

---

Constructor & Destructor Documentation

psMessageCracker::psMessageCracker

(

)

[inline]

Definition at line 352 of file messages.h.

virtual psMessageCracker::~psMessageCracker

(

)

[inline, virtual]

Definition at line 356 of file messages.h.

---

Member Function Documentation

void psMessageCracker::FireEvent

(

)

Publishes the message to the local program.

virtual csString psMessageCracker::GetMessageTypeName

(

)

const [pure virtual]

Gets the name of the message type.

Used by the message factory to get the name of the message type. This should NOT be overloaded manually. Use the PSF_DECLARE_MSG_FACTORY macro.

void psMessageCracker::Multicast	(	csArray< PublishDestination > &	multi,
		uint32_t	except,
		float	range
	)

Multicasts the message to all current connections.

void psMessageCracker::SendMessage

(

)

Sends the message to the client/server.

virtual csString psMessageCracker::ToString

(

NetBase::AccessPointers *

accessPointers

)

[pure virtual]

Converts the message into human readable string.

Used when a message is Logged. Every message should implement a version of this function that print all data that was decoded when the message was initiated from a NetEntry. See psDRMessage::ToString for an example.

Parameters:

accessPointers

A struct to a number of access pointers.

Returns:

Return a human readable string for the message.

Implemented in psCharApprovedMessage, psCharRejectedMessage, psCharVerificationMesg, psCharUploadMessage, psCreationChoiceMsg, psLifeEventMsg, psMarriageMsgPropose, psMarriageMsgDivorce, psMarriageMsgDivorceConfirm, psCharDeleteMessage, psPreAuthenticationMessage, psAuthenticationMessage, psCharacterPickerMessage, psCharacterApprovedMessage, psPreAuthApprovedMessage, psAuthApprovedMessage, psAuthRejectedMessage, psChatMessage, psChannelJoinMessage, psChannelJoinedMessage, psChannelLeaveMessage, psSystemMessage, psPetitionMessage, psPetitionRequestMessage, psGMGuiMessage, psGuildCmdMessage, psGUIGuildMessage, psGroupCmdMessage, psUserCmdMessage, psWorkCmdMessage, psAdminCmdMessage, psGenericCmdMessage, psDisconnectMessage, psUserActionMessage, psGUIInteractMessage, psMapActionMessage, psAttackQueueMessage, psModeMessage, psMoveLockMessage, psWeatherMessage, psGUIInventoryMessage, psNewSectorMessage, psLootItemMessage, psLootMessage, psQuestListMessage, psQuestInfoMessage, psOverrideActionMessage, psEquipmentMessage, psGUIMerchantMessage, psGUIStorageMessage, psGUIGroupMessage, psSpellCancelMessage, psCraftCancelMessage, psAttackBookMessage, psSpellBookMessage, psPurifyGlyphMessage, psSpellCastMessage, psGlyphAssembleMessage, psRequestGlyphsMessage, psStopEffectMessage, psEffectMessage, psGUITargetUpdateMessage, psMsgStringsMessage, psSpecialCombatEventMessage, psCombatEventMessage, psSoundEventMessage, psStatDRMessage, psStatsMessage, psGUISkillMessage, psGUIBankingMessage, psPetSkillMessage, psDRMessage, psForcePositionMessage, psPersistWorldRequest, psRequestAllObjects, psPersistWorld, psPersistActorRequest, psPersistAllEntities, psPersistActor, psPersistItem, psPersistActionLocation, psRemoveObject, psBuddyListMsg, psBuddyStatus, psMOTDMessage, psMOTDRequestMessage, psQuestionResponseMsg, psQuestionMessage, psAdviceMessage, psGUIActiveMagicMessage, psSlotMovementMsg, psCmdDropMessage, psQuestionCancelMessage, psGuildMOTDSetMessage, psCharacterDetailsMessage, psCharacterDetailsRequestMessage, psCharacterDescriptionUpdateMessage, psViewActionLocationMessage, psViewItemDescription, psViewContainerDescription, psViewItemUpdate, psWriteBookMessage, psReadBookTextMessage, psQuestRewardMessage, psExchangeMoneyMsg, psExchangeRequestMsg, psExchangeAddItemMsg, psExchangeRemoveItemMsg, psExchangeAcceptMsg, psExchangeStatusMsg, psExchangeEndMsg, psUpdateObjectNameMessage, psUpdatePlayerGuildMessage, psUpdatePlayerGroupMessage, psNameCheckMessage, psPingMsg, psHeartBeatMsg, psLockpickMessage, psGMSpawnItems, psGMSpawnTypes, psGMSpawnGetMods, psGMSpawnMods, psGMSpawnItem, psLootRemoveMessage, psCharCreateTraitsMessage, psClientStatusMessage, psMoveModMsg, psMsgRequestMovement, psMovementInfoMessage, psMsgCraftingInfo, psTraitChangeMessage, psTutorialMessage, psSketchMessage, psMusicalSheetMessage, psPlaySongMessage, psStopSongMessage, psMGStartStopMessage, psMGBoardMessage, psMGUpdateMessage, psEntranceMessage, psGMEventListMessage, psGMEventInfoMessage, psFactionMessage, psSequenceMessage, psPlaySoundMessage, psCharCreateCPMessage, psCharIntroduction, psCachedFileMessage, psDialogMenuMessage, psSimpleStringMessage, psSimpleRenderMeshMessage, psMechanismActivateMessage, psOrderedMessage, psHiredNPCScriptMessage, psNPCListMessage, psNPCReadyMessage, psMapListMessage, psNPCRaceListMessage, psNPCCommandsMessage, psAllEntityPosMessage, psNPCWorkDoneMessage, psNewNPCCreatedMessage, psNPCDeletedMessage, psPETCommandMessage, psServerCommandMessage, psPathNetworkMessage, psLocationMessage, psDamageEvent, psDeathEvent, psTargetChangeEvent, psZPointsGainedEvent, psBuyEvent, psSellEvent, psPickupEvent, psDropEvent, psLootEvent, psConnectEvent, psMovementEvent, and psGenericEvent.

---

Member Data Documentation

int psMessageCracker::filterNumber

Definition at line 350 of file messages.h.

csRef<MsgEntry> psMessageCracker::msg

Definition at line 348 of file messages.h.

MsgHandler* psMessageCracker::msghandler [static]

Definition at line 346 of file messages.h.

bool psMessageCracker::valid

Definition at line 349 of file messages.h.

---

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

• common/net/messages.h