campaign.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_NWN2_CAMPAIGN_H
#define ENGINES_NWN2_CAMPAIGN_H

#include <list>

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

#include "src/aurora/nwscript/variablecontainer.h"

#include "src/events/types.h"

namespace Engines {

class Console;

namespace NWN2 {

class Module;
class Creature;

class Campaign : public Aurora::NWScript::VariableContainer {
public:
    Campaign(::Engines::Console &console);
    ~Campaign();

    void clear();

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

    void load(const Common::UString &campaign);
    void loadModule(const Common::UString &module);
    void usePC(const Common::UString &bic, bool local);
    void exit();
    // '---

    // .--- Information about the current campaign
    const Common::UString &getName() const;
    const Common::UString &getDescription() const;
    // '---

    // .--- Elements of the current campaign
    Module &getModule();
    // '---

    // .--- Static utility methods
    static Common::UString getName(const Common::UString &campaign);
    static Common::UString getDescription(const Common::UString &campaign);
    // '---

    // .--- 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;

    bool _hasCampaign; 
    bool _running;     
    bool _exit;        

    Common::UString _name;
    Common::UString _description;

    std::list<Common::UString> _modules;
    Common::UString _startModule;

    Common::ChangeID _resCampaign;

    Common::ScopedPtr<Module> _module;

    Common::ScopedPtr<Creature> _pc;

    Common::UString _newCampaign;
    bool _newCampaignStandalone;

    EventQueue _eventQueue;


    void unload(bool completeUnload = true);

    void unloadPC();

    void loadCampaign(const Common::UString &campaign, bool standalone);
    void changeCampaign(const Common::UString &campaign, bool standalone);
    void replaceCampaign();

    void loadCampaignResource(const Common::UString &campaign);
    void setupStandaloneModule(const Common::UString &module);

    void handleEvents();


    static Common::UString getDirectory(const Common::UString &campaign, bool relative);
};

} // End of namespace NWN2

} // End of namespace Engines

#endif // ENGINES_NWN2_CAMPAIGN_H