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
|
/*
* 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/SpeciesMove.h
*/
#ifndef SIGMOD_SPECIESMOVE
#define SIGMOD_SPECIESMOVE
// Sigmod includes
#include "Object.h"
namespace Sigmod
{
// Forward declarations
class Species;
/**
* \class Sigmod::SpeciesMove SpeciesMove.h sigmod/SpeciesMove.h
* \brief Class that gives species the ability to learn moves.
*
* Moves that can be learned must be in the species' move list, which is created by
* creating an instance of this class for each move. Moves that have both level and wild
* set to -1 can be learned, but not through traditional methods (e.g. items, tutors, or
* breeding).
*/
class SIGMOD_EXPORT SpeciesMove : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param move The move to copy.
*/
SpeciesMove(const SpeciesMove& move);
/**
* Create a new move belonging to \p parent and id \p id.
*
* \param parent The parent of the move.
* \param id The id number for the move.
*/
SpeciesMove(const Species* parent, const int id);
/**
* Data copy constructor. Copies the data from \p move as a child of \p parent with id \p id.
*
* \param move The move to copy the data from.
* \param parent The parent of the move.
* \param id The id number for the move.
*/
SpeciesMove(const SpeciesMove& move, const Species* parent, const int id);
/**
* XML data constructor.
*
* \param xml The XML structure to extract the data from.
* \param parent The parent of the move.
* \param id The id number for the move.
*/
SpeciesMove(const QDomElement& xml, const Species* parent, const int id = -1);
/**
* Check to make sure the move's values are valid.
*/
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 move in XML format.
*
* \return The XML structure representing the move.
*/
QDomElement save() const;
/**
* Sets the id of the move that can be learned.
*
* \param move The id of the move that is learned.
*/
void setMove(const int move);
/**
* Sets the level at which the move is learned when leveled up by a trainer. If set to -1,
* it cannot be learned by leveling up.
*
* \param level The level at which the move is learned normally.
*/
void setLevel(const int level);
/**
* Sets the level at which the move is learned in the wild. This is used to allow randomly
* encountered creatures to have moves that would normally not be allowed until higher level
* or at all. If set to -1, it cannot be learned in the wild.
*
* \param wild The level at which the move is learned in the wild.
*/
void setWild(const int wild);
/**
* \sa setMove
*
* \return The id of the move that is learned.
*/
int move() const;
/**
* \sa setLevel
*
* \return The level at which the move is learned at when captured.
*/
int level() const;
/**
* \sa setWild
*
* \return The level at which the move is learned at in the wild.
*/
int wild() const;
bool moveCheck(const int move) const;
bool levelCheck(const int level) const;
bool wildCheck(const int wild) const;
SpeciesMove& operator=(const SpeciesMove& rhs);
private:
int m_move;
int m_level;
int m_wild;
};
}
#endif
|
