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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
* Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com>
*
* 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/>.
*/
/**
* \file sigmod/MapWarp.cpp
*/
#ifndef SIGMOD_MAPWARP
#define SIGMOD_MAPWARP
// Sigcore includes
#include <sigcore/Script.h>
// Sigmod includes
#include "Object.h"
// Qt includes
#include <QtCore/QRect>
namespace Sigmod
{
// Forward declarations
class Map;
/**
* \class Sigmod::MapWarp MapWarp.h sigmod/MapWarp.h
* \brief Class describing a warp on a map.
*
* Warps transport players from one map to another. Every map must have at least
* one warp (for access to it).
*/
class SIGMOD_EXPORT MapWarp : public Object
{
Q_OBJECT
Q_ENUMS(Type)
public:
/**
* \enum Type
* \brief The type of the warp (how animations are handled).
*/
enum Type
{
Door = 0,
Warp = 1,
Hole = 2,
Boundary = 3
};
/**
* \var TypeStr
* \brief String representations for the warp types.
*/
static const QStringList TypeStr;
/**
* Copy constructor.
*
* \param warp The warp to copy.
*/
MapWarp(const MapWarp& warp);
/**
* Create a new warp belonging to \p parent and id \p id.
*
* \param parent The parent of the warp.
* \param id The id number for the warp.
*/
MapWarp(const Map* parent, const int id);
/**
* Data copy constructor. Copies the data from \p warp as a child of \p parent with id \p id.
*
* \param warp The warp to copy the data from.
* \param parent The parent of the warp.
* \param id The id number for the warp.
*/
MapWarp(const MapWarp& warp, const Map* parent, const int id);
/**
* XML data constructor.
*
* \param xml The XML structure to extract the data from.
* \param parent The parent of the ability.
* \param id The id number for the ability.
*/
MapWarp(const QDomElement& xml, const Map* parent, const int id = -1);
/**
* Check to make sure the warp's values are valid.
* \note This does not check the scripts for validity.
*/
void validate();
/**
* Load data from XML.
*
* \param xml The XML structure to extract data from.
*/
void load(const QDomElement& xml);
/**
* Get the data for the warp in XML format.
*
* \return The XML structure representing the warp.
*/
QDomElement save() const;
/**
* Sets the name of the warp. This is only used internally.
*
* \param name The name of the warp.
*/
void setName(const QString& name);
/**
* Sets the area of the map the warp takes up.
*
* \param area The area of the map the warp takes up.
*/
void setArea(const QRect& area);
/**
* Sets the type of the warp.
*
* \param type The type of the warp.
*/
void setType(const Type type);
/**
* Sets the id of the target map of the warp.
*
* \param toMap The id of the target map.
*/
void setToMap(const int toMap);
/**
* Sets the id of the target warp on the target map.
*
* \param toWarp The id of the target warp on the target map.
*/
void setToWarp(const int toWarp);
/**
* Sets the script for the warp. This script controls the behavior of the warp
* and whether it is activated or not. The following objects are available
* to the script:
*
* - \b client -- The \link Sigencore::Client client \endlink which entered the warp.
* - \b sigmod -- The \link Sigscript::SigmodWrapper wrapper \endlink for the \link Sigmod sigmod \endlink in use.
* - \b world -- The \link Sigworld::Map map \endlink for the \link Map map \endlink the \b client is on.
*
* \param script The script for the warp.
*/
void setScript(const Sigcore::Script& script);
/**
* \sa setName
*
* \return The name of the warp.
*/
QString name() const;
/**
* \sa setArea
*
* \return The area that the warp takes up.
*/
QRect area() const;
/**
* \sa setType
*
* \return The type of the warp.
*/
Type type() const;
/**
* \sa setToMap
*
* \return The id of the target map of the warp.
*/
int toMap() const;
/**
* \sa setToWarp
*
* \return The id of the target warp on the target map.
*/
int toWarp() const;
/**
* \sa setScript
*
* \return The script that controls the warp.
*/
Sigcore::Script script() const;
bool nameCheck(const QString& name) const;
bool areaCheck(const QRect& area) const;
bool typeCheck(const Type type) const;
bool toMapCheck(const int toMap) const;
bool toWarpCheck(const int toWarp) const;
bool scriptCheck(const Sigcore::Script& script) const;
MapWarp& operator=(const MapWarp& rhs);
private:
QString m_name;
QRect m_area;
Type m_type;
int m_toMap;
int m_toWarp;
Sigcore::Script m_script;
};
}
Q_DECLARE_METATYPE(Sigmod::MapWarp::Type)
#endif
|
