blob: a89af615a7015511e9d817963028ed20fca1b723 (
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
|
/*
* 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/Time.h
*/
#ifndef SIGMOD_TIME
#define SIGMOD_TIME
// Sigcore includes
#include <sigcore/Script.h>
// Sigmod includes
#include "Object.h"
namespace Sigmod
{
// Forward declarations
class Game;
/**
* \class Sigmod::Time Time.h sigmod/Time.h
* \brief A marker for the start of some time period.
*
* Time can be used to change the properties of things throughout the day.
* Encounter lists can change, species may change colors, or moves have different
* effects.
*/
class SIGMOD_EXPORT Time : public Object
{
Q_OBJECT
public:
/**
* Copy constructor.
*
* \param time The time to copy.
*/
Time(const Time& time);
/**
* Create a new time belonging to \p parent and id \p id.
*
* \param parent The parent of the time.
* \param id The id number for the time.
*/
Time(const Game* parent, const int id);
/**
* Data copy constructor. Copies the data from \p time as a child of \p parent with id \p id.
*
* \param time The time to copy the data from.
* \param parent The parent of the time.
* \param id The id number for the time.
*/
Time(const Time& time, 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 time.
* \param id The id number for the time.
*/
Time(const QDomElement& xml, const Game* parent, const int id = -1);
/**
* Check to make sure the time'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 time in XML format.
*
* \return The XML structure representing the time.
*/
QDomElement save() const;
/**
* Sets the name of the time. Used internally only.
*
* \param name The name of the time.
*/
void setName(const QString& name);
/**
* Sets the hour that the time starts at.
*
* \param hour The hour the time starts at.
*/
void setHour(const int hour);
/**
* Sets the minute that the time starts at.
*
* \param minutes The minute the time starts at.
*/
void setMinute(const int minutes);
/**
* Sets the script executed when the time starts. The following objects are available to the script:
*
* - \b sigmod -- The \link Sigscript::SigmodWrapper wrapper \endlink for the \link Sigmod sigmod \endlink in use.
* - \b arena -- The \link Sigencore::Arena arena \endlink the ability is being used in (if in battle).
* - \b map -- The \link Sigscript::MapWrapper wrapper \endlink for the \link Map map \endlink the player is on.
*
* \param script The script that gets run when the time starts.
*/
void setScript(const Sigcore::Script& script);
/**
* \sa setName
*
* \return The name of the time.
*/
QString name() const;
/**
* \sa setHour
*
* \return The hour that the time starts at.
*/
int hour() const;
/**
* \sa setMinute
*
* \return The minute that the time starts at.
*/
int minute() const;
/**
* \sa setScript
*
* \return The script to get executed when the time starts.
*/
Sigcore::Script script() const;
bool nameCheck(const QString& name) const;
bool hourCheck(const int hour) const;
bool minuteCheck(const int minutes) const;
bool scriptCheck(const Sigcore::Script& script) const;
Time& operator=(const Time& rhs);
private:
QString m_name;
int m_hour;
int m_minute;
Sigcore::Script m_script;
};
}
#endif
|
