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

#ifndef TOXID_GAME_PLANET_H
#define TOXID_GAME_PLANET_H

#include "Toxid.h"

namespace Toxid {

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

  class WorldScreen;
  class LoadingScreen;
  class GameScreen;
  class Map;

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

  /// <summary>Game world consisting of several map that can be played</summary>
  /// <remarks>
  ///   Planets are Toxid's concept of Episodes. Each planet contains a series of maps
  ///   and controls if, and in which order, these maps are visited by the player. Some
  ///   planets are built into the game, but it is possible for plugins to add their
  ///   own planets (which would be the approach to take for an add-on game)
  /// </remarks>
  class Planet {

    /// <summary>Immediately releases the resources used by a planet</summary>
    public: virtual ~Planet() {}
      
    //
    // Planet implementation
    //
    
    /// <summary>Creates a new world navigation screen</summary>
    /// <returns>
    ///   A new world navigation screen in which the player can choose which map to
    ///   visit next
    /// </returns>
    public: virtual shared_ptr<WorldScreen> createWorldScreen() = 0;

    /// <summary>Creates a new loading screen</summary>
    /// <returns>
    ///   A new loading screen that game displays while loading a map in this world
    /// </returns>
    public: virtual shared_ptr<LoadingScreen> createLoadingScreen() = 0;

    /// <summary>Creates the screen on which the game takes place</summary>
    /// <returns>A new game screen that the game will use for the in-game GUI</returns>
    public: virtual shared_ptr<GameScreen> createGameScreen() = 0;

    /// <summary>Creates / loads the map with the specified index</summary>
    /// <param name="Index">Index of the map to create</param>
    /// <returns>A new instance of the map with the specified index</returns>
    public: virtual shared_ptr<Map> createMap(size_t Index) = 0;

  };

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

} // namespace Toxid

#endif // TOXID_GAME_PLANET_H