blob: ce85833a38ea0dd7d32d1a7ed082857e0f3b6cfd (
plain)
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
|
/*
* 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/Type.h
*/
#ifndef SIGMOD_TYPE
#define SIGMOD_TYPE
// Sigcore includes
#include <sigcore/Fraction.h>
// Sigmod includes
#include "Object.h"
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::Type Type.h sigmod/Type.h
* \brief Types label species and moves.
*
* Types allow for grouping of moves and species for effectiveness or
* other effects (e.g. a move using water may put out a fire).
*/
class SIGMOD_EXPORT Type : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param type The type to copy.
*/
Type(const Type& type);
/**
* Create a new type belonging to \p parent and id \p id.
*
* \param parent The parent of the type.
* \param id The id number for the type.
*/
Type(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p type as a child of \p parent with id \p id.
*
* \param type The type to copy the data from.
* \param parent The parent of the type.
* \param id The id number for the type.
*/
Type(const Type& type, 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 type.
* \param id The id number for the type.
*/
Type(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the type'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 type in XML format.
*
* \return The XML structure representing the type.
*/
QDomElement save() const;
/**
* Sets the name of the type.
*
* \param name The name of the type.
*/
void setName(const QString& name);
/**
* Sets the STAB (Same Type Attack Bnus) for the type. When a species that has this type
* uses a move of the same type, it gets a bonus multiplier.
*
* \param stab the STAB of the type.
*/
void setStab(const Sigcore::Fraction& stab);
/**
* \sa setName
*
* \return The name of the type.
*/
QString name() const;
/**
* \sa setStab
*
* \return The STAB of the type.
*/
Sigcore::Fraction stab() const;
bool nameCheck(const QString& name) const;
bool stabCheck(const Sigcore::Fraction& stab) const;
Type& operator=(const Type& rhs);
private:
QString m_name;
Sigcore::Fraction m_stab;
};
}
#endif
|
