aboutsummaryrefslogtreecommitdiff
path: root/engines/lastexpress/entities/chapters.h
blob: abc464845fd6f2dce62a6da570270d3ce65b2d5c (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
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef LASTEXPRESS_CHAPTERS_H
#define LASTEXPRESS_CHAPTERS_H

#include "lastexpress/entities/entity.h"

namespace LastExpress {

class LastExpressEngine;

class Chapters : public Entity {
public:
	Chapters(LastExpressEngine *engine);
	~Chapters() {}

	/**
	 * Saves the game
	 *
	 * @param savegameType The type of the savegame
	 * @param param        The param for the savegame (EventIndex or TimeValue)
	 */
	DECLARE_FUNCTION_2(savegame, SavegameType savegameType, uint32 param)

	/**
	 * Exit a train station
	 *
	 * @param stationName The name of the train station
	 * @param index       The index of the train station
	 */
	DECLARE_FUNCTION_2(enterStation, const char *stationName, CityIndex index)

	/**
	 * Exit a train station
	 *
	 * @param stationName The name of the train station
	 */
	DECLARE_FUNCTION_1(exitStation, const char *stationName)

	/**
	 * Setup Chapter 1
	 */
	DECLARE_FUNCTION(chapter1)

	/**
	 * Reset main entities
	 */
	DECLARE_FUNCTION(resetMainEntities)

	/**
	 * Handle end of Chapter 1 events
	 */
	DECLARE_FUNCTION(firstDream)

	/**
	 * Init Chapter 1 data
	 */
	DECLARE_FUNCTION(chapter1Init)

	/**
	 * Handle Chapter 1 events
	 */
	DECLARE_FUNCTION(chapter1Handler)

	/**
	 * Handle switching to Chapter 2 after the end of Chapter 1
	 */
	DECLARE_FUNCTION(chapter1Next)

	/**
	 * Setup Chapter 2
	 */
	DECLARE_FUNCTION(chapter2)

	/**
	 * Init Chapter 2 data
	 */
	DECLARE_FUNCTION(chapter2Init)

	/**
	 * Handle Chapter 2 events
	 */
	DECLARE_FUNCTION(chapter2Handler)

	/**
	 * Setup Chapter 3
	 */
	DECLARE_FUNCTION(chapter3)

	/**
	 * Init Chapter 3 data
	 */
	DECLARE_FUNCTION(chapter3Init)

	/**
	 * Handle Chapter 3 events
	 */
	DECLARE_FUNCTION(chapter3Handler)

	/**
	 * Handle Vienna events
	 */
	DECLARE_FUNCTION(viennaEvents)

	/**
	 * Setup Chapter 4
	 */
	DECLARE_FUNCTION(chapter4)

	/**
	 * Init Chapter 4 data
	 */
	DECLARE_FUNCTION(chapter4Init)

	/**
	 * Handle Chapter 4 events
	 */
	DECLARE_FUNCTION(chapter4Handler)

	/**
	 * Setup Chapter 5
	 */
	DECLARE_FUNCTION(chapter5)

	/**
	 * Init Chapter 5 data
	 */
	DECLARE_FUNCTION(chapter5Init)

	/**
	 * Handle Chapter 5 events
	 */
	DECLARE_FUNCTION(chapter5Handler)

private:
	bool timeCheckEnterStation(TimeValue timeValue, uint &parameter, byte callback, const char *sequence, CityIndex cityIndex);
	bool timeCheckExitStation(TimeValue timeValue, uint &parameter, byte callback, const char *sequence);
	void enterExitStation(const SavePoint &savepoint, bool isEnteringStation);
	void enterExitHelper(bool isEnteringStation);
	void playSteam() const;
};

} // End of namespace LastExpress

#endif // LASTEXPRESS_CHAPTERS_H