File: ultima4.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (146 lines) | stat: -rw-r--r-- 3,907 bytes parent folder | download | duplicates (2)
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
/* 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 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/>.
 *
 */

#ifndef ULTIMA4_H
#define ULTIMA4_H

#include "ultima/shared/engine/ultima.h"
#include "ultima/shared/std/containers.h"

namespace Ultima {
namespace Ultima4 {

class Armors;
class Codex;
class Config;
class Context;
class Death;
class DialogueLoaders;
class Items;
class GameController;
class MapLoaders;
class Moongates;
class Music;
class ResponseParts;
struct SaveGame;
class Screen;
class Shrines;
class SoundManager;
class Spells;
class TileMaps;
class TileRules;
class TileSets;
class Weapons;

class Ultima4Engine : public Shared::UltimaEngine {
private:
	int _saveSlotToLoad;
private:
	void startup();
protected:
	// Engine APIs
	Common::Error run() override;

	bool initialize() override;

	/**
	 * Returns the data archive folder and version that's required
	 */
	bool isDataRequired(Common::Path &folder, int &majorVersion, int &minorVersion) override;
public:
	Armors *_armors;
	Codex *_codex;
	Config *_config;
	Context *_context;
	Death *_death;
	DialogueLoaders *_dialogueLoaders;
	GameController *_game;
	Items *_items;
	MapLoaders *_mapLoaders;
	Moongates *_moongates;
	Music *_music;
	ResponseParts *_responseParts;
	SaveGame *_saveGame;
	Screen *_screen;
	Shrines *_shrines;
	SoundManager *_soundManager;
	Spells *_spells;
	TileMaps *_tileMaps;
	TileRules *_tileRules;
	TileSets *_tileSets;
	Weapons *_weapons;
	Std::vector<Common::String> _hawkwindText;
public:
	Ultima4Engine(OSystem *syst, const Ultima::UltimaGameDescription *gameDesc);
	~Ultima4Engine() override;

	/**
	 * Returns true if a savegame can be loaded
	 */
	bool canLoadGameStateCurrently(bool isAutosave = false) override;

	/**
	 * Returns true if the game can be saved
	 */
	bool canSaveGameStateCurrently(bool isAutosave = false) override;

	/**
	 * Save a game state.
	 * @param slot	the slot into which the savestate should be stored
	 * @param desc	a description for the savestate, entered by the user
	 * @param isAutosave	Expected to be true if an autosave is being created
	 * @return returns kNoError on success, else an error code.
	 */
	Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false) override;

	/**
	 * Load a game state.
	 * @param stream	the stream to load the savestate from
	 * @return returns kNoError on success, else an error code.
	 */
	Common::Error loadGameStream(Common::SeekableReadStream *stream) override;

	/**
	 * Save a game state.
	 * @param stream	The write stream to save the savegame data to
	 * @param isAutosave	Expected to be true if an autosave is being created
	 * @return returns kNoError on success, else an error code.
	 */
	Common::Error saveGameStream(Common::WriteStream *stream, bool isAutosave = false) override;

	/**
	 * Specifies to load the previous save as the actual game starts. Used by
	 * the main menu when the Journey Onwards option is selected
	 */
	void setToJourneyOnwards();

	/**
	 * Flags to quit the game
	 */
	void quitGame();
};

extern Ultima4Engine *g_ultima;

} // End of namespace Ultima4
} // End of namespace Ultima

#endif