/*==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/>.

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 plNetSharedState_inc
#define plNetSharedState_inc

#include "hsTypes.h"
#include "hsUtils.h"
#include "hsStlUtils.h"

class hsStream;

//
// used to exchange generic state with the server
//
class plGenericVar;
class plNetSharedState
{
protected:
    std::string fName;
    std::vector<plGenericVar*> fVars;
    bool    fServerMayDelete;   // ok to delete (don't save) since this state is equivalent to the default state
public:
    
    plNetSharedState(const char* name=nil);
    virtual ~plNetSharedState();

    virtual void Copy(plNetSharedState* ss);
    void Reset();
    
    int GetNumVars() const { return fVars.size(); }
    plGenericVar* GetVar(int i) const { return fVars[i]; }
    
    void RemoveVar(int i) { fVars.erase(fVars.begin()+i); }
    void AddVar(plGenericVar* v)    { fVars.push_back(v); }
    
    const char* GetName() const     { return fName.c_str(); }
    void  SetName(const char* n)    { if (n) fName=n; }

    bool GetServerMayDelete() const { return fServerMayDelete;  }
    void SetServerMayDelete(bool d) { fServerMayDelete=d;   }

    // IO 
    virtual void Read(hsStream* stream);
    virtual void Write(hsStream* stream);
};

#endif // plNetSharedState_inc