module.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_WITCHER_MODULE_H
#define ENGINES_WITCHER_MODULE_H

#include <list>
#include <map>
#include <set>

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

#include "src/aurora/ifofile.h"

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

#include "src/events/types.h"

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

namespace Engines {

class Console;

namespace Witcher {

class Area;
class Creature;

class Module : public Witcher::Object, public Witcher::ObjectContainer {
public:
    Module(::Engines::Console &console);
    ~Module();

    // .--- Module management
    bool isLoaded() const;
    bool isRunning() const;
    // '---

    // .--- Information about the current module
    const Aurora::IFOFile &getIFO() const;

    const Aurora::LocString &getName() const;
    const Aurora::LocString &getDescription() const;
    // '---

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

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

    void delayScript(const Common::UString &script,
                     const Aurora::NWScript::ScriptState &state,
                     Aurora::NWScript::Object *owner, Aurora::NWScript::Object *triggerer,
                     uint32 delay);

    // .--- 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);
    void movePC(Area *area, float x, float y, float z);
    void movePC(const Common::UString &module, const Common::UString &object);
    void movedPC();
    // '---

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

    static Common::UString findModule(const Common::UString &module, bool relative);
    // '---

    // .--- Module main loop (called by the Campaign class)
    void clear();

    void load(const Common::UString &module, const Common::UString &entryLocation = "");
    void exit();

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

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

private:
    enum ActionType {
        kActionNone   = 0,
        kActionScript = 1
    };

    struct Action {
        ActionType type;

        Common::UString script;

        Aurora::NWScript::ScriptState state;
        Aurora::NWScript::ObjectReference owner;
        Aurora::NWScript::ObjectReference triggerer;

        uint32 timestamp;

        bool operator<(const Action &s) const;
    };

    typedef Common::PtrMap<Common::UString, Area> AreaMap;

    typedef std::list<Events::Event> EventQueue;
    typedef std::multiset<Action> ActionQueue;


    ::Engines::Console  *_console;

    bool _hasModule; 
    bool _running;   
    bool _exit;      

    Common::ChangeID _resModule;

    Aurora::IFOFile _ifo; 

    Creature *_pc;

    AreaMap         _areas;           
    Common::UString _newArea;         
    Area           *_currentArea;     

    Common::UString _module;    
    Common::UString _newModule; 

    Common::UString _entryLocation;

    EventQueue  _eventQueue;
    ActionQueue _delayedActions;


    // .--- Unloading
    void unload(); 

    void unloadModule();      
    void unloadPC();          
    void unloadAreas();       
    // '---

    // .--- Loading
    void loadAreas();       
    // '---

    void enterArea(); 

    void loadModule(const Common::UString &module, const Common::UString &entryLocation);
    void changeModule(const Common::UString &module, const Common::UString &entryLocation);
    void replaceModule();

    bool getObjectLocation(const Common::UString &object, Common::UString &area,
                           float &x, float &y, float &z, float &angle);
    bool getEntryObjectLocation(Common::UString &area,
                                float &entryX, float &entryY, float &entryZ, float &entryAngle);
    void getEntryIFOLocation(Common::UString &area,
                             float &entryX, float &entryY, float &entryZ, float &entryAngle);

    void handleEvents();

    void handleActions();
};

} // End of namespace Witcher

} // End of namespace Engines

#endif // ENGINES_WITCHER_MODULE_H