Planeshift
psMessageCracker Class Referenceabstract

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

#include <messages.h>

Public Member Functions

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 csString ToString (NetBase::AccessPointers *accessPointers)=0
 Converts the message into human readable string. More...
 
virtual ~psMessageCracker ()
 

Public Attributes

int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Static Public Attributes

static MsgHandlermsghandler
 

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 ( )
inlinevirtual

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
accessPointersA struct to a number of access pointers.
Returns
Return a human readable string for the message.

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

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: