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_KOTOR_MODULE_H
#define ENGINES_KOTOR_MODULE_H

#include <list>
#include <set>

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

#include "src/aurora/ifofile.h"

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

#include "src/graphics/aurora/fadequad.h"

#include "src/events/types.h"

#include "src/engines/kotor/objectcontainer.h"
#include "src/engines/kotor/object.h"
#include "src/engines/kotor/savedgame.h"

namespace Engines {

class Console;

namespace KotOR {

class Area;
class Creature;
class IngameGUI;
class DialogGUI;
class PartySelectionGUI;

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

    void clear();

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

    void load(const Common::UString &module, const Common::UString &entryLocation = "",
              ObjectType entryLocationType = kObjectTypeAll);
    void loadTexturePack();
    void usePC(Creature *pc);
    void exit();
    // '---

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

    const Common::UString &getName() const;
    // '---

    // .--- Elements of the current module
    Area *getCurrentArea();
    Creature *getPC();
    Graphics::Aurora::FadeQuad &getFadeQuad();
    // '---

    // .--- Interact with the current module
    void showMenu();
    // '---

    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(float x, float y, float z);
    void movePC(const Common::UString &module, const Common::UString &object, ObjectType type = kObjectTypeAll);
    void movedPC();
    // '---

    // .--- Party Management
    size_t getPartyMemberCount();
    void addToParty(Creature *creature);
    bool isObjectPartyMember(Creature *creature);
    Creature *getPartyMember(int index);
    void switchPlayerCharacter(int npc);
    void showPartySelectionGUI(int forceNPC1, int forceNPC2);
    void addAvailablePartyMember(int slot, const Common::UString &templ);
    bool isAvailableCreature(int slot);
    // '---

    // .--- Gui management
    void setReturnStrref(uint32 id);
    void setReturnQueryStrref(uint32 id);
    void setReturnEnabled(bool enabled);
    // '---

    // .--- Global values
    void setGlobalBoolean(const Common::UString &id, bool value);
    bool getGlobalBoolean(const Common::UString &id) const;
    void setGlobalNumber(const Common::UString &id, int value);
    int getGlobalNumber(const Common::UString &id) const;
    // '---

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

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

    void clickObject(Object *object);

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

    void toggleFreeRoamCamera();
    void toggleWalkmesh();
    void toggleTriggers();
    void loadSavedGame(SavedGame *save);
    void startConversation(const Common::UString &name, Aurora::NWScript::Object *owner = 0);

    void playAnimationOnActiveObject(const Common::UString &baseAnim,
                                     const Common::UString &headAnim);

    void addItemToActiveObject(const Common::UString &item, int count);

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 std::list<Events::Event> EventQueue;
    typedef std::multiset<Action> ActionQueue;


    ::Engines::Console *_console;

    bool _hasModule; 
    bool _running;   

    std::list<Common::ChangeID> _resources;

    Aurora::IFOFile _ifo;

    Common::ScopedPtr<Creature> _pc; 

    int _currentTexturePack;
    Common::ChangeID _textures;

    bool _exit; 

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

    Common::UString _entryLocation;
    ObjectType      _entryLocationType;

    Common::ScopedPtr<Area> _area; 

    Common::ScopedPtr<Graphics::Aurora::FadeQuad> _fade;

    Common::ScopedPtr<IngameGUI> _ingame; 

    Common::ScopedPtr<DialogGUI> _dialog; 

    Common::ScopedPtr<PartySelectionGUI> _partySelection;

    // .--- Global values
    std::map<Common::UString, bool> _globalBooleans;
    std::map<Common::UString, int> _globalNumbers;
    // '---

    // .--- Party
    std::list<Creature *> _party;
    std::map<int, Common::UString> _availableParty;
    // '---

    EventQueue  _eventQueue;
    ActionQueue _delayedActions;

    bool _freeCamEnabled;
    uint32 _prevTimestamp;
    float _frameTime;
    float _forwardBtnPressed;
    float _backwardsBtnPressed;
    bool _pcRunning;
    bool _pcPositionLoaded;
    bool _inDialog;
    float _cameraHeight;


    // .--- Unloading
    void unload(bool completeUnload = true);

    void unloadResources();
    void unloadPC();
    void unloadIFO();
    void unloadArea();
    void unloadTexturePack();
    // '---

    // .--- Loading
    void load();

    void loadResources();
    void loadIFO();
    void loadArea();
    // '---

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

    bool getObjectLocation(const Common::UString &object, ObjectType location,
                           float &entryX, float &entryY, float &entryZ, float &entryAngle);
    bool getEntryObjectLocation(float &entryX, float &entryY, float &entryZ, float &entryAngle);
    void getEntryIFOLocation(float &entryX, float &entryY, float &entryZ, float &entryAngle);

    void enterArea();
    void leaveArea();

    void handleEvents();

    void handleActions();
    void handlePCMovement();

    void stopCameraMovement();
    void stopPCMovement();
};

} // End of namespace KotOR

} // End of namespace Engines

#endif // ENGINES_KOTOR_MODULE_H