dlgfile.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 AURORA_DLGFILE_H
#define AURORA_DLGFILE_H

#include <vector>

#include <boost/noncopyable.hpp>

#include "src/common/types.h"
#include "src/common/ustring.h"

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

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {

namespace NWScript {
    class Object;
}

// TODO: KotOR:
//       - "ConversationType", "StuntList", "Skippable", "AmbientTrack",
//         "AnimatedCut", ...
//       - Sound resrefs in field "VO_ResRef"
//       - Quest IDs in field "PlotIndex"
//       - Camera: "CameraModel", "CameraAngle", "CameraID", "CamVidEffect", "FadeType"
// TODO: KotOR2:
//       - "Emotion", "FacialAnim"
//       - 2 scripts, with params:
//         "Script{,2}"; "ActionParam[1-5]{,b}", "ActionParamStr{A,B}"
//       - 2 active test scripts, with params and bool operators (not, and/or)
//         "Active{,2}"; "Param[1-5]{,b}", "ParamStr{A,B}"
//         "Not{,2}", "Logic"

class DLGFile : boost::noncopyable {
public:
    static const uint32 kEndLine     = 0xFFFFFFFE;
    static const uint32 kInvalidLine = 0xFFFFFFFF;

    struct Line {
        uint32 id; 

        Common::UString speaker; 
        LocString       text;    

        Common::UString sound; 
        Common::UString voice; 

        uint32 animation; 

        Common::UString quest;      
        uint32          questEntry; 

        bool isEnd; 
    };


    DLGFile(Common::SeekableReadStream *dlg, NWScript::Object *owner = 0, bool repairNWNPremium = false);
    DLGFile(const Common::UString &dlg, NWScript::Object *owner = 0, bool repairNWNPremium = false);
    ~DLGFile();

    bool getNoZoomIn() const;

    uint32 getDelayEntry() const;
    uint32 getDelayReply() const;

    bool hasEnded() const;

    void startConversation();
    void abortConversation();

    void pickReply(uint32 id);

    const Line *getCurrentEntry() const;
    const std::vector<const Line *> &getCurrentReplies() const;

    const Line *getOneLiner() const;

private:
    struct Link {
        uint32 index;           
        Common::UString active; 
    };

    struct Entry {
        bool isPC; 

        Common::UString script; 

        Line line; 

        std::vector<Link> replies; 
    };


    NWScript::Object *_owner;

    uint32 _delayEntry; 
    uint32 _delayReply; 

    Common::UString _convAbort; 
    Common::UString _convEnd;   

    bool _noZoomIn; 

    std::vector<Entry> _entriesNPC; 
    std::vector<Entry> _entriesPC;  

    std::vector<Link> _entriesStart; 

    std::vector<Entry>::iterator _currentEntry; 
    std::vector<const Line *> _currentReplies;  

    bool _ended; 


    void load(const GFF3Struct &dlg);

    void readEntries(const GFF3List &list, std::vector<Entry> &entries, bool isPC);
    void readLinks(const GFF3List &list, std::vector<Link> &links);

    void readEntry(const GFF3Struct &gff, Entry &entry);
    void readLink(const GFF3Struct &gff, Link &link);

    bool evaluateEntries(const std::vector<Link> &entries,
                         std::vector<Entry>::iterator &active);
    bool evaluateReplies(const std::vector<Link> &entries,
                         std::vector<const Line *> &active);

    bool runScript(const Common::UString &script) const;
};

} // End of namespace Aurora

#endif // AURORA_DLGFILE_H