1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef ULTIMA4_MAP_ANNOTATION_H
#define ULTIMA4_MAP_ANNOTATION_H
#include "ultima/ultima4/core/coords.h"
#include "ultima/ultima4/core/types.h"
#include "ultima/ultima4/map/map_tile.h"
#include "common/list.h"
namespace Ultima {
namespace Ultima4 {
class Annotation;
/**
* Annotation are updates to a map.
* There are three types of annotations:
* - permanent: lasts until annotationClear is called
* - turn based: lasts a given number of cycles
* - time based: lasts a given number of time units (1/4 seconds)
*/
class Annotation {
public:
typedef Common::List<Annotation> List;
Annotation(const Coords &coords, MapTile tile, bool visual = false, bool coverUp = false);
void debug_output() const;
// Getters
/**
* Returns the coordinates of the annotation
*/
const Coords &getCoords() const {
return _coords;
}
/**
* Returns the annotation's tile
*/
MapTile &getTile() {
return _tile;
}
/**
* Returns true for visual-only annotations
*/
bool isVisualOnly() const {
return _visual;
}
/**
* Returns the number of turns the annotation has left to live
*/
int getTTL() const {
return _ttl;
}
bool isCoverUp() const {
return _coverUp;
}
// Setters
/**
* Sets the coordinates for the annotation
*/
void setCoords(const Coords &c) {
_coords = c;
}
/**
* Sets the tile for the annotation
*/
void setTile(const MapTile &t) {
_tile = t;
}
/**
* Sets whether or not the annotation is visual-only
*/
void setVisualOnly(bool v) {
_visual = v;
}
/**
* Sets the number of turns the annotation will live
*/
void setTTL(int turns) {
_ttl = turns;
}
/**
* Passes a turn for the annotation
*/
void passTurn() {
if (_ttl > 0) _ttl--;
}
bool operator==(const Annotation &) const;
// Properties
private:
Coords _coords;
MapTile _tile;
bool _visual;
int _ttl;
bool _coverUp;
};
/**
* Manages annotations for the current map. This includes
* adding and removing annotations, as well as finding annotations
* and managing their existence.
*/
class AnnotationMgr {
public:
AnnotationMgr();
/**
* Adds an annotation to the current map
*/
Annotation *add(Coords coords, MapTile tile, bool visual = false, bool isCoverUp = false);
/**
* Returns all annotations found at the given map coordinates
*/
Annotation::List allAt(Coords pos);
/**
* Returns pointers to all annotations found at the given map coordinates
*/
Common::List<Annotation *> ptrsToAllAt(Coords pos);
/**
* Removes all annotations on the map
*/
void clear();
/**
* Passes a turn for annotations and removes any
* annotations whose TTL has expired
*/
void passTurn();
/**
* Removes an annotation from the current map
*/
void remove(Coords pos, MapTile tile);
void remove(Annotation &);
/**
* Removes an entire list of annotations
*/
void remove(Annotation::List);
/**
* Returns the number of annotations on the map
*/
int size() const;
private:
Annotation::List _annotations;
Annotation::List::iterator _it;
};
} // End of namespace Ultima4
} // End of namespace Ultima
#endif
|
