World.h

Go to the documentation of this file.

/* Copyright (C) 2021 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. 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 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * File        : World.h
 * Project     : engine
 * Description : Contains the CWorld Class which contains all the entities and represents them at a specific moment in time.
 *
 **/
#ifndef INCLUDED_WORLD
#define INCLUDED_WORLD

#include "ps/CStrForward.h"
#include "ps/Errors.h"

#ifndef ERROR_GROUP_GAME_DEFINED
#define ERROR_GROUP_GAME_DEFINED
ERROR_GROUP(Game);
#endif
ERROR_SUBGROUP(Game, World);
ERROR_TYPE(Game_World, MapLoadFailed);

class CGame;
class CUnitManager;
class CTerrain;
class CMapReader;
class ScriptContext;

/**
 * CWorld is a general data class containing whatever is needed to accurately represent the world.
 * This includes the map, entities, influence maps, tiles, heightmap, etc.
 **/
class CWorld
{
    NONCOPYABLE(CWorld);
    /**
     * pointer to the CGame object representing the game.
     **/
    CGame *m_pGame;

    /**
     * pointer to the CTerrain object representing the height map.
     **/
    CTerrain *m_Terrain;

    /**
     * pointer to the CUnitManager that holds all the units in the world.
     **/
    CUnitManager *m_UnitManager;

    CMapReader* m_MapReader;

public:
    CWorld(CGame *pGame);
    ~CWorld();

    /*
    Initialize the World - load the map and all objects
    */
    void RegisterInit(const CStrW& mapFile, const ScriptContext& cx, JS::HandleValue settings, int playerID);

    /*
    Initialize the World - generate and load the random map
    */
    void RegisterInitRMS(const CStrW& scriptFile, const ScriptContext& cx, JS::HandleValue settings, int playerID);

    /**
     * Explicitly delete m_MapReader once the map has finished loading.
     **/
    int DeleteMapReader();

    /**
     * Get the pointer to the terrain object.
     *
     * @return CTerrain * the value of m_Terrain.
     **/
    inline CTerrain *GetTerrain()
    {   return m_Terrain; }

    /**
     * Get a reference to the unit manager object.
     *
     * @return CUnitManager & dereferenced m_UnitManager.
     **/
    inline CUnitManager &GetUnitManager()
    {   return *m_UnitManager; }
};

// rationale: see definition.
class CLightEnv;
extern CLightEnv g_LightEnv;

#endif