#pragma region Copyright
/*
Toxid Game
Copyright (C) 2002-2008 Nuclex Development Labs
*/
#pragma endregion

#ifndef TOXID_GAME_GAMESERVER_H
#define TOXID_GAME_GAMESERVER_H

#include "Toxid.h"
#include "Game/Player.h"

#include <Nuclex/Storage/Stream.h>

#include <map>

namespace Toxid {

  // ------------------------------------------------------------------------------------------- //

  class Map;
  class Planet;

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Responsible for keeping and updating the running game's state</summary>
  class GameServer {

    /// <summary>Enumerates a list of planets</summary>
    public: class PlanetEnumerator;
      
    /// <summary>Initializes a new game server</summary>
    public: GameServer() {}
    /// <summary>Releases all resourced owned by the game server</summary>
    public: ~GameServer() {}

    //
    // GameServer implementation
    //

    /// <summary>Adds a new planet to available planets the player can visit</summary>
    /// <param name="sName">Unique name of the planet to be added</param>
    /// <param name="spPlanet">Planet to add to the game</param>
    public: void addPlanet(const string &sName, const shared_ptr<Planet> &spPlanet);
    /// <summary>Removes all planets from the game</summary>
    public: void clearPlanets();
    /// <summary>
    ///   Returns an enumerator over all available planets (= episodes / add-ons)
    /// </summary>
    /// <returns>The new planet enumerator</returns>
    public: shared_ptr<PlanetEnumerator> enumPlanets();

    /// <summary>Starts a new game on the specified planet</summary>
    /// <param name="sPlanet">Planet the player wants to visit</param>
    public: void startGame(const string &sPlanet);
    /// <summary>Loads the game from the specified stream</summary>
    /// <param name="spSource">Stream from which to load the game's state</param>
    public: void loadGame(const shared_ptr<Storage::Stream> &spSource);
    /// <summary>Saves the game into the specified stream</summary>
    /// <param name="spDestination">Stream into which to write the game's state</param>
    public: void saveGame(const shared_ptr<Storage::Stream> &spDestination);
    /// <summary>Restarts the running game on the current map</summary>
    public: void restartMap();

    /// <summary>Returns the player instance</summary>
    /// <returns>The player instance</returns>
    public: Player &getPlayer() { return m_Player; }
    /// <summary>Returns the currently active map (may be NULL)</summary>
    /// <returns>The currently active map or NULL if no map is active</returns>
    public: const shared_ptr<Map> &getActiveMap() { return m_spActiveMap; }

    /// <summary>Map of visitable planets by their names</summary>
    private: typedef std::map<string, shared_ptr<Planet> > PlanetMap;
      
    /// <summary>All planets the player can visit (planet = episode or add-on)</summary>
    private: PlanetMap m_Planets;
    /// <summary>The player himself (stores the inventory, etc.)</summary>
    private: Player m_Player;
    /// <summary>Map currently being played</summary>
    private: shared_ptr<Map> m_spActiveMap;

  };

  // ------------------------------------------------------------------------------------------- //

} // namespace Toxid

#endif // TOXID_GAME_GAMESERVER_H