CWE-ou-minkata/Sources/Plasma/PubUtilLib/plMessage/plLoadAgeMsg.h

/*==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==*/
#ifndef plLoadAgeMsg_INC
#define plLoadAgeMsg_INC

#include "pnMessage/plMessage.h"
#include "pnUUID/pnUUID.h"
#include "plString.h"


//
// A msg which is sent to the networking system to cause an age to be loaded or unloaded
//
class plKey;
class hsStream;
class hsResMgr;
class plLoadAgeMsg : public plMessage
{
protected:
    plString fAgeFilename;             // the age to load/unload
    plUUID fAgeGuid;
    bool fUnload;         // true if we want to unload the age
    int fPlayerID;
public:
    plLoadAgeMsg() : fUnload(false), fPlayerID(-1) { }

    CLASSNAME_REGISTER( plLoadAgeMsg );
    GETINTERFACE_ANY( plLoadAgeMsg, plMessage );

    void SetAgeFilename(const plString& a) { fAgeFilename = a; }
    plString GetAgeFilename() const { return fAgeFilename; }

    void SetAgeGuid( const plUUID * v ) { fAgeGuid.CopyFrom( v ); }
    const plUUID * GetAgeGuid() const { return &fAgeGuid; }

    void SetLoading(bool l) { fUnload=!l; }
    bool GetLoading() const { return !fUnload; }

    void SetPlayerID(int p) { fPlayerID=p; }
    int GetPlayerID() const { return fPlayerID; }
    
    // IO 
    void Read(hsStream* stream, hsResMgr* mgr);
    void Write(hsStream* stream, hsResMgr* mgr);

    void ReadVersion(hsStream* s, hsResMgr* mgr);
    void WriteVersion(hsStream* s, hsResMgr* mgr);
};

//
// Internal msg, sent by NetClientMgr to unload an age when linking out.
// Should not be used for other purposes
//
class plLinkOutUnloadMsg : public plLoadAgeMsg
{
public:
    plLinkOutUnloadMsg() { fUnload=true; }

    CLASSNAME_REGISTER( plLinkOutUnloadMsg );
    GETINTERFACE_ANY( plLinkOutUnloadMsg, plLoadAgeMsg );   
};

//
// Internal msg, used by NetClientMgr. 
// (we send another to the avatar that linked)
// Not meant to go over the wire.
//
class plLinkInDoneMsg : public plMessage
{
public:

    CLASSNAME_REGISTER( plLinkInDoneMsg );
    GETINTERFACE_ANY( plLinkInDoneMsg, plMessage ); 

    void Read(hsStream* stream, hsResMgr* mgr) { IMsgRead(stream, mgr); }
    void Write(hsStream* stream, hsResMgr* mgr) { IMsgWrite(stream, mgr);   }

    void ReadVersion(hsStream* stream, hsResMgr* mgr) { IMsgRead(stream, mgr);  };
    void WriteVersion(hsStream* stream, hsResMgr* mgr) {  IMsgWrite(stream, mgr);   };

};

#endif      // plLoadAgeMsg