blob: 2e9f496667f1554e14ec2e6a431b37421b0f0b4b (
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
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
|
/*
* 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/CoinList.h
*/
#ifndef SIGMOD_COINLIST
#define SIGMOD_COINLIST
// Sigcore includes
#include <sigcore/Script.h>
// Sigmod includes
#include "Object.h"
// Qt includes
#include <QtCore/QList>
namespace Sigmod
{
// Forward declarations
class CoinListItem;
class Game;
/**
* \class Sigmod::CoinList CoinList.h sigmod/CoinList.h
* \brief A coin list contains a list of items that can be bought using coins.
*
* The difference between a coin list and a \link Store store \endlink is that team members
* cannot be bought at stores. Since money is typically easier to come by than coins are,
* things that appear in a coin list tend to be rare and valuable.
*/
class SIGMOD_EXPORT CoinList : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param coinList The coin list to copy.
*/
CoinList(const CoinList& coinList);
/**
* Create a new coin list belonging to \p parent and id \p id.
*
* \param parent The parent of the coin list.
* \param id The id number for the coin list.
*/
CoinList(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p coinList as a child of \p parent with id \p id.
*
* \param coinList The coin list to copy the data from.
* \param parent The parent of the coin list.
* \param id The id number for the coin list.
*/
CoinList(const CoinList& coinList, 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 coin list.
* \param id The id number for the coin list.
*/
CoinList(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Destructor.
*/
~CoinList();
/**
* Check to make sure the coin list's values are valid.
* \note This does not check the script 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 coin list in XML format.
*
* \return The XML structure representing the coin list.
*/
QDomElement save() const;
/**
* Sets the name of the coin list. This is only used internally.
*
* \param name The name of the coin list.
*/
void setName(const QString& name);
/**
* Sets the script that controls the list of items and purchasing of them. The following
* objects are provided to the script:
*
* - \b list -- The instance of the \link Sigscript::CoinListWrapper coin list \endlink that is being used.
* - \b player -- The \link Sigencore::Player player \endlink which activated the list.
* - \b sigmod -- The \link Sigscript::SigmodWrapper wrapper \endlink for the \link Sigmod sigmod \endlink in use.
*
* \param script The script that gets executed when the player activates the list.
*/
void setScript(const Sigcore::Script& script);
/**
* \sa setName
*
* \return The name of the coin list.
*/
QString name() const;
/**
* \sa setScript
*
* \return The script for the coin list.
*/
Sigcore::Script script() const;
/**
* \param index The index of the item to get.
* \return Pointer to the item or NULL if \p index is invalid.
*/
const CoinListItem* item(const int index) const;
/**
* \param index The index of the item to get.
* \return Pointer to the item or NULL if \p index is invalid.
*/
CoinListItem* item(const int index);
/**
* \param id The id of the item to get.
* \return Pointer to the item or NULL if \p id is invalid.
*/
const CoinListItem* itemById(const int id) const;
/**
* \param id The id of the item to get.
* \return Pointer to the item or NULL if \p id is invalid.
*/
CoinListItem* itemById(const int id);
/**
* \param id The id of the item to get.
* \return The index of the item or INT_MAX if \p id is invalid.
*/
int itemIndex(const int id) const;
/**
* \return The number of items in the coin list.
*/
int itemCount() const;
/**
* \return Pointer to a newly created item.
*/
CoinListItem* newItem();
/**
* \param xml The XML of the item to add.
* \return Pointer to a newly created item from \p xml.
*/
CoinListItem* newItem(const QDomElement& xml);
/**
* \param item A copy of the item to add.
* \return Pointer to a newly created item from \p item.
*/
CoinListItem* newItem(const CoinListItem& item);
/**
* Deletes the item at index \p index.
*
* \param index The index of the item to delete.
*/
void deleteItem(const int index);
/**
* Deletes the item with id \p id.
*
* \param id The id of the item to delete.
*/
void deleteItemById(const int id);
bool nameCheck(const QString& name) const;
bool scriptCheck(const Sigcore::Script& script) const;
CoinList& operator=(const CoinList& rhs);
private:
int newItemId() const;
CoinListItem* newItem(CoinListItem* item);
void clear();
QString m_name;
Sigcore::Script m_script;
QList<CoinListItem*> m_items;
};
}
#endif
|
