xoreos  0.0.5
nfofile.h
Go to the documentation of this file.
1 /* xoreos - A reimplementation of BioWare's Aurora engine
2  *
3  * xoreos is the legal property of its developers, whose names
4  * can be found in the AUTHORS file distributed with this source
5  * distribution.
6  *
7  * xoreos is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * xoreos is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
25 #ifndef AURORA_NFOFILE_H
26 #define AURORA_NFOFILE_H
27 
28 #include "src/aurora/gff3file.h"
29 
30 namespace Aurora {
31 
32 class NFOFile {
33 public:
35  ~NFOFile();
36 
38  const Common::UString &getPortrait0() const;
40  const Common::UString &getPortrait1() const;
42  const Common::UString &getPortrait2() const;
43 
45  uint32 getTimePlayed() const;
46 
48  const Common::UString &getSaveName() const;
50  const Common::UString &getAreaName() const;
51 
53  const Common::UString &getPCName() const;
54 
55 private:
56  void load(const GFF3Struct &top);
57 
59 
63 
67 };
68 
69 } // End of namespace Aurora
70 
71 #endif // AURORA_NFOFILE_H
Handling version V3.2/V3.3 of BioWare&#39;s GFFs (generic file format).
const Common::UString & getAreaName() const
Get the area name.
Definition: nfofile.cpp:64
const Common::UString & getPortrait2() const
Get the second companions portrait.
Definition: nfofile.cpp:52
const Common::UString & getPortrait1() const
Get the first companions portrait.
Definition: nfofile.cpp:48
uint32 _timePlayed
The time this save was actually played.
Definition: nfofile.h:58
A class holding an UTF-8 string.
Definition: ustring.h:48
void load(const GFF3Struct &top)
Definition: nfofile.cpp:72
uint32 getTimePlayed() const
Get the time played.
Definition: nfofile.cpp:56
NFOFile(Common::SeekableReadStream *stream)
Definition: nfofile.cpp:35
const Common::UString & getPortrait0() const
Get the player portrait.
Definition: nfofile.cpp:44
Common::UString _portrait2
The portrait of the second companion.
Definition: nfofile.h:66
Common::UString _portrait0
The portrait of the pc or solo companion.
Definition: nfofile.h:64
A struct within a GFF3.
Definition: gff3file.h:164
uint32_t uint32
Definition: types.h:204
Common::UString _saveName
The save name.
Definition: nfofile.h:60
Common::UString _areaName
The current area to load.
Definition: nfofile.h:61
const Common::UString & getSaveName() const
Get the area name.
Definition: nfofile.cpp:60
Interface for a seekable & readable data stream.
Definition: readstream.h:265
const Common::UString & getPCName() const
Get the pc name (kotor2 only).
Definition: nfofile.cpp:68
Common::UString _pcName
The name of the pc (kotor2 only).
Definition: nfofile.h:62
Common::UString _portrait1
The portrait of the first companion.
Definition: nfofile.h:65