xoreos  0.0.5
waypoint.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 ENGINES_DRAGONAGE2_WAYPOINT_H
26 #define ENGINES_DRAGONAGE2_WAYPOINT_H
27 
28 #include "src/aurora/types.h"
29 #include "src/aurora/locstring.h"
30 
32 
33 namespace Engines {
34 
35 namespace DragonAge2 {
36 
37 class Waypoint : public Object {
38 public:
40  Waypoint(const Aurora::GFF3Struct &waypoint);
41  ~Waypoint();
42 
43  // Basic properties
44 
46  int32 getGroup() const;
47 
49  bool hasMapNote() const;
51  bool enabledMapNote() const;
52 
54  void enableMapNote(bool enabled);
55 
57  const Aurora::LocString &getMapNote() const;
58 
60  const Common::UString &getIcon() const;
61 
62 
63 private:
66 
67  bool _hasMapNote;
69 
72 
75 
78 
79 
80  void load(const Aurora::GFF3Struct &waypoint);
81 };
82 
83 } // End of namespace DragonAge2
84 
85 } // End of namespace Engines
86 
87 #endif // ENGINES_DRAGONAGE2_WAYPOINT_H
uint32 _type
Index into the Waypoints MGDA.
Definition: waypoint.h:74
A class holding an UTF-8 string.
Definition: ustring.h:48
A localized string.
Definition: locstring.h:43
bool enabledMapNote() const
Is the map note enabled?
Definition: waypoint.cpp:53
int32 getGroup() const
Return the ID of the group this waypoint belongs to.
Definition: waypoint.cpp:45
An object in a Dragon Age II area.
const Common::UString & getIcon() const
Return the icon representing the waypoint on the map.
Definition: waypoint.cpp:65
int32 _group
The ID of the group this waypoint belongs to.
Definition: waypoint.h:65
Common::UString _icon
The icon to show in the mini map for this waypoint.
Definition: waypoint.h:77
bool _hasMapNote
Does this waypoint have a map note?
Definition: waypoint.h:67
Waypoint(const Aurora::GFF3Struct &waypoint)
Load from a waypoint instance.
Definition: waypoint.cpp:38
const Aurora::LocString & getMapNote() const
Return the waypoint&#39;s map note text.
Definition: waypoint.cpp:61
Handling BioWare&#39;s localized strings.
Basic type definitions to handle files used in BioWare&#39;s Aurora engine.
bool hasMapNote() const
Does this waypoint have a map note?
Definition: waypoint.cpp:49
A struct within a GFF3.
Definition: gff3file.h:164
uint32_t uint32
Definition: types.h:204
bool _enabledMapNote
Is this waypoint&#39;s map note enabled?
Definition: waypoint.h:68
void enableMapNote(bool enabled)
Enable/Disable the waypoint&#39;s map note.
Definition: waypoint.cpp:57
void load(const Aurora::GFF3Struct &waypoint)
Definition: waypoint.cpp:69
Aurora::LocString _mapNote
The waypoint&#39;s map note text.
Definition: waypoint.h:71
int32_t int32
Definition: types.h:203