First pass over plMessage headers.

This reduces the amount of redundant #includes in the plMessage headers.
Still need to check over the actual source files and do some work to
remove pnUtils (ugh) from one message.

Sources/Plasma/PubUtilLib/plAvatar/plAGAnim.cpp

@@ -55,6 +55,7 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #include "hsResMgr.h"
 
 // other
+#include "plInterp/plAnimEaseTypes.h"
 #include "plMessage/plAnimCmdMsg.h"
 
 /////////////////////////////////////////////////////////////////////////////////////////

Sources/Plasma/PubUtilLib/plAvatar/plAGMasterMod.cpp

@@ -55,6 +55,7 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #include "plgDispatch.h"
 
 // other
+#include "plInterp/plAnimEaseTypes.h"
 #include "plMessage/plAnimCmdMsg.h"
 #include "pnMessage/plSDLModifierMsg.h"
 #include "pnMessage/plSDLNotificationMsg.h"

Sources/Plasma/PubUtilLib/plMessage/CMakeLists.txt

@@ -67,7 +67,6 @@ set(plMessage_HEADERS
     plDynaDecalEnableMsg.h
     plDynamicEnvMapMsg.h
     plDynamicTextMsg.h
-    plElementRefMsg.h
     plExcludeRegionMsg.h
     plInputEventMsg.h
     plInputIfaceMgrMsg.h
@@ -117,7 +116,6 @@ set(plMessage_HEADERS
     plTimerCallbackMsg.h
     plTransitionMsg.h
     plTriggerMsg.h
-    plUniqueIdsMsg.h
     plVaultNotifyMsg.h
 )
 

Sources/Plasma/PubUtilLib/plMessage/plAIMsg.cpp

@@ -44,7 +44,6 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 #include "plAIMsg.h"
 
-#include "hsResMgr.h"
 #include "hsStream.h"
 
 #include "plAvatar/plArmatureMod.h"
@@ -60,8 +59,6 @@ plAIMsg::plAIMsg(const plKey& sender, const plKey& receiver): plMessage(sender,
     plArmatureMod* armMod = plArmatureMod::ConvertNoRef(sender->ObjectIsLoaded());
     if (armMod)
         fBrainUserStr = armMod->GetUserStr();
-    else
-        fBrainUserStr = "";
 }
 
 void plAIMsg::Read(hsStream* stream, hsResMgr* mgr)

Sources/Plasma/PubUtilLib/plMessage/plAccountUpdateMsg.cpp

@@ -42,16 +42,6 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #include "plAccountUpdateMsg.h"
 #include "hsStream.h"
 
-plAccountUpdateMsg::plAccountUpdateMsg()
-{
-    fUpdateType = 0;
-}
-
-plAccountUpdateMsg::plAccountUpdateMsg(unsigned updateType)
-{
-    fUpdateType = updateType;
-}
-
 void plAccountUpdateMsg::Read(hsStream* stream, hsResMgr* mgr)
 {
     plMessage::IMsgRead(stream, mgr);
@@ -67,34 +57,3 @@ void plAccountUpdateMsg::Write(hsStream* stream, hsResMgr* mgr)
     stream->WriteLE32(fResult);
     stream->WriteLE32(fPlayerInt);
 }
-
-unsigned plAccountUpdateMsg::GetUpdateType()
-{
-    return fUpdateType;
-}
-
-void plAccountUpdateMsg::SetUpdateType(unsigned type)
-{
-    fUpdateType = type;
-}
-
-unsigned plAccountUpdateMsg::GetResult()
-{
-    return fResult;
-}
-
-void plAccountUpdateMsg::SetResult(unsigned result)
-{
-    fResult = result;
-}
-
-unsigned plAccountUpdateMsg::GetPlayerInt()
-{
-    return fPlayerInt;
-}
-
-void plAccountUpdateMsg::SetPlayerInt(unsigned playerInt)
-{
-    fPlayerInt = playerInt;
-}
-

Sources/Plasma/PubUtilLib/plMessage/plAccountUpdateMsg.h

@@ -61,28 +61,28 @@ public:
         kChangePassword,
     };
 
-    plAccountUpdateMsg();
+    plAccountUpdateMsg() : fUpdateType(0), fResult(0), fPlayerInt(0) { }
-    plAccountUpdateMsg(unsigned updateType);
+    plAccountUpdateMsg(uint32_t updateType) : fUpdateType(updateType), fResult(0), fPlayerInt(0) { }
 
-    CLASSNAME_REGISTER( plAccountUpdateMsg );
+    CLASSNAME_REGISTER(plAccountUpdateMsg);
-    GETINTERFACE_ANY( plAccountUpdateMsg, plMessage );
+    GETINTERFACE_ANY(plAccountUpdateMsg, plMessage);
 
     void Read(hsStream* stream, hsResMgr* mgr);
     void Write(hsStream* stream, hsResMgr* mgr);
 
-    unsigned    GetUpdateType();
+    uint32_t    GetUpdateType() const { return fUpdateType; }
-    void        SetUpdateType(unsigned type);
+    void        SetUpdateType(uint32_t type) { fUpdateType = type; }
 
-    unsigned    GetResult();
+    uint32_t    GetResult() const { return fResult; }
-    void        SetResult(unsigned result);
+    void        SetResult(uint32_t result) { fResult = result; }
 
-    unsigned    GetPlayerInt();
+    uint32_t    GetPlayerInt() const { return fPlayerInt; }
-    void        SetPlayerInt(unsigned playerInt);
+    void        SetPlayerInt(uint32_t playerInt) { fPlayerInt = playerInt; }
 
 private:
-    unsigned fUpdateType;
+    uint32_t fUpdateType;
-    unsigned fResult;
+    uint32_t fResult;
-    unsigned fPlayerInt;
+    uint32_t fPlayerInt;
 };
 
 #endif // plAccountUpdateMsg_inc

Sources/Plasma/PubUtilLib/plMessage/plAnimCmdMsg.cpp

@@ -40,7 +40,6 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 *==LICENSE==*/
 
-#include "HeadSpin.h"
 #include "plAnimCmdMsg.h"
 #include "hsStream.h"
 
@@ -114,16 +113,6 @@ plAGCmdMsg::~plAGCmdMsg()
     ClearCmd();
 }
 
-void plAGCmdMsg::SetAnimName(const plString &name)
-{
-    fAnimName = name;
-}
-
-plString plAGCmdMsg::GetAnimName()
-{
-    return fAnimName;
-}
-
 void plAGCmdMsg::Read(hsStream* stream, hsResMgr* mgr)
 {
     plMessage::IMsgRead(stream, mgr);
@@ -150,14 +139,3 @@ void plAGCmdMsg::Write(hsStream* stream, hsResMgr* mgr)
     stream->WriteSafeString(fAnimName);
 }
 
-/////////////////////////////////////////////////////////////////////////////////////
-
-void plAGDetachCallbackMsg::SetAnimName(const plString &name)
-{
-    fAnimName = name;
-}
-
-plString plAGDetachCallbackMsg::GetAnimName()
-{
-    return fAnimName;
-}

Sources/Plasma/PubUtilLib/plMessage/plAnimCmdMsg.h

@@ -45,11 +45,7 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 #include "pnMessage/plMessageWithCallbacks.h"
 #include "hsBitVector.h"
-#include "hsTemplates.h"
-#include "hsGeometry3.h"
 #include "plString.h"
-#include "plInterp/plAnimEaseTypes.h"
-#include "plInterp/plAnimTimeConvert.h"
 
 class plAGAnimInstance;
 
@@ -112,7 +108,7 @@ public:
     void SetCmd(int n) { fCmd.SetBit(n); }
     void ClearCmd();
     void SetAnimName(const plString &name) { fAnimName = name; }
-    plString GetAnimName() { return fAnimName; }
+    plString GetAnimName() const { return fAnimName; }
     bool CmdChangesAnimTime(); // Will this command cause an update to the current anim time?
 
     void SetLoopName(const plString &name) { fLoopName = name; }
@@ -166,8 +162,8 @@ public:
     bool Cmd(int n) const { return fCmd.IsBitSet(n); }
     void SetCmd(int n) { fCmd.SetBit(n); }
     void ClearCmd() { fCmd.Clear(); }
-    void SetAnimName(const plString &name);
+    void SetAnimName(const plString& name) { fAnimName = name; }
-    plString GetAnimName();
+    plString GetAnimName() const { return fAnimName; }
 
     float fBlend;
     float fBlendRate;
@@ -214,8 +210,8 @@ public:
     void Read(hsStream* stream, hsResMgr* mgr) {}
     void Write(hsStream* stream, hsResMgr* mgr) {}
 
-    void SetAnimName(const plString &name);
+    void SetAnimName(const plString& name) { fAnimName = name; }
-    plString GetAnimName();
+    plString GetAnimName() const { return fAnimName; }
 };
 
 

Sources/Plasma/PubUtilLib/plMessage/plAvatarMsg.h

@@ -44,7 +44,6 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #ifndef plAvatarMsg_inc
 #define plAvatarMsg_inc
 
-#include "pnMessage/plMessage.h"
 #include "hsBitVector.h"
 #include "plAvatar/plArmatureMod.h"
 #include "pnMessage/plEventCallbackMsg.h"

Sources/Plasma/PubUtilLib/plMessage/plElementRefMsg.h

@@ -1,42 +0,0 @@
-/*==LICENSE==*
-
-CyanWorlds.com Engine - MMOG client, server and tools
-Copyright (C) 2011  Cyan Worlds, Inc.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Additional permissions under GNU GPL version 3 section 7
-
-If you modify this Program, or any covered work, by linking or
-combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
-NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
-JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
-(or a modified version of those libraries),
-containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
-PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
-JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
-licensors of this Program grant you additional
-permission to convey the resulting work. Corresponding Source for a
-non-source form of such a combination shall include the source code for
-the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
-work.
-
-You can contact Cyan Worlds, Inc. by email legal@cyan.com
- or by snail mail at:
-      Cyan Worlds, Inc.
-      14617 N Newport Hwy
-      Mead, WA   99021
-
-*==LICENSE==*/
-// Nuked file. Delete from your source file

Sources/Plasma/PubUtilLib/plMessage/plExcludeRegionMsg.h

@@ -69,7 +69,7 @@ public:
     GETINTERFACE_ANY(plExcludeRegionMsg, plMessage);
     
     void SetCmd(CmdType cmd) { fCmd = cmd; }
-    uint8_t GetCmd() { return fCmd; }
+    uint8_t GetCmd() const { return fCmd; }
 
     uint32_t fSynchFlags;
     // IO 

Sources/Plasma/PubUtilLib/plMessage/plInputIfaceMgrMsg.cpp

@@ -46,21 +46,41 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 //                                                                          //
 //////////////////////////////////////////////////////////////////////////////
 
-#include "HeadSpin.h"
 #include "plInputIfaceMgrMsg.h"
 #include "plInputCore/plInputInterface.h"
 #include "hsResMgr.h"
-#include "hsRefCnt.h"
-
 
 plInputIfaceMgrMsg::~plInputIfaceMgrMsg()
 {
-    if( fInterface != nil )
+    hsRefCnt_SafeUnRef(fInterface);
-        hsRefCnt_SafeUnRef( fInterface );
 }
 
-void    plInputIfaceMgrMsg::SetIFace( plInputInterface *iface )
+void    plInputIfaceMgrMsg::SetIFace(plInputInterface* iface)
 {
     fInterface = iface;
-    hsRefCnt_SafeRef( fInterface );
+    hsRefCnt_SafeRef(fInterface);
+}
+
+void plInputIfaceMgrMsg::Read(hsStream* s, hsResMgr* mgr)
+{
+    plMessage::IMsgRead(s, mgr);
+
+    s->ReadLE(&fCommand);
+    s->ReadLE(&fPageID);
+    ageName = s->ReadSafeString();
+    ageFileName = s->ReadSafeString();
+    spawnPoint = s->ReadSafeString();
+    fAvKey = mgr->ReadKey(s);
+}
+
+void plInputIfaceMgrMsg::Write(hsStream* s, hsResMgr* mgr)
+{
+    plMessage::IMsgWrite(s, mgr);
+
+    s->WriteLE(fCommand);
+    s->WriteLE(fPageID);
+    s->WriteSafeString(ageName);
+    s->WriteSafeString(ageFileName);
+    s->WriteSafeString(spawnPoint);
+    mgr->WriteKey(s, fAvKey);
 }

Sources/Plasma/PubUtilLib/plMessage/plInputIfaceMgrMsg.h

@@ -50,7 +50,6 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 #include "HeadSpin.h"
 #include "hsStream.h"
-#include "hsResMgr.h"
 #include "pnMessage/plMessage.h"
 #include "pnUUID/pnUUID.h"
 
@@ -97,27 +96,8 @@ class plInputIfaceMgrMsg : public plMessage
         CLASSNAME_REGISTER( plInputIfaceMgrMsg );
         GETINTERFACE_ANY( plInputIfaceMgrMsg, plMessage );
 
-        virtual void Read(hsStream* s, hsResMgr* mgr) 
+        virtual void Read(hsStream* s, hsResMgr* mgr);
-        { 
+        virtual void Write(hsStream* s, hsResMgr* mgr);
-            plMessage::IMsgRead( s, mgr ); 
-            s->ReadLE( &fCommand );
-            s->ReadLE( &fPageID );
-            ageName = s->ReadSafeString();
-            ageFileName = s->ReadSafeString();
-            spawnPoint = s->ReadSafeString();
-            fAvKey = mgr->ReadKey(s);
-        }
-        
-        virtual void Write(hsStream* s, hsResMgr* mgr) 
-        { 
-            plMessage::IMsgWrite( s, mgr ); 
-            s->WriteLE( fCommand );
-            s->WriteLE( fPageID );
-            s->WriteSafeString(ageName);
-            s->WriteSafeString(ageFileName);
-            s->WriteSafeString(spawnPoint);
-            mgr->WriteKey(s,fAvKey);
-        }
 
         void              SetAgeName(const plString& s) { ageName = s; }
         plString          GetAgeName() const { return ageName; }
@@ -129,11 +109,10 @@ class plInputIfaceMgrMsg : public plMessage
         const plUUID&     GetAgeInstanceGuid() const { return ageInstanceGuid; }
         uint8_t           GetCommand() const { return fCommand; }
         uint32_t          GetPageID() const { return fPageID; }
-        void                SetIFace( plInputInterface *iface );
+        void              SetIFace(plInputInterface *iface);
-        plInputInterface    *GetIFace() const { return fInterface; }
+        plInputInterface* GetIFace() const { return fInterface; }
-        plKey&      GetAvKey( void ) { return fAvKey; }
+        plKey             GetAvKey() const { return fAvKey; }
-        const plKey&    GetAvKey( void ) const { return fAvKey; }
+        void              SetAvKey(const plKey& k ) { fAvKey = k; }
-        void        SetAvKey( plKey& k ) { fAvKey = k; }
 };
 
 #endif // _plInputIfaceMgrMsg_h

Sources/Plasma/PubUtilLib/plMessage/plLOSHitMsg.cpp

@@ -40,19 +40,29 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 *==LICENSE==*/
 
-#include "HeadSpin.h"
+#include "hsResMgr.h"
+#include "hsStream.h"
+
 #include "plLOSHitMsg.h"
 
-plLOSHitMsg::plLOSHitMsg()
+void plLOSHitMsg::Read(hsStream* stream, hsResMgr* mgr)
 {
-    SetBCastFlag(plMessage::kPropagateToModifiers);
+    plMessage::IMsgRead(stream, mgr);
-    fHitFlags = 0;
+
+    fObj = mgr->ReadKey(stream);
+    fHitPoint.Read(stream);
+    fNoHit = stream->ReadBool();
+    stream->ReadLE(&fRequestID);
+    stream->ReadLE(&fHitFlags);
 }
-plLOSHitMsg::plLOSHitMsg(const plKey &s, 
+
-                const plKey &r, 
+void plLOSHitMsg::Write(hsStream* stream, hsResMgr* mgr)
-                const double* t)
-: plMessage(s, r, t)
 {
-    SetBCastFlag(plMessage::kPropagateToModifiers);
+    plMessage::IMsgWrite(stream, mgr);
-    fHitFlags = 0;
+
+    mgr->WriteKey(stream, fObj);
+    fHitPoint.Write(stream);
+    stream->WriteBool(fNoHit);
+    stream->WriteLE(fRequestID);
+    stream->WriteLE(fHitFlags);
 }

Sources/Plasma/PubUtilLib/plMessage/plLOSHitMsg.h

@@ -44,17 +44,11 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #define plLOSHitMsg_inc
 
 #include "pnMessage/plMessage.h"
-#include "hsStream.h"
-#include "hsResMgr.h"
 #include "hsGeometry3.h"
 
-
 class plLOSHitMsg : public plMessage
 {
-protected:
-
 public:
-    
     plKey               fObj;
     hsPoint3            fHitPoint;
     bool                fNoHit;
@@ -63,35 +57,21 @@ public:
     hsVector3           fNormal;
     float               fDistance;
 
-    plLOSHitMsg();
+    plLOSHitMsg() : fHitFlags(0) { SetBCastFlag(plMessage::kPropagateToModifiers); }
-    plLOSHitMsg(const plKey &s, 
+
-                    const plKey &r, 
+    plLOSHitMsg(const plKey& s, const plKey& r, const double* t) :
-                    const double* t);
+        fHitFlags(0),
-    ~plLOSHitMsg(){;}
+        plMessage(s, r, t)
+    {
+        SetBCastFlag(plMessage::kPropagateToModifiers);
+    }
 
     CLASSNAME_REGISTER( plLOSHitMsg );
     GETINTERFACE_ANY( plLOSHitMsg, plMessage );
 
     // IO
-    void Read(hsStream* stream, hsResMgr* mgr)
+    void Read(hsStream* stream, hsResMgr* mgr);
-    {
+    void Write(hsStream* stream, hsResMgr* mgr);
-        plMessage::IMsgRead(stream, mgr);
-        fObj = mgr->ReadKey(stream);
-        fHitPoint.Read(stream);
-        fNoHit = stream->ReadBool();
-        stream->ReadLE(&fRequestID);
-        stream->ReadLE(&fHitFlags);
-    }
-
-    void Write(hsStream* stream, hsResMgr* mgr)
-    {
-        plMessage::IMsgWrite(stream, mgr);
-        mgr->WriteKey(stream, fObj);
-        fHitPoint.Write(stream);
-        stream->WriteBool(fNoHit);
-        stream->WriteLE(fRequestID);
-        stream->WriteLE(fHitFlags);
-    }
 };
 
 

Sources/Plasma/PubUtilLib/plMessage/plLinkToAgeMsg.h

@@ -42,7 +42,6 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #ifndef plLinkToAgeMsg_INC
 #define plLinkToAgeMsg_INC
 
-#include "pnMessage/plMessageWithCallbacks.h"
 #include "pnMessage/plEventCallbackMsg.h"
 #include "plNetCommon/plNetServerSessionInfo.h"
 #include "plNetCommon/plNetCommonHelpers.h"

Sources/Plasma/PubUtilLib/plMessage/plNetCommMsgs.h

@@ -51,8 +51,8 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 
 #include "pnUtils/pnUtils.h"
 #include "pnNetBase/pnNetBase.h"
-#include "pnMessage/plMessage.h"
 #include "pnNetProtocol/pnNetProtocol.h"
+#include "pnMessage/plMessage.h"
 
 class plNetCommReplyMsg : public plMessage {
 public:

Sources/Plasma/PubUtilLib/plMessage/plResMgrHelperMsg.h

@@ -44,18 +44,18 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 #define _plResMgrHelperMsg_h
 
 #include "HeadSpin.h"
-#include "hsStream.h"
 #include "pnMessage/plMessage.h"
-#include "plResMgr/plResManagerHelper.h"
 
 class plResManagerHelper;
+class plResPageKeyRefList;
+
 class plResMgrHelperMsg : public plMessage
 {
 protected:
 
     friend class plResManagerHelper;
 
-    plResPageKeyRefList *fKeyList;
+    plResPageKeyRefList* fKeyList;
 
     uint8_t       fCommand;
 

Sources/Plasma/PubUtilLib/plMessage/plUniqueIdsMsg.h

@@ -1,41 +0,0 @@
-/*==LICENSE==*
-
-CyanWorlds.com Engine - MMOG client, server and tools
-Copyright (C) 2011  Cyan Worlds, Inc.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Additional permissions under GNU GPL version 3 section 7
-
-If you modify this Program, or any covered work, by linking or
-combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
-NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
-JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
-(or a modified version of those libraries),
-containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
-PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
-JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
-licensors of this Program grant you additional
-permission to convey the resulting work. Corresponding Source for a
-non-source form of such a combination shall include the source code for
-the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
-work.
-
-You can contact Cyan Worlds, Inc. by email legal@cyan.com
- or by snail mail at:
-      Cyan Worlds, Inc.
-      14617 N Newport Hwy
-      Mead, WA   99021
-
-*==LICENSE==*/

Sources/Plasma/PubUtilLib/plNetClient/plNetCliAgeLeaver.cpp

@@ -45,6 +45,8 @@ You can contact Cyan Worlds, Inc. by email legal@cyan.com
 *   
 ***/
 
+#include "hsResMgr.h"
+
 #include "plNetCliAgeLeaver.h"
 #include "plNetClientMgr.h"
 #include "plNetLinkingMgr.h"