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_DRAGONAGE2_CAMPAIGN_H
#define ENGINES_DRAGONAGE2_CAMPAIGN_H

#include <vector>
#include <list>
#include <map>

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

#include "src/aurora/locstring.h"
#include "src/aurora/types.h"

#include "src/events/types.h"

#include "src/engines/aurora/resources.h"

#include "src/engines/dragonage2/objectcontainer.h"
#include "src/engines/dragonage2/object.h"

namespace Engines {

namespace DragonAge2 {

class Game;
class Area;
class Creature;

class Campaign : public DragonAge2::Object, public DragonAge2::ObjectContainer {
public:
    // .--- Static information
    const Common::UString &getUID() const;

    const Aurora::LocString &getName() const;
    const Aurora::LocString &getDescription() const;

    const Common::UString &getExtendsUID() const;

    bool isEnabled() const; 
    bool isBioWare() const; 
    bool needsAuth() const; 
    // '---

    // .--- Areas
    const Common::UString &getAreaRIM(const Common::UString &area) const;

    const std::vector<Common::UString> &getAreas() const;
    // '---

    // .--- Elements of the current campaign
    Area *getCurrentArea() const;
    Creature *getPC() const;
    // '---

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

    // .--- PC management
    void movePC(const Common::UString &area);
    void movePC(float x, float y, float z);
    void movePC(const Common::UString &area, float x, float y, float z);
    // '---

private:
    struct RIMNode {
        typedef Common::PtrVector<const RIMNode> Children;

        Common::UString tag;  
        Common::UString area; 

        Common::UString environment; 
        Common::UString rim;         
        Common::UString rimFXE;      

        const RIMNode *parent;
        Children children;

        RIMNode(const RIMNode *p = 0);
    };
    typedef std::map<Common::UString, const RIMNode *> AreaMap;

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


    Game *_game;

    Common::UString _uid;

    Common::UString _cifPath;
    Common::UString _addinBase;

    Aurora::LocString _name;
    Aurora::LocString _description;

    Common::UString _extends;

    bool _enabled;
    bool _bioware;
    bool _needsAuth;

    uint32 _priority;
    uint32 _format;
    uint32 _state;

    Common::UString _entryArea;
    Common::UString _entryAreaList;
    Common::UString _entryScript;
    Common::UString _entryClientScript;

    float _entryPosition[3];
    float _entryOrientation[3];

    std::vector<Common::UString> _packages;

    Common::ScopedPtr<RIMNode> _rimRoot;
    AreaMap _areaMap;

    std::vector<Common::UString> _areas;

    bool _loaded;

    ChangeList _resources;
    ChangeList _tlks;

    Creature *_pc;

    Common::UString _newArea; 
    Common::ScopedPtr<Area> _currentArea; 

    EventQueue _eventQueue;


    Campaign(Game &game, const Common::UString &cifPath = "",
             const Common::UString &manifestPath = "", const Common::UString &addinBase = "");
    ~Campaign();

    // .--- Loader
    void read(const Common::UString &cifPath, const Common::UString &manifestPath);
    void readCIFStatic(const Common::UString &path);
    RIMNode *readRIMs(const Aurora::GFF4Struct &node, const RIMNode *parent = 0);
    void readManifest(const Common::UString &path);

    void addAreaName(const RIMNode &node);

    void readCIFDynamic(const Common::UString &path);
    void loadResources();
    // '---

    // .--- Methods called by the Campaigns context
    void load();
    void unload();

    void enter(Creature &pc);
    void leave();

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

    void loadArea();
    void unloadArea();
    bool changeArea();

    void enterArea(bool startArea = false);
    void leaveArea();

    void handleEvents();
    // '---

    friend class Campaigns;

    template<typename T>
    friend void Common::DeallocatorDefault::destroy(T *);
};

} // End of namespace DragonAge2

} // End of namespace Engines

#endif // ENGINES_DRAGONAGE2_CAMPAIGN_H