/
g_common.h
292 lines (244 loc) · 8.34 KB
/
g_common.h
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/** @file g_common.h Top-level (common) game routines.
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2005-2013 Daniel Swanson <danij@dengine.net>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>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 St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#ifndef LIBCOMMON_GAME_H
#define LIBCOMMON_GAME_H
#include "dd_share.h"
#include "fi_lib.h"
#include "mobj.h"
#include "player.h"
DENG_EXTERN_C dd_bool singledemo;
DENG_EXTERN_C uint gameEpisode;
DENG_EXTERN_C Uri *gameMapUri;
DENG_EXTERN_C uint gameMapEntrance;
DENG_EXTERN_C uint gameMap; ///< @todo refactor away.
// Game status cvars:
DENG_EXTERN_C int gsvEpisode;
DENG_EXTERN_C int gsvMap;
#if __JHEXEN__
DENG_EXTERN_C int gsvHub;
#endif
#if __cplusplus
extern "C" {
#endif
void G_Register(void);
dd_bool G_QuitInProgress(void);
/**
* Returns the current logical game state.
*/
gamestate_t G_GameState(void);
/**
* Change the game's state.
*
* @param state The state to change to.
*/
void G_ChangeGameState(gamestate_t state);
gameaction_t G_GameAction(void);
void G_SetGameAction(gameaction_t action);
#if __cplusplus
} // extern "C"
/**
* Schedule a new game session (deferred).
*
* @param mapUri Map identifier.
* @param mapEntrance Logical map entry point number.
* @param rules Game rules to apply.
*/
void G_SetGameActionNewSession(Uri const &mapUri, uint mapEntrance, GameRuleset const &rules);
/**
* Schedule a game session save (deferred).
*
* @param slotId Unique identifier of the save slot to use.
* @param userDescription New user description for the game-save. Can be @c NULL in which
* case it will not change if the slot has already been used.
* If an empty string a new description will be generated automatically.
*
* @return @c true iff @a slotId is valid and saving is presently possible.
*/
bool G_SetGameActionSaveSession(de::String slotId, de::String *userDescription = 0);
/**
* Schedule a game session load (deferred).
*
* @param slotId Unique identifier of the save slot to use.
*
* @return @c true iff @a slotId is in use and loading is presently possible.
*/
bool G_SetGameActionLoadSession(de::String slotId);
extern "C" {
#endif
/**
* Schedule a game session map exit, possibly leading into an intermission sequence.
* (if __JHEXEN__ the intermission will only be displayed when exiting a
* hub and in DeathMatch games)
*
* @param newMap Logical map number we are entering (i.e., not a warp/translated number).
* @param mapEntryPoint Logical map entry point on the new map.
* @param secretExit @c true if the exit taken was marked as 'secret'.
*/
void G_SetGameActionMapCompleted(uint newMap, uint entryPoint, dd_bool secretExit);
/**
* Returns the InFine script with the specified @a scriptId; otherwise @c 0.
*/
char const *G_InFine(char const *scriptId);
/**
* Returns the InFine @em briefing script for the specified @a mapUri; otherwise @c 0.
*/
char const *G_InFineBriefing(Uri const *mapUri);
/**
* Returns the InFine @em debriefing script for the specified @a mapUri; otherwise @c 0.
*/
char const *G_InFineDebriefing(Uri const *mapUri);
/**
* Reveal the game @em help display.
*/
void G_StartHelp(void);
/// @todo Should not be a global function; mode breaks game session separation.
dd_bool G_StartFinale(char const *script, int flags, finale_mode_t mode, char const *defId);
/**
* Signal that play on the current map may now begin.
*/
void G_BeginMap(void);
/**
* Called when a player leaves a map.
*
* Jobs include; striping keys, inventory and powers from the player and configuring other
* player-specific properties ready for the next map.
*
* @param player Id of the player to configure.
*/
void G_PlayerLeaveMap(int player);
/**
* Returns the logical episode number for the identified map.
*
* @param mapUri Unique identifier of the map to lookup.
*/
uint G_EpisodeNumberFor(Uri const *mapUri);
/**
* Returns the logical map number for the identified map.
*
* @param mapUri Unique identifier of the map to lookup.
*/
uint G_MapNumberFor(Uri const *mapUri);
/**
* Compose a Uri for the identified @a episode and @a map combination.
*
* @param episode Logical episode number.
* @param map Logical map number.
*
* @return Resultant Uri. Must be destroyed with Uri_Delete() when no longer needed.
*/
Uri *G_ComposeMapUri(uint episode, uint map);
/**
* Determine if the specified @a episode and @a map value pair are valid and if not,
* adjust their are values within the ranges defined by the current game type and mode.
*
* @param episode Logical episode number to be validated.
* @param map Logical map number to be validated.
*
* @return @c true= The original @a episode and @a map value pair were already valid.
*/
dd_bool G_ValidateMap(uint *episode, uint *map);
/**
* Return the next map according to the default map progression.
*
* @param episode Current episode.
* @param map Current map.
* @param secretExit
*
* @return The next map.
*/
uint G_GetNextMap(uint episode, uint map, dd_bool secretExit);
/// @return Logical map number.
uint G_NextLogicalMapNumber(dd_bool secretExit);
/// @return Logical map number.
uint G_LogicalMapNumber(uint episode, uint map);
/// @return Logical map number.
uint G_CurrentLogicalMapNumber(void);
int G_Ruleset_Skill();
#if !__JHEXEN__
byte G_Ruleset_Fast();
#endif
byte G_Ruleset_Deathmatch();
byte G_Ruleset_NoMonsters();
#if __JHEXEN__
byte G_Ruleset_RandomClasses();
#else
byte G_Ruleset_RespawnMonsters();
#endif
D_CMD( CCmdMakeLocal );
D_CMD( CCmdSetCamera );
D_CMD( CCmdSetViewLock );
D_CMD( CCmdLocalMessage );
D_CMD( CCmdExitLevel );
#if __cplusplus
} // extern "C"
#endif
#if __cplusplus
#include <de/String>
#include "gamerules.h"
class SaveSlots;
/**
* Returns the game identity key (from the engine).
*/
de::String G_IdentityKey();
/**
* Chooses a default user description for a saved session.
*
* @param slotId Unique identifier of a saved slot from which the existing description should
* be re-used. Use a zero-length string to disable.
* @param autogenerate @c true= generate a useful description (map name, map time, etc...) if none
* exists for the referenced save @a slotId.
*/
de::String G_DefaultSavedSessionUserDescription(de::String const &slotId, bool autogenerate = true);
/**
* Configures @a metadata according to the current game session configuration.
*
* @param metadata Current session metadata is written here.
*/
void G_ApplyCurrentSessionMetadata(de::game::SessionMetadata &metadata);
/**
* Returns the game's SaveSlots.
*/
SaveSlots &G_SaveSlots();
/**
* Parse @a str and determine whether it references a logical game-save slot.
*
* @param str String to be parsed. Parse is divided into three passes.
* Pass 1: Check for a known game-save description which matches this.
* Search is in logical save slot creation order.
* Pass 2: Check for keyword identifiers.
* <auto> = The "auto save" slot.
* <last> = The last used slot.
* <quick> = The currently nominated "quick save" slot.
* Pass 3: Check for a unique save slot identifier.
*
* @return The parsed slot id if found; otherwise a zero-length string.
*/
de::String G_SaveSlotIdFromUserInput(de::String str);
/**
* Returns the game's GameRuleset.
*/
GameRuleset &G_Rules();
/**
* To be called when a new game begins to effect the game rules. Note that some
* of the rules may be overridden here (e.g., in a networked game).
*/
void G_ApplyNewGameRules(GameRuleset const &rules);
#endif // __cplusplus
#endif // LIBCOMMON_GAME_H