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
|
/*
* 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/Tile.h
*/
#ifndef SIGMOD_TILE
#define SIGMOD_TILE
// Sigcore includes
#include <sigcore/Script.h>
// Sigmod includes
#include "Object.h"
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::Tile Tile.h sigmod/Tile.h
* \brief Class describing a tile.
*
* Tiles are static map objects. They can change their images, but not their position
* or size (determined by the initial image used for it). If a tile is set to be
* \p walkable, it can be walked over by objects (trainers, effects, and players).
* However, any transparent parts of the image used will never collide.
*/
class SIGMOD_EXPORT Tile : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param tile The tile to copy.
*/
Tile(const Tile& tile);
/**
* Create a new tile belonging to \p parent and id \p id.
*
* \param parent The parent of the tile.
* \param id The id number for the tile.
*/
Tile(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p tile as a child of \p parent with id \p id.
*
* \param tile The tile to copy the data from.
* \param parent The parent of the tile.
* \param id The id number for the tile.
*/
Tile(const Tile& tile, const Game* parent, const int id);
/**
* XML data constructor.
*
* \param xml The XML structure to extract the data from.
* \param parent The parent of the tile.
* \param id The id number for the tile.
*/
Tile(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the tile'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 tile in XML format.
*
* \return The XML structure representing the tile.
*/
QDomElement save() const;
/**
* Sets the name of the tile. This is only used internally.
*
* \param name The name of the tile.
*/
void setName(const QString& name);
/**
* Sets whether the tile can be walked through by objects or not.
*
* \param walkable Whether the tile can be walked through.
*/
void setWalkable(const bool walkable);
/**
* Sets the script for the tile. The following objects are available to the script:
*
* - \b tileinfo -- The \link Sigscript::TileWrapper wrapper \endlink for the tile.
* - \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 player is on.
* - \b tile -- The \link Sigworld::Tile tile \endlink the script controls.
*
* The \b tile object has a <i>entered(\link Sigencore::Player* \endlink)</i> signal which the script can connect to
* in order to interact with the player. In order to animate \b tile, it is recommended to use a \link QTimeLine \endlink
* in order to control the animation. Then, providing a function that converts accepts the frame number, set the corresponding
* sprite in \b tile.
*
* \param script The script for the tile.
*/
void setScript(const Sigcore::Script& script);
/**
* Sets the preview sprite for the tile. It is only used while editing maps.
*
* \param preview The id of the sprite.
*/
void setPreview(const int preview);
/**
* \sa setName
*
* \return The name of the tile.
*/
QString name() const;
/**
* \sa setWalkable
*
* \return Whether the til ecan be walked through or not.
*/
bool walkable() const;
/**
* \sa setScript
*
* \return The script for the tile.
*/
Sigcore::Script script() const;
/**
* \sa setPreview
*
* \return The sprite to use for a preview of the tile.
*/
int preview() const;
bool nameCheck(const QString& name) const;
bool walkableCheck(const bool walkable) const;
bool scriptCheck(const Sigcore::Script& script) const;
bool previewCheck(const int preview) const;
Tile& operator=(const Tile& rhs);
private:
QString m_name;
bool m_walkable;
Sigcore::Script m_script;
int m_preview;
};
}
#endif
|
