1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 //=============================================================================
24 //
25 // This unit provides game initialization routine, which takes place after
26 // main game file was successfully loaded.
27 //
28 //=============================================================================
29 
30 #ifndef AGS_ENGINE_GAME_GAME_INIT_H
31 #define AGS_ENGINE_GAME_GAME_INIT_H
32 
33 #include "ags/shared/game/main_game_file.h"
34 #include "ags/shared/util/string.h"
35 
36 namespace AGS3 {
37 namespace AGS {
38 namespace Engine {
39 
40 using namespace Shared;
41 
42 // Error codes for initializing the game
43 enum GameInitErrorType {
44 	kGameInitErr_NoError,
45 	// currently AGS requires at least one font to be present in game
46 	kGameInitErr_NoFonts,
47 	kGameInitErr_TooManyAudioTypes,
48 	kGameInitErr_EntityInitFail,
49 	kGameInitErr_TooManyPlugins,
50 	kGameInitErr_PluginNameInvalid,
51 	kGameInitErr_NoGlobalScript,
52 	kGameInitErr_ScriptLinkFailed
53 };
54 
55 String GetGameInitErrorText(GameInitErrorType err);
56 
57 typedef TypedCodeError<GameInitErrorType, GetGameInitErrorText> GameInitError;
58 typedef ErrorHandle<GameInitError> HGameInitError;
59 
60 // Sets up game state for play using preloaded data
61 HGameInitError  InitGameState(const LoadedGameEntities &ents, GameDataVersion data_ver);
62 
63 } // namespace Engine
64 } // namespace AGS
65 } // namespace AGS3
66 
67 #endif
68