Repository navigation
Expand file tree
/
Copy pathGame.cpp
More file actions
657 lines (596 loc) · 15.9 KB
/
Copy pathGame.cpp
File metadata and controls
657 lines (596 loc) · 15.9 KB
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
/*
* Copyright 2010-2016 OpenXcom Developers.
*
* This file is part of OpenXcom.
*
* OpenXcom 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.
*
* OpenXcom 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 OpenXcom. If not, see <http://www.gnu.org/licenses/>.
*/
#include "Game.h"
#include <algorithm>
#include <cmath>
#include <sstream>
#include <SDL_mixer.h>
#include "State.h"
#include "Screen.h"
#include "Sound.h"
#include "Music.h"
#include "Language.h"
#include "Logger.h"
#include "../Interface/Cursor.h"
#include "../Interface/FpsCounter.h"
#include "../Mod/Mod.h"
#include "../Savegame/SavedGame.h"
#include "../Savegame/SavedBattleGame.h"
#include "Action.h"
#include "Exception.h"
#include "Options.h"
#include "CrossPlatform.h"
#include "FileMap.h"
#include "Unicode.h"
#include "../Menu/TestState.h"
namespace OpenXcom
{
const double Game::VOLUME_GRADIENT = 10.0;
/**
* Starts up SDL with all the subsystems and SDL_mixer for audio processing,
* creates the display screen and sets up the cursor.
* @param title Title of the game window.
*/
Game::Game(const std::string &title) : _screen(0), _cursor(0), _lang(0), _save(0), _mod(0), _quit(false), _init(false), _mouseActive(true), _timeUntilNextFrame(0)
{
Options::reload = false;
Options::mute = false;
// Initialize SDL
if (SDL_Init(SDL_INIT_VIDEO) < 0)
{
throw Exception(SDL_GetError());
}
Log(LOG_INFO) << "SDL initialized successfully.";
// Initialize SDL_mixer
if (SDL_InitSubSystem(SDL_INIT_AUDIO) < 0)
{
Log(LOG_ERROR) << SDL_GetError();
Log(LOG_WARNING) << "No sound device detected, audio disabled.";
Options::mute = true;
}
else
{
initAudio();
}
// trap the mouse inside the window
SDL_WM_GrabInput(Options::captureMouse);
// Set the window icon
CrossPlatform::setWindowIcon(103, FileMap::getFilePath("openxcom.png"));
// Set the window caption
SDL_WM_SetCaption(title.c_str(), 0);
SDL_EnableUNICODE(1);
// Create display
_screen = new Screen();
// Create cursor
_cursor = new Cursor(9, 13);
// Create invisible hardware cursor to workaround bug with absolute positioning pointing devices
SDL_ShowCursor(SDL_ENABLE);
Uint8 cursor = 0;
SDL_SetCursor(SDL_CreateCursor(&cursor, &cursor, 1,1,0,0));
// Create fps counter
_fpsCounter = new FpsCounter(15, 5, 0, 0);
// Create blank language
_lang = new Language();
_timeOfLastFrame = 0;
}
/**
* Deletes the display screen, cursor, states and shuts down all the SDL subsystems.
*/
Game::~Game()
{
Sound::stop();
Music::stop();
for (std::list<State*>::iterator i = _states.begin(); i != _states.end(); ++i)
{
delete *i;
}
SDL_FreeCursor(SDL_GetCursor());
delete _cursor;
delete _lang;
delete _save;
delete _mod;
delete _screen;
delete _fpsCounter;
Mix_CloseAudio();
SDL_Quit();
}
/**
* The state machine takes care of passing all the events from SDL to the
* active state, running any code within and blitting all the states and
* cursor to the screen. This is run indefinitely until the game quits.
*/
void Game::run()
{
enum ApplicationState { RUNNING = 0, SLOWED = 1, PAUSED = 2 } runningState = RUNNING;
static const ApplicationState kbFocusRun[4] = { RUNNING, RUNNING, SLOWED, PAUSED };
static const ApplicationState stateRun[4] = { SLOWED, PAUSED, PAUSED, PAUSED };
// this will avoid processing SDL's resize event on startup, workaround for the heap allocation error it causes.
bool startupEvent = Options::allowResize;
while (!_quit)
{
// Clean up states
while (!_deleted.empty())
{
delete _deleted.back();
_deleted.pop_back();
}
// Initialize active state
if (!_init)
{
_init = true;
_states.back()->init();
// Unpress buttons
_states.back()->resetAll();
// Refresh mouse position
SDL_Event ev;
int x, y;
SDL_GetMouseState(&x, &y);
ev.type = SDL_MOUSEMOTION;
ev.motion.x = x;
ev.motion.y = y;
Action action = Action(&ev, _screen->getXScale(), _screen->getYScale(), _screen->getCursorTopBlackBand(), _screen->getCursorLeftBlackBand());
_states.back()->handle(&action);
}
// Process events
while (SDL_PollEvent(&_event))
{
if (CrossPlatform::isQuitShortcut(_event))
_event.type = SDL_QUIT;
switch (_event.type)
{
case SDL_QUIT:
quit();
break;
case SDL_ACTIVEEVENT:
switch (reinterpret_cast<SDL_ActiveEvent*>(&_event)->state)
{
case SDL_APPACTIVE:
runningState = reinterpret_cast<SDL_ActiveEvent*>(&_event)->gain ? RUNNING : stateRun[Options::pauseMode];
break;
case SDL_APPMOUSEFOCUS:
// We consciously ignore it.
break;
case SDL_APPINPUTFOCUS:
runningState = reinterpret_cast<SDL_ActiveEvent*>(&_event)->gain ? RUNNING : kbFocusRun[Options::pauseMode];
break;
}
break;
case SDL_VIDEORESIZE:
if (Options::allowResize)
{
if (!startupEvent)
{
Options::newDisplayWidth = Options::displayWidth = std::max(Screen::ORIGINAL_WIDTH, _event.resize.w);
Options::newDisplayHeight = Options::displayHeight = std::max(Screen::ORIGINAL_HEIGHT, _event.resize.h);
int dX = 0, dY = 0;
Screen::updateScale(Options::battlescapeScale, Options::baseXBattlescape, Options::baseYBattlescape, false);
Screen::updateScale(Options::geoscapeScale, Options::baseXGeoscape, Options::baseYGeoscape, false);
for (std::list<State*>::iterator i = _states.begin(); i != _states.end(); ++i)
{
(*i)->resize(dX, dY);
}
_screen->resetDisplay();
}
else
{
startupEvent = false;
}
}
break;
case SDL_MOUSEMOTION:
case SDL_MOUSEBUTTONDOWN:
case SDL_MOUSEBUTTONUP:
// Skip mouse events if they're disabled
if (!_mouseActive) continue;
// re-gain focus on mouse-over or keypress.
runningState = RUNNING;
// Go on, feed the event to others
default:
Action action = Action(&_event, _screen->getXScale(), _screen->getYScale(), _screen->getCursorTopBlackBand(), _screen->getCursorLeftBlackBand());
_screen->handle(&action);
_cursor->handle(&action);
_fpsCounter->handle(&action);
if (action.getDetails()->type == SDL_KEYDOWN)
{
// "ctrl-g" grab input
if (action.getDetails()->key.keysym.sym == SDLK_g && (SDL_GetModState() & KMOD_CTRL) != 0)
{
Options::captureMouse = (SDL_GrabMode)(!Options::captureMouse);
SDL_WM_GrabInput(Options::captureMouse);
}
else if (Options::debug)
{
if (action.getDetails()->key.keysym.sym == SDLK_t && (SDL_GetModState() & KMOD_CTRL) != 0)
{
setState(new TestState);
}
// "ctrl-u" debug UI
else if (action.getDetails()->key.keysym.sym == SDLK_u && (SDL_GetModState() & KMOD_CTRL) != 0)
{
Options::debugUi = !Options::debugUi;
_states.back()->redrawText();
}
}
}
_states.back()->handle(&action);
break;
}
}
// Process rendering
if (runningState != PAUSED)
{
// Process logic
_states.back()->think();
_fpsCounter->think();
if (Options::FPS > 0 && !(Options::useOpenGL && Options::vSyncForOpenGL))
{
// Update our FPS delay time based on the time of the last draw.
int fps = SDL_GetAppState() & SDL_APPINPUTFOCUS ? Options::FPS : Options::FPSInactive;
_timeUntilNextFrame = (1000.0f / fps) - (SDL_GetTicks() - _timeOfLastFrame);
}
else
{
_timeUntilNextFrame = 0;
}
if (_init && _timeUntilNextFrame <= 0)
{
// make a note of when this frame update occurred.
_timeOfLastFrame = SDL_GetTicks();
_fpsCounter->addFrame();
_screen->clear();
std::list<State*>::iterator i = _states.end();
do
{
--i;
}
while (i != _states.begin() && !(*i)->isScreen());
for (; i != _states.end(); ++i)
{
(*i)->blit();
}
_fpsCounter->blit(_screen->getSurface());
_cursor->blit(_screen->getSurface());
_screen->flip();
}
}
// Save on CPU
switch (runningState)
{
case RUNNING:
SDL_Delay(1); //Save CPU from going 100%
break;
case SLOWED: case PAUSED:
SDL_Delay(100); break; //More slowing down.
}
}
Options::save();
}
/**
* Stops the state machine and the game is shut down.
*/
void Game::quit()
{
// Always save ironman
if (_save != 0 && _save->isIronman() && !_save->getName().empty())
{
std::string filename = CrossPlatform::sanitizeFilename(Unicode::convUtf8ToPath(_save->getName())) + ".sav";
_save->save(filename);
}
_quit = true;
}
/**
* Changes the audio volume of the music and
* sound effect channels.
* @param sound Sound volume, from 0 to MIX_MAX_VOLUME.
* @param music Music volume, from 0 to MIX_MAX_VOLUME.
* @param ui UI volume, from 0 to MIX_MAX_VOLUME.
*/
void Game::setVolume(int sound, int music, int ui)
{
if (!Options::mute)
{
if (sound >= 0)
{
sound = volumeExponent(sound) * (double)SDL_MIX_MAXVOLUME;
Mix_Volume(-1, sound);
if (_save && _save->getSavedBattle())
{
Mix_Volume(3, sound * _save->getSavedBattle()->getAmbientVolume());
}
else
{
// channel 3: reserved for ambient sound effect.
Mix_Volume(3, sound / 2);
}
}
if (music >= 0)
{
music = volumeExponent(music) * (double)SDL_MIX_MAXVOLUME;
Mix_VolumeMusic(music);
}
if (ui >= 0)
{
ui = volumeExponent(ui) * (double)SDL_MIX_MAXVOLUME;
Mix_Volume(1, ui);
Mix_Volume(2, ui);
}
}
}
double Game::volumeExponent(int volume)
{
return (exp(log(Game::VOLUME_GRADIENT + 1.0) * volume / (double)SDL_MIX_MAXVOLUME) -1.0 ) / Game::VOLUME_GRADIENT;
}
/**
* Returns the display screen used by the game.
* @return Pointer to the screen.
*/
Screen *Game::getScreen() const
{
return _screen;
}
/**
* Returns the mouse cursor used by the game.
* @return Pointer to the cursor.
*/
Cursor *Game::getCursor() const
{
return _cursor;
}
/**
* Returns the FpsCounter used by the game.
* @return Pointer to the FpsCounter.
*/
FpsCounter *Game::getFpsCounter() const
{
return _fpsCounter;
}
/**
* Pops all the states currently in stack and pushes in the new state.
* A shortcut for cleaning up all the old states when they're not necessary
* like in one-way transitions.
* @param state Pointer to the new state.
*/
void Game::setState(State *state)
{
while (!_states.empty())
{
popState();
}
pushState(state);
_init = false;
}
/**
* Pushes a new state into the top of the stack and initializes it.
* The new state will be used once the next game cycle starts.
* @param state Pointer to the new state.
*/
void Game::pushState(State *state)
{
_states.push_back(state);
_init = false;
}
/**
* Pops the last state from the top of the stack. Since states
* can't actually be deleted mid-cycle, it's moved into a separate queue
* which is cleared at the start of every cycle, so the transition
* is seamless.
*/
void Game::popState()
{
_deleted.push_back(_states.back());
_states.pop_back();
_init = false;
}
/**
* Returns the language currently in use by the game.
* @return Pointer to the language.
*/
Language *Game::getLanguage() const
{
return _lang;
}
/**
* Changes the language currently in use by the game.
* @param filename Filename of the language file.
*/
void Game::loadLanguage(const std::string &filename)
{
std::ostringstream ss;
ss << "/Language/" << filename << ".yml";
std::string path = CrossPlatform::searchDataFile("common" + ss.str());
try
{
_lang->load(path);
}
catch (YAML::Exception &e)
{
throw Exception(path + ": " + std::string(e.what()));
}
std::vector<const ModInfo*> activeMods = Options::getActiveMods();
for (std::vector<const ModInfo*>::const_iterator i = activeMods.begin(); i != activeMods.end(); ++i)
{
std::string file = (*i)->getPath() + ss.str();
if (CrossPlatform::fileExists(file))
{
_lang->load(file);
}
}
const std::map<std::string, ExtraStrings*> &extraStrings = _mod->getExtraStrings();
std::map<std::string, ExtraStrings*>::const_iterator it = extraStrings.find(filename);
if (it != extraStrings.end())
{
_lang->load(it->second);
}
}
/**
* Returns the saved game currently in use by the game.
* @return Pointer to the saved game.
*/
SavedGame *Game::getSavedGame() const
{
return _save;
}
/**
* Sets a new saved game for the game to use.
* @param save Pointer to the saved game.
*/
void Game::setSavedGame(SavedGame *save)
{
delete _save;
_save = save;
}
/**
* Returns the mod currently in use by the game.
* @return Pointer to the mod.
*/
Mod *Game::getMod() const
{
return _mod;
}
/**
* Loads the mods specified in the game options.
*/
void Game::loadMods()
{
Mod::resetGlobalStatics();
delete _mod;
_mod = new Mod();
_mod->loadAll(FileMap::getRulesets());
}
/**
* Sets whether the mouse is activated.
* If it is, mouse events are processed, otherwise
* they are ignored and the cursor is hidden.
* @param active Is mouse activated?
*/
void Game::setMouseActive(bool active)
{
_mouseActive = active;
_cursor->setVisible(active);
}
/**
* Returns whether current state is *state
* @param state The state to test against the stack state
* @return Is state the current state?
*/
bool Game::isState(State *state) const
{
return !_states.empty() && _states.back() == state;
}
/**
* Checks if the game is currently quitting.
* @return whether the game is shutting down or not.
*/
bool Game::isQuitting() const
{
return _quit;
}
/**
* Loads the most appropriate language
* given current system and game options.
*/
void Game::defaultLanguage()
{
const std::string defaultLang = "en-US";
std::string currentLang = defaultLang;
delete _lang;
_lang = new Language();
std::ostringstream ss;
ss << "common/Language/" << defaultLang << ".yml";
std::string defaultPath = CrossPlatform::searchDataFile(ss.str());
std::string path = defaultPath;
// No language set, detect based on system
if (Options::language.empty())
{
std::string locale = CrossPlatform::getLocale();
std::string lang = locale.substr(0, locale.find_first_of('-'));
// Try to load full locale
Unicode::replace(path, defaultLang, locale);
if (CrossPlatform::fileExists(path))
{
currentLang = locale;
}
else
{
// Try to load language locale
Unicode::replace(path, locale, lang);
if (CrossPlatform::fileExists(path))
{
currentLang = lang;
}
// Give up, use default
else
{
currentLang = defaultLang;
}
}
}
else
{
// Use options language
Unicode::replace(path, defaultLang, Options::language);
if (CrossPlatform::fileExists(path))
{
currentLang = Options::language;
}
// Language not found, use default
else
{
currentLang = defaultLang;
}
}
loadLanguage(defaultLang);
if (currentLang != defaultLang)
{
loadLanguage(currentLang);
}
Options::language = currentLang;
}
/**
* Initializes the audio subsystem.
*/
void Game::initAudio()
{
Uint16 format = MIX_DEFAULT_FORMAT;
if (Options::audioBitDepth == 8)
format = AUDIO_S8;
if (Options::audioSampleRate % 11025 != 0)
{
Log(LOG_WARNING) << "Custom sample rate " << Options::audioSampleRate << "Hz, audio that doesn't match will be distorted!";
Log(LOG_WARNING) << "SDL_mixer only supports multiples of 11025Hz.";
}
int minChunk = Options::audioSampleRate / 11025 * 512;
Options::audioChunkSize = std::max(minChunk, Options::audioChunkSize);
if (Mix_OpenAudio(Options::audioSampleRate, format, MIX_DEFAULT_CHANNELS, Options::audioChunkSize) != 0)
{
Log(LOG_ERROR) << Mix_GetError();
Log(LOG_WARNING) << "No sound device detected, audio disabled.";
Options::mute = true;
}
else
{
Mix_AllocateChannels(16);
// Set up UI channels
Mix_ReserveChannels(4);
Mix_GroupChannels(1, 2, 0);
Log(LOG_INFO) << "SDL_mixer initialized successfully.";
setVolume(Options::soundVolume, Options::musicVolume, Options::uiVolume);
}
}
}