campaigns.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_DRAGONAGE_CAMPAIGNS_H
#define ENGINES_DRAGONAGE_CAMPAIGNS_H

#include <vector>
#include <list>

#include "src/common/scopedptr.h"
#include "src/common/ptrvector.h"
#include "src/common/ustring.h"

#include "src/events/types.h"

namespace Engines {

class Console;

namespace DragonAge {

class Game;
class Campaign;
class Creature;

class Campaigns {
public:
    Campaigns(::Engines::Console &console, Game &game);
    ~Campaigns();

    // .--- Available campaigns and addins
    typedef Common::PtrVector<Campaign> PlayableCampaigns;
    typedef Common::PtrVector<Campaign> AddinContent;

    const PlayableCampaigns &getCampaigns() const;
    const AddinContent &getAddins() const;

    const Campaign *findCampaign(const Common::UString &uid) const;
    const Campaign *findAddin(const Common::UString &uid) const;
    // '---

    // .--- Campaign management
    bool isLoaded() const;
    bool isRunning() const;

    void load(const Campaign &campaign);
    void usePC(Creature *pc);
    void exit();
    void unload();
    // '---

    // .--- The current campaign
    Campaign *getCurrentCampaign() const;
    Creature *getPC() const;
    // '---

    // .--- Interact with the current campaign
    void refreshLocalized();
    // '---

    // .--- Campaign main loop (called by the Game class)
    void enter();
    void leave();

    void addEvent(const Events::Event &event);
    void processEventQueue();
    // '---

private:
    typedef std::list<Events::Event> EventQueue;


    ::Engines::Console *_console;
    Game *_game;

    bool _hasCampaign; 
    bool _running;     
    bool _exit;        

    PlayableCampaigns _campaigns;
    AddinContent _addins;

    Campaign *_currentCampaign;

    Common::ScopedPtr<Creature> _pc;

    Common::UString _newCampaign;

    EventQueue _eventQueue;


    void clean();

    void unload(bool completeUnload);

    void unloadPC();

    void loadCampaign(const Campaign &campaign);
    void changeCampaign(const Campaign &campaign);
    void replaceCampaign();

    void findCampaigns();
    void addCampaign(Campaign *campaign);
    Campaign *readCampaign(const Common::UString &cifPath = "", const Common::UString &manifestPath = "",
                           const Common::UString &addinBase = "");

    Campaign *getCampaign(const Common::UString &uid);
    Campaign *getAddin(const Common::UString &uid);

    void handleEvents();
};

} // End of namespace DragonAge

} // End of namespace Engines

#endif // ENGINES_DRAGONAGE_CAMPAIGNS_H