ifofile.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_IFOFILE_H
#define AURORA_IFOFILE_H

#include <vector>

#include <boost/noncopyable.hpp>

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

#include "src/aurora/locstring.h"

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {

class GFF3File;
class GFF3Struct;

class IFOFile : boost::noncopyable {
public:
    IFOFile();
    ~IFOFile();

    void load(Common::SeekableReadStream *stream, bool repairNWNPremium = false);
    void load(bool repairNWNPremium = false);
    void unload();

    const GFF3Struct *getGFF() const;

    // .--- General properties
    uint32 getVersion() const;
    uint32 getCreatorID() const;

    bool isSave() const; 

    const Common::UString &getTag() const;

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

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

    // .--- Module requirements
    void getMinVersion(int &major, int &minor) const;

    uint16 getExpansions() const;

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

    // .--- Entry behaviour
    const Common::UString &getStartMovie() const;

    const Common::UString &getEntryArea() const;
    void getEntryPosition (float &x, float &y, float &z) const;
    void getEntryDirection(float &x, float &y) const;
    // '---

    // .--- Module elements
    const std::vector<Common::UString> &getAreas() const;
    const std::vector<Common::UString> &getNSSCache() const;

    const std::vector<Common::UString> &getQuests() const;
    const std::vector<Common::UString> &getQuestDBs() const;

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

    // .--- Time management
    void getStartTime(uint8 &hour, uint8 &day, uint8 &month, uint32 &year) const;

    uint8 getDawnHour() const; 
    uint8 getDuskHour() const; 

    uint32 getMinutesPerHour() const;
    // '---

    // .--- Weather
    int32 getMinWeatherIntensity() const;
    int32 getMaxWeatherIntensity() const;
    int32 getRainChance() const;
    int32 getSnowChance() const;
    // '---

    // .--- Combat behaviour
    float getXPScale() const;
    // '---

private:
    Common::ScopedPtr<GFF3File> _gff; 

    byte _id[32]; 

    Common::UString _tag; 

    LocString _name;        
    LocString _description; 

    uint32 _version;   
    uint32 _creatorID; 

    int _minVersionMajor; 
    int _minVersionMinor; 

    uint16 _expansions; 

    bool _isSave; 

    Common::UString  _customTLK; 

    Common::UString _startMovie; 

    Common::UString _entryArea; 

    float _entryX;    
    float _entryY;    
    float _entryZ;    
    float _entryDirX; 
    float _entryDirY; 

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

    std::vector<Common::UString> _quests;   
    std::vector<Common::UString> _questDBs; 

    std::vector<Common::UString> _storyNPCs;   
    std::vector<Common::UString> _monsterNPCs; 

    uint8 _hourDawn; 
    uint8 _hourDusk; 

    uint8 _minutesPerHour; 

    uint8  _startHour;  
    uint8  _startDay;   
    uint8  _startMonth; 
    uint32 _startYear;  

    int32 _minWeatherIntensity; 
    int32 _maxWeatherIntensity; 
    int32 _rainChance;          
    int32 _snowChance;          

    float _xpScale; 

    void clear();

    void parseVersion(const Common::UString &version);
};

} // End of namespace Aurora

#endif // AURORA_IFOFILE_H