mirrors
/
OpenRCT2
mirror of https://github.com/OpenRCT2/OpenRCT2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
OpenRCT2/src/openrct2/Context.cpp

1585 lines
50 KiB
C++
Raw Blame History

/*****************************************************************************
* Copyright (c) 2014-2023 OpenRCT2 developers
*
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
*
* OpenRCT2 is licensed under the GNU General Public License version 3.
*****************************************************************************/
#ifdef __EMSCRIPTEN__
# include <emscripten.h>
#endif // __EMSCRIPTEN__
#include "AssetPackManager.h"
#include "Context.h"
#include "Editor.h"
#include "FileClassifier.h"
#include "Game.h"
#include "GameState.h"
#include "GameStateSnapshots.h"
#include "Input.h"
#include "Intro.h"
#include "OpenRCT2.h"
#include "ParkImporter.h"
#include "PlatformEnvironment.h"
#include "ReplayManager.h"
#include "Version.h"
#include "actions/GameAction.h"
#include "audio/AudioContext.h"
#include "audio/audio.h"
#include "config/Config.h"
#include "core/Console.hpp"
#include "core/File.h"
#include "core/FileScanner.h"
#include "core/FileStream.h"
#include "core/Guard.hpp"
#include "core/Http.h"
#include "core/MemoryStream.h"
#include "core/Path.hpp"
#include "core/String.hpp"
#include "core/Timer.hpp"
#include "drawing/IDrawingEngine.h"
#include "drawing/Image.h"
#include "drawing/LightFX.h"
#include "entity/EntityRegistry.h"
#include "entity/EntityTweener.h"
#include "interface/Chat.h"
#include "interface/InteractiveConsole.h"
#include "interface/Viewport.h"
#include "localisation/Date.h"
#include "localisation/Formatter.h"
#include "localisation/Localisation.h"
#include "localisation/LocalisationService.h"
#include "network/DiscordService.h"
#include "network/NetworkBase.h"
#include "network/network.h"
#include "object/ObjectManager.h"
#include "object/ObjectRepository.h"
#include "paint/Painter.h"
#include "park/ParkFile.h"
#include "platform/Crash.h"
#include "platform/Platform.h"
#include "profiling/Profiling.h"
#include "ride/TrackData.h"
#include "ride/TrackDesignRepository.h"
#include "scenario/Scenario.h"
#include "scenario/ScenarioRepository.h"
#include "scripting/HookEngine.h"
#include "scripting/ScriptEngine.h"
#include "title/TitleScreen.h"
#include "title/TitleSequenceManager.h"
#include "ui/UiContext.h"
#include "ui/WindowManager.h"
#include "util/Util.h"
#include "world/Park.h"
#include <algorithm>
#include <cmath>
#include <exception>
#include <future>
#include <iterator>
#include <memory>
#include <string>
using namespace OpenRCT2;
using namespace OpenRCT2::Audio;
using namespace OpenRCT2::Drawing;
using namespace OpenRCT2::Localisation;
using namespace OpenRCT2::Paint;
using namespace OpenRCT2::Scripting;
using namespace OpenRCT2::Ui;
namespace OpenRCT2
{
class Context final : public IContext
{
private:
// Dependencies
std::shared_ptr<IPlatformEnvironment> const _env;
std::shared_ptr<IAudioContext> const _audioContext;
std::shared_ptr<IUiContext> const _uiContext;
// Services
std::unique_ptr<LocalisationService> _localisationService;
std::unique_ptr<IObjectRepository> _objectRepository;
std::unique_ptr<IObjectManager> _objectManager;
std::unique_ptr<ITrackDesignRepository> _trackDesignRepository;
std::unique_ptr<IScenarioRepository> _scenarioRepository;
std::unique_ptr<IReplayManager> _replayManager;
std::unique_ptr<IGameStateSnapshots> _gameStateSnapshots;
std::unique_ptr<AssetPackManager> _assetPackManager;
#ifdef __ENABLE_DISCORD__
std::unique_ptr<DiscordService> _discordService;
#endif
StdInOutConsole _stdInOutConsole;
#ifdef ENABLE_SCRIPTING
ScriptEngine _scriptEngine;
#endif
#ifndef DISABLE_NETWORK
NetworkBase _network;
#endif
// Game states
std::unique_ptr<TitleScreen> _titleScreen;
std::unique_ptr<GameState> _gameState;
DrawingEngine _drawingEngineType = DrawingEngine::Software;
std::unique_ptr<IDrawingEngine> _drawingEngine;
std::unique_ptr<Painter> _painter;
bool _initialised = false;
Timer _timer;
float _ticksAccumulator = 0.0f;
float _realtimeAccumulator = 0.0f;
float _timeScale = 1.0f;
bool _variableFrame = false;
// If set, will end the OpenRCT2 game loop. Intentionally private to this module so that the flag can not be set back to
// false.
bool _finished = false;
std::future<void> _versionCheckFuture;
NewVersionInfo _newVersionInfo;
bool _hasNewVersionInfo = false;
public:
// Singleton of Context.
// Remove this when GetContext() is no longer called so that
// multiple instances can be created in parallel
static Context* Instance;
public:
Context(
const std::shared_ptr<IPlatformEnvironment>& env, const std::shared_ptr<IAudioContext>& audioContext,
const std::shared_ptr<IUiContext>& uiContext)
: _env(env)
, _audioContext(audioContext)
, _uiContext(uiContext)
, _localisationService(std::make_unique<LocalisationService>(env))
#ifdef ENABLE_SCRIPTING
, _scriptEngine(_stdInOutConsole, *env)
#endif
#ifndef DISABLE_NETWORK
, _network(*this)
#endif
, _painter(std::make_unique<Painter>(uiContext))
{
// Can't have more than one context currently.
Guard::Assert(Instance == nullptr);
Instance = this;
}
~Context() override
{
// NOTE: We must shutdown all systems here before Instance is set back to null.
// If objects use GetContext() in their destructor things won't go well.
#ifdef ENABLE_SCRIPTING
_scriptEngine.StopUnloadRegisterAllPlugins();
#endif
GameActions::ClearQueue();
#ifndef DISABLE_NETWORK
_network.Close();
#endif
WindowCloseAll();
// Unload objects after closing all windows, this is to overcome windows like
// the object selection window which loads objects when closed.
if (_objectManager != nullptr)
{
_objectManager->UnloadAll();
}
GfxObjectCheckAllImagesFreed();
GfxUnloadCsg();
GfxUnloadG2();
GfxUnloadG1();
Audio::Close();
Instance = nullptr;
}
std::shared_ptr<IAudioContext> GetAudioContext() override
{
return _audioContext;
}
std::shared_ptr<IUiContext> GetUiContext() override
{
return _uiContext;
}
#ifdef ENABLE_SCRIPTING
Scripting::ScriptEngine& GetScriptEngine() override
{
return _scriptEngine;
}
#endif
GameState* GetGameState() override
{
return _gameState.get();
}
std::shared_ptr<IPlatformEnvironment> GetPlatformEnvironment() override
{
return _env;
}
Localisation::LocalisationService& GetLocalisationService() override
{
return *_localisationService;
}
IObjectManager& GetObjectManager() override
{
return *_objectManager;
}
IObjectRepository& GetObjectRepository() override
{
return *_objectRepository;
}
ITrackDesignRepository* GetTrackDesignRepository() override
{
return _trackDesignRepository.get();
}
IScenarioRepository* GetScenarioRepository() override
{
return _scenarioRepository.get();
}
IReplayManager* GetReplayManager() override
{
return _replayManager.get();
}
IGameStateSnapshots* GetGameStateSnapshots() override
{
return _gameStateSnapshots.get();
}
AssetPackManager* GetAssetPackManager() override
{
return _assetPackManager.get();
}
DrawingEngine GetDrawingEngineType() override
{
return _drawingEngineType;
}
IDrawingEngine* GetDrawingEngine() override
{
return _drawingEngine.get();
}
Paint::Painter* GetPainter() override
{
return _painter.get();
}
#ifndef DISABLE_NETWORK
NetworkBase& GetNetwork() override
{
return _network;
}
#endif
int32_t RunOpenRCT2(int argc, const char** argv) override
{
if (Initialise())
{
Launch();
return EXIT_SUCCESS;
}
return EXIT_FAILURE;
}
void WriteLine(const std::string& s) override
{
_stdInOutConsole.WriteLine(s);
}
void WriteErrorLine(const std::string& s) override
{
_stdInOutConsole.WriteLineError(s);
}
/**
* Causes the OpenRCT2 game loop to finish.
*/
void Finish() override
{
_finished = true;
}
void Quit() override
{
gSavePromptMode = PromptMode::Quit;
ContextOpenWindow(WindowClass::SavePrompt);
}
bool Initialise() final override
{
if (_initialised)
{
throw std::runtime_error("Context already initialised.");
}
_initialised = true;
CrashInit();
if (String::Equals(gConfigGeneral.LastRunVersion, OPENRCT2_VERSION))
{
gOpenRCT2ShowChangelog = false;
}
else
{
gOpenRCT2ShowChangelog = true;
gConfigGeneral.LastRunVersion = OPENRCT2_VERSION;
ConfigSaveDefault();
}
try
{
_localisationService->OpenLanguage(gConfigGeneral.Language);
}
catch (const std::exception& e)
{
LOG_ERROR("Failed to open configured language: %s", e.what());
try
{
_localisationService->OpenLanguage(LANGUAGE_ENGLISH_UK);
}
catch (const std::exception& eFallback)
{
LOG_FATAL("Failed to open fallback language: %s", eFallback.what());
auto uiContext = GetContext()->GetUiContext();
uiContext->ShowMessageBox("Failed to load language file!\nYour installation may be damaged.");
return false;
}
}
// TODO add configuration option to allow multiple instances
// if (!gOpenRCT2Headless && !Platform::LockSingleInstance()) {
// LOG_FATAL("OpenRCT2 is already running.");
// return false;
// } //This comment was relocated so it would stay where it was in relation to the following lines of code.
if (!gOpenRCT2Headless)
{
auto rct2InstallPath = GetOrPromptRCT2Path();
if (rct2InstallPath.empty())
{
return false;
}
_env->SetBasePath(DIRBASE::RCT2, rct2InstallPath);
}
_objectRepository = CreateObjectRepository(_env);
_objectManager = CreateObjectManager(*_objectRepository);
_trackDesignRepository = CreateTrackDesignRepository(_env);
_scenarioRepository = CreateScenarioRepository(_env);
_replayManager = CreateReplayManager();
_gameStateSnapshots = CreateGameStateSnapshots();
if (!gOpenRCT2Headless)
{
_assetPackManager = std::make_unique<AssetPackManager>();
}
#ifdef __ENABLE_DISCORD__
if (!gOpenRCT2Headless)
{
_discordService = std::make_unique<DiscordService>();
}
#endif
if (Platform::ProcessIsElevated())
{
std::string elevationWarning = _localisationService->GetString(STR_ADMIN_NOT_RECOMMENDED);
if (gOpenRCT2Headless)
{
Console::Error::WriteLine(elevationWarning.c_str());
}
else
{
_uiContext->ShowMessageBox(elevationWarning);
}
}
if (Platform::IsRunningInWine())
{
std::string wineWarning = _localisationService->GetString(STR_WINE_NOT_RECOMMENDED);
if (gOpenRCT2Headless)
{
Console::Error::WriteLine(wineWarning.c_str());
}
else
{
_uiContext->ShowMessageBox(wineWarning);
}
}
if (!gOpenRCT2Headless)
{
_uiContext->CreateWindow();
}
EnsureUserContentDirectoriesExist();
// TODO Ideally we want to delay this until we show the title so that we can
// still open the game window and draw a progress screen for the creation
// of the object cache.
_objectRepository->LoadOrConstruct(_localisationService->GetCurrentLanguage());
if (!gOpenRCT2Headless)
{
_assetPackManager->Scan();
_assetPackManager->LoadEnabledAssetPacks();
_assetPackManager->Reload();
}
// TODO Like objects, this can take a while if there are a lot of track designs
// its also really something really we might want to do in the background
// as its not required until the player wants to place a new ride.
_trackDesignRepository->Scan(_localisationService->GetCurrentLanguage());
_scenarioRepository->Scan(_localisationService->GetCurrentLanguage());
TitleSequenceManager::Scan();
if (!gOpenRCT2Headless)
{
Init();
PopulateDevices();
InitRideSoundsAndInfo();
gGameSoundsOff = !gConfigSound.MasterSoundEnabled;
}
ChatInit();
CopyOriginalUserFilesOver();
if (!gOpenRCT2NoGraphics)
{
if (!LoadBaseGraphics())
{
return false;
}
LightFXInit();
}
InputResetPlaceObjModifier();
ViewportInitAll();
_gameState = std::make_unique<GameState>();
_gameState->InitAll(DEFAULT_MAP_SIZE);
#ifdef ENABLE_SCRIPTING
_scriptEngine.Initialise();
#endif
_titleScreen = std::make_unique<TitleScreen>(*_gameState);
_uiContext->Initialise();
return true;
}
void InitialiseDrawingEngine() final override
{
assert(_drawingEngine == nullptr);
_drawingEngineType = gConfigGeneral.DrawingEngine;
auto drawingEngineFactory = _uiContext->GetDrawingEngineFactory();
auto drawingEngine = drawingEngineFactory->Create(_drawingEngineType, _uiContext);
if (drawingEngine == nullptr)
{
if (_drawingEngineType == DrawingEngine::Software)
{
_drawingEngineType = DrawingEngine::None;
LOG_FATAL("Unable to create a drawing engine.");
exit(-1);
}
else
{
LOG_ERROR("Unable to create drawing engine. Falling back to software.");
// Fallback to software
gConfigGeneral.DrawingEngine = DrawingEngine::Software;
ConfigSaveDefault();
DrawingEngineInit();
}
}
else
{
try
{
drawingEngine->Initialise();
drawingEngine->SetVSync(gConfigGeneral.UseVSync);
_drawingEngine = std::move(drawingEngine);
}
catch (const std::exception& ex)
{
if (_drawingEngineType == DrawingEngine::Software)
{
_drawingEngineType = DrawingEngine::None;
LOG_ERROR(ex.what());
LOG_FATAL("Unable to initialise a drawing engine.");
exit(-1);
}
else
{
LOG_ERROR(ex.what());
LOG_ERROR("Unable to initialise drawing engine. Falling back to software.");
// Fallback to software
gConfigGeneral.DrawingEngine = DrawingEngine::Software;
ConfigSaveDefault();
DrawingEngineInit();
}
}
}
WindowCheckAllValidZoom();
}
void DisposeDrawingEngine() final override
{
_drawingEngine = nullptr;
}
bool LoadParkFromFile(const u8string& path, bool loadTitleScreenOnFail = false, bool asScenario = false) final override
{
LOG_VERBOSE("Context::LoadParkFromFile(%s)", path.c_str());
struct CrashAdditionalFileRegistration
{
CrashAdditionalFileRegistration(const std::string& path)
{
// Register the file for crash upload if it asserts while loading.
CrashRegisterAdditionalFile("load_park", path);
}
~CrashAdditionalFileRegistration()
{
// Deregister park file in case it was processed without hitting an assert.
CrashUnregisterAdditionalFile("load_park");
}
} crash_additional_file_registration(path);
try
{
if (String::Equals(Path::GetExtension(path), ".sea", true))
{
auto data = DecryptSea(fs::u8path(path));
auto ms = MemoryStream(data.data(), data.size(), MEMORY_ACCESS::READ);
if (!LoadParkFromStream(&ms, path, loadTitleScreenOnFail, asScenario))
{
throw std::runtime_error(".sea file may have been renamed.");
}
return true;
}
auto fs = FileStream(path, FILE_MODE_OPEN);
if (!LoadParkFromStream(&fs, path, loadTitleScreenOnFail, asScenario))
{
return false;
}
return true;
}
catch (const std::exception& e)
{
Console::Error::WriteLine(e.what());
if (loadTitleScreenOnFail)
{
TitleLoad();
}
auto windowManager = _uiContext->GetWindowManager();
windowManager->ShowError(STR_FAILED_TO_LOAD_FILE_CONTAINS_INVALID_DATA, STR_NONE, {});
}
return false;
}
bool LoadParkFromStream(
IStream* stream, const std::string& path, bool loadTitleScreenFirstOnFail = false,
bool asScenario = false) final override
{
try
{
ClassifiedFileInfo info;
if (!TryClassifyFile(stream, &info))
{
throw std::runtime_error("Unable to detect file type");
}
if (info.Type != FILE_TYPE::PARK && info.Type != FILE_TYPE::SAVED_GAME && info.Type != FILE_TYPE::SCENARIO)
{
throw std::runtime_error("Invalid file type.");
}
std::unique_ptr<IParkImporter> parkImporter;
if (info.Type == FILE_TYPE::PARK)
{
parkImporter = ParkImporter::CreateParkFile(*_objectRepository);
}
else if (info.Version <= FILE_TYPE_S4_CUTOFF)
{
// Save is an S4 (RCT1 format)
parkImporter = ParkImporter::CreateS4();
}
else
{
// Save is an S6 (RCT2 format)
parkImporter = ParkImporter::CreateS6(*_objectRepository);
}
auto result = parkImporter->LoadFromStream(stream, info.Type == FILE_TYPE::SCENARIO, false, path.c_str());
// From this point onwards the currently loaded park will be corrupted if loading fails
// so reload the title screen if that happens.
loadTitleScreenFirstOnFail = true;
GameUnloadScripts();
_objectManager->LoadObjects(result.RequiredObjects);
parkImporter->Import();
gScenarioSavePath = path;
gCurrentLoadedPath = path;
gFirstTimeSaving = true;
GameFixSaveVars();
MapAnimationAutoCreate();
EntityTweener::Get().Reset();
gScreenAge = 0;
gLastAutoSaveUpdate = AUTOSAVE_PAUSE;
#ifndef DISABLE_NETWORK
bool sendMap = false;
#endif
if (!asScenario && (info.Type == FILE_TYPE::PARK || info.Type == FILE_TYPE::SAVED_GAME))
{
#ifndef DISABLE_NETWORK
if (_network.GetMode() == NETWORK_MODE_CLIENT)
{
_network.Close();
}
#endif
GameLoadInit();
#ifndef DISABLE_NETWORK
if (_network.GetMode() == NETWORK_MODE_SERVER)
{
sendMap = true;
}
#endif
}
else
{
ScenarioBegin();
#ifndef DISABLE_NETWORK
if (_network.GetMode() == NETWORK_MODE_SERVER)
{
sendMap = true;
}
if (_network.GetMode() == NETWORK_MODE_CLIENT)
{
_network.Close();
}
#endif
}
// This ensures that the newly loaded save reflects the user's
// 'show real names of guests' option, now that it's a global setting
PeepUpdateNames(gConfigGeneral.ShowRealNamesOfGuests);
#ifndef DISABLE_NETWORK
if (sendMap)
{
_network.ServerSendMap();
}
#endif
#ifdef USE_BREAKPAD
if (_network.GetMode() == NETWORK_MODE_NONE)
{
StartSilentRecord();
}
#endif
if (result.SemiCompatibleVersion)
{
auto windowManager = _uiContext->GetWindowManager();
auto ft = Formatter();
ft.Add<uint32_t>(result.TargetVersion);
ft.Add<uint32_t>(OpenRCT2::PARK_FILE_CURRENT_VERSION);
windowManager->ShowError(STR_WARNING_PARK_VERSION_TITLE, STR_WARNING_PARK_VERSION_MESSAGE, ft);
}
else if (HasObjectsThatUseFallbackImages())
{
Console::Error::WriteLine("Park has objects which require RCT1 linked. Fallback images will be used.");
auto windowManager = _uiContext->GetWindowManager();
windowManager->ShowError(STR_PARK_USES_FALLBACK_IMAGES_WARNING, STR_EMPTY, Formatter());
}
return true;
}
catch (const ObjectLoadException& e)
{
Console::Error::WriteLine("Unable to open park: missing objects");
// If loading the SV6 or SV4 failed return to the title screen if requested.
if (loadTitleScreenFirstOnFail)
{
TitleLoad();
}
// The path needs to be duplicated as it's a const here
// which the window function doesn't like
auto intent = Intent(WindowClass::ObjectLoadError);
intent.PutExtra(INTENT_EXTRA_PATH, path);
intent.PutExtra(INTENT_EXTRA_LIST, const_cast<ObjectEntryDescriptor*>(e.MissingObjects.data()));
intent.PutExtra(INTENT_EXTRA_LIST_COUNT, static_cast<uint32_t>(e.MissingObjects.size()));
auto windowManager = _uiContext->GetWindowManager();
windowManager->OpenIntent(&intent);
}
catch (const UnsupportedRideTypeException&)
{
Console::Error::WriteLine("Unable to open park: unsupported ride types");
// If loading the SV6 or SV4 failed return to the title screen if requested.
if (loadTitleScreenFirstOnFail)
{
TitleLoad();
}
auto windowManager = _uiContext->GetWindowManager();
windowManager->ShowError(STR_FILE_CONTAINS_UNSUPPORTED_RIDE_TYPES, STR_NONE, {});
}
catch (const UnsupportedVersionException& e)
{
Console::Error::WriteLine("Unable to open park: unsupported park version");
if (loadTitleScreenFirstOnFail)
{
TitleLoad();
}
auto windowManager = _uiContext->GetWindowManager();
Formatter ft;
/*if (e.TargetVersion < PARK_FILE_MIN_SUPPORTED_VERSION)
{
ft.Add<uint32_t>(e.TargetVersion);
windowManager->ShowError(STR_ERROR_PARK_VERSION_TITLE, STR_ERROR_PARK_VERSION_TOO_OLD_MESSAGE, ft);
}
else*/
{
if (e.MinVersion == e.TargetVersion)
{
ft.Add<uint32_t>(e.TargetVersion);
ft.Add<uint32_t>(OpenRCT2::PARK_FILE_CURRENT_VERSION);
windowManager->ShowError(STR_ERROR_PARK_VERSION_TITLE, STR_ERROR_PARK_VERSION_TOO_NEW_MESSAGE_2, ft);
}
else
{
ft.Add<uint32_t>(e.TargetVersion);
ft.Add<uint32_t>(e.MinVersion);
ft.Add<uint32_t>(OpenRCT2::PARK_FILE_CURRENT_VERSION);
windowManager->ShowError(STR_ERROR_PARK_VERSION_TITLE, STR_ERROR_PARK_VERSION_TOO_NEW_MESSAGE, ft);
}
}
}
catch (const std::exception& e)
{
// If loading the SV6 or SV4 failed return to the title screen if requested.
if (loadTitleScreenFirstOnFail)
{
TitleLoad();
}
Console::Error::WriteLine(e.what());
}
return false;
}
private:
bool HasObjectsThatUseFallbackImages()
{
for (auto objectType : ObjectTypes)
{
auto maxObjectsOfType = static_cast<ObjectEntryIndex>(object_entry_group_counts[EnumValue(objectType)]);
for (ObjectEntryIndex i = 0; i < maxObjectsOfType; i++)
{
auto obj = _objectManager->GetLoadedObject(objectType, i);
if (obj != nullptr)
{
if (obj->UsesFallbackImages())
return true;
}
}
}
return false;
}
std::string GetOrPromptRCT2Path()
{
auto result = std::string();
if (gCustomRCT2DataPath.empty())
{
// Check install directory
if (gConfigGeneral.RCT2Path.empty() || !Platform::OriginalGameDataExists(gConfigGeneral.RCT2Path))
{
LOG_VERBOSE(
"install directory does not exist or invalid directory selected, %s", gConfigGeneral.RCT2Path.c_str());
if (!ConfigFindOrBrowseInstallDirectory())
{
auto path = ConfigGetDefaultPath();
Console::Error::WriteLine(
"An RCT2 install directory must be specified! Please edit \"game_path\" in %s.\n", path.c_str());
return std::string();
}
}
result = gConfigGeneral.RCT2Path;
}
else
{
result = gCustomRCT2DataPath;
}
return result;
}
bool LoadBaseGraphics()
{
if (!GfxLoadG1(*_env))
{
return false;
}
GfxLoadG2();
GfxLoadCsg();
FontSpriteInitialiseCharacters();
return true;
}
/**
* Launches the game, after command line arguments have been parsed and processed.
*/
void Launch()
{
if (!_versionCheckFuture.valid())
{
_versionCheckFuture = std::async(std::launch::async, [this] {
_newVersionInfo = GetLatestVersion();
if (!String::StartsWith(gVersionInfoTag, _newVersionInfo.tag))
{
_hasNewVersionInfo = true;
}
});
}
gIntroState = IntroState::None;
if (gOpenRCT2Headless)
{
// NONE or OPEN are the only allowed actions for headless mode
if (gOpenRCT2StartupAction != StartupAction::Open)
{
gOpenRCT2StartupAction = StartupAction::None;
}
}
else
{
if ((gOpenRCT2StartupAction == StartupAction::Title) && gConfigGeneral.PlayIntro)
{
gOpenRCT2StartupAction = StartupAction::Intro;
}
}
switch (gOpenRCT2StartupAction)
{
case StartupAction::Intro:
gIntroState = IntroState::PublisherBegin;
TitleLoad();
break;
case StartupAction::Title:
TitleLoad();
break;
case StartupAction::Open:
{
// A path that includes "://" is illegal with all common filesystems, so it is almost certainly a URL
// This way all cURL supported protocols, like http, ftp, scp and smb are automatically handled
if (strstr(gOpenRCT2StartupActionPath, "://") != nullptr)
{
#ifndef DISABLE_HTTP
// Download park and open it using its temporary filename
auto data = DownloadPark(gOpenRCT2StartupActionPath);
if (data.empty())
{
TitleLoad();
break;
}
auto ms = MemoryStream(data.data(), data.size(), MEMORY_ACCESS::READ);
if (!LoadParkFromStream(&ms, gOpenRCT2StartupActionPath, true))
{
Console::Error::WriteLine("Failed to load '%s'", gOpenRCT2StartupActionPath);
TitleLoad();
break;
}
#endif
}
else
{
try
{
if (!LoadParkFromFile(gOpenRCT2StartupActionPath, true))
{
break;
}
}
catch (const std::exception& ex)
{
Console::Error::WriteLine("Failed to load '%s'", gOpenRCT2StartupActionPath);
Console::Error::WriteLine("%s", ex.what());
TitleLoad();
break;
}
}
gScreenFlags = SCREEN_FLAGS_PLAYING;
#ifndef DISABLE_NETWORK
if (gNetworkStart == NETWORK_MODE_SERVER)
{
if (gNetworkStartPort == 0)
{
gNetworkStartPort = gConfigNetwork.DefaultPort;
}
if (gNetworkStartAddress.empty())
{
gNetworkStartAddress = gConfigNetwork.ListenAddress;
}
if (gCustomPassword.empty())
{
_network.SetPassword(gConfigNetwork.DefaultPassword.c_str());
}
else
{
_network.SetPassword(gCustomPassword);
}
_network.BeginServer(gNetworkStartPort, gNetworkStartAddress);
}
else
#endif // DISABLE_NETWORK
{
GameLoadScripts();
GameNotifyMapChanged();
}
break;
}
case StartupAction::Edit:
if (String::SizeOf(gOpenRCT2StartupActionPath) == 0)
{
Editor::Load();
}
else if (!Editor::LoadLandscape(gOpenRCT2StartupActionPath))
{
TitleLoad();
}
break;
default:
break;
}
#ifndef DISABLE_NETWORK
if (gNetworkStart == NETWORK_MODE_CLIENT)
{
if (gNetworkStartPort == 0)
{
gNetworkStartPort = gConfigNetwork.DefaultPort;
}
_network.BeginClient(gNetworkStartHost, gNetworkStartPort);
}
#endif // DISABLE_NETWORK
_stdInOutConsole.Start();
RunGameLoop();
}
bool ShouldDraw()
{
if (gOpenRCT2Headless)
return false;
if (_uiContext->IsMinimised())
return false;
return true;
}
bool ShouldRunVariableFrame()
{
if (!ShouldDraw())
return false;
if (!gConfigGeneral.UncapFPS)
return false;
if (gGameSpeed > 4)
return false;
return true;
}
/**
* Run the main game loop until the finished flag is set.
*/
void RunGameLoop()
{
PROFILED_FUNCTION();
LOG_VERBOSE("begin openrct2 loop");
_finished = false;
#ifndef __EMSCRIPTEN__
_variableFrame = ShouldRunVariableFrame();
do
{
RunFrame();
} while (!_finished);
#else
emscripten_set_main_loop_arg(
[](void* vctx) -> {
auto ctx = reinterpret_cast<Context*>(vctx);
ctx->RunFrame();
},
this, 0, 1);
#endif // __EMSCRIPTEN__
LOG_VERBOSE("finish openrct2 loop");
}
void RunFrame()
{
PROFILED_FUNCTION();
const auto deltaTime = _timer.GetElapsedTimeAndRestart().count();
// Make sure we catch the state change and reset it.
bool useVariableFrame = ShouldRunVariableFrame();
if (_variableFrame != useVariableFrame)
{
_variableFrame = useVariableFrame;
// Switching from variable to fixed frame requires reseting
// of entity positions back to end of tick positions
auto& tweener = EntityTweener::Get();
tweener.Restore();
tweener.Reset();
}
UpdateTimeAccumulators(deltaTime);
if (useVariableFrame)
{
RunVariableFrame(deltaTime);
}
else
{
RunFixedFrame(deltaTime);
}
}
void UpdateTimeAccumulators(float deltaTime)
{
// Ticks
float scaledDeltaTime = deltaTime * _timeScale;
_ticksAccumulator = std::min(_ticksAccumulator + scaledDeltaTime, GAME_UPDATE_MAX_THRESHOLD);
// Real Time.
_realtimeAccumulator = std::min(_realtimeAccumulator + deltaTime, GAME_UPDATE_MAX_THRESHOLD);
while (_realtimeAccumulator >= GAME_UPDATE_TIME_MS)
{
gCurrentRealTimeTicks++;
_realtimeAccumulator -= GAME_UPDATE_TIME_MS;
}
}
void RunFixedFrame(float deltaTime)
{
PROFILED_FUNCTION();
_uiContext->ProcessMessages();
if (_ticksAccumulator < GAME_UPDATE_TIME_MS)
{
const auto sleepTimeSec = (GAME_UPDATE_TIME_MS - _ticksAccumulator);
Platform::Sleep(static_cast<uint32_t>(sleepTimeSec * 1000.f));
return;
}
while (_ticksAccumulator >= GAME_UPDATE_TIME_MS)
{
Tick();
// Always run this at a fixed rate, Update can cause multiple ticks if the game is speed up.
WindowUpdateAll();
_ticksAccumulator -= GAME_UPDATE_TIME_MS;
}
if (ShouldDraw())
{
Draw();
}
}
void RunVariableFrame(float deltaTime)
{
PROFILED_FUNCTION();
const bool shouldDraw = ShouldDraw();
auto& tweener = EntityTweener::Get();
_uiContext->ProcessMessages();
while (_ticksAccumulator >= GAME_UPDATE_TIME_MS)
{
// Get the original position of each sprite
if (shouldDraw)
tweener.PreTick();
Tick();
// Always run this at a fixed rate, Update can cause multiple ticks if the game is speed up.
WindowUpdateAll();
_ticksAccumulator -= GAME_UPDATE_TIME_MS;
// Get the next position of each sprite
if (shouldDraw)
tweener.PostTick();
}
if (shouldDraw)
{
const float alpha = std::min(_ticksAccumulator / GAME_UPDATE_TIME_MS, 1.0f);
tweener.Tween(alpha);
Draw();
}
}
void Draw()
{
PROFILED_FUNCTION();
_drawingEngine->BeginDraw();
_painter->Paint(*_drawingEngine);
_drawingEngine->EndDraw();
}
void Tick()
{
PROFILED_FUNCTION();
// TODO: This variable has been never "variable" in time, some code expects
// this to be 40Hz (25 ms). Refactor this once the UI is decoupled.
gCurrentDeltaTime = static_cast<uint16_t>(GAME_UPDATE_TIME_MS * 1000.0f);
if (GameIsNotPaused())
{
gPaletteEffectFrame += gCurrentDeltaTime;
}
DateUpdateRealTimeOfDay();
if (gIntroState != IntroState::None)
{
IntroUpdate();
}
else if ((gScreenFlags & SCREEN_FLAGS_TITLE_DEMO) && !gOpenRCT2Headless)
{
_titleScreen->Tick();
}
else
{
_gameState->Tick();
}
#ifdef __ENABLE_DISCORD__
if (_discordService != nullptr)
{
_discordService->Tick();
}
#endif
ChatUpdate();
#ifdef ENABLE_SCRIPTING
_scriptEngine.Tick();
#endif
_stdInOutConsole.ProcessEvalQueue();
_uiContext->Tick();
}
/**
* Ensure that the custom user content folders are present
*/
void EnsureUserContentDirectoriesExist()
{
EnsureDirectoriesExist(
DIRBASE::USER,
{
DIRID::OBJECT,
DIRID::SAVE,
DIRID::SCENARIO,
DIRID::TRACK,
DIRID::LANDSCAPE,
DIRID::HEIGHTMAP,
DIRID::PLUGIN,
DIRID::THEME,
DIRID::SEQUENCE,
DIRID::REPLAY,
DIRID::LOG_DESYNCS,
DIRID::CRASH,
});
}
void EnsureDirectoriesExist(const DIRBASE dirBase, const std::initializer_list<DIRID>& dirIds)
{
for (const auto& dirId : dirIds)
{
auto path = _env->GetDirectoryPath(dirBase, dirId);
if (!Platform::EnsureDirectoryExists(path.c_str()))
LOG_ERROR("Unable to create directory '%s'.", path.c_str());
}
}
/**
* Copy saved games and landscapes to user directory
*/
void CopyOriginalUserFilesOver()
{
CopyOriginalUserFilesOver(DIRID::SAVE, "*.sv6");
CopyOriginalUserFilesOver(DIRID::LANDSCAPE, "*.sc6");
}
void CopyOriginalUserFilesOver(DIRID dirid, const std::string& pattern)
{
auto src = _env->GetDirectoryPath(DIRBASE::RCT2, dirid);
auto dst = _env->GetDirectoryPath(DIRBASE::USER, dirid);
CopyOriginalUserFilesOver(src, dst, pattern);
}
void CopyOriginalUserFilesOver(const std::string& srcRoot, const std::string& dstRoot, const std::string& pattern)
{
LOG_VERBOSE("CopyOriginalUserFilesOver('%s', '%s', '%s')", srcRoot.c_str(), dstRoot.c_str(), pattern.c_str());
auto scanPattern = Path::Combine(srcRoot, pattern);
auto scanner = Path::ScanDirectory(scanPattern, true);
while (scanner->Next())
{
auto src = std::string(scanner->GetPath());
auto dst = Path::Combine(dstRoot, scanner->GetPathRelative());
auto dstDirectory = Path::GetDirectory(dst);
// Create the directory if necessary
if (!Path::DirectoryExists(dstDirectory.c_str()))
{
Console::WriteLine("Creating directory '%s'", dstDirectory.c_str());
if (!Platform::EnsureDirectoryExists(dstDirectory.c_str()))
{
Console::Error::WriteLine("Could not create directory %s.", dstDirectory.c_str());
break;
}
}
// Only copy the file if it doesn't already exist
if (!File::Exists(dst))
{
Console::WriteLine("Copying '%s' to '%s'", src.c_str(), dst.c_str());
if (!File::Copy(src, dst, false))
{
Console::Error::WriteLine("Failed to copy '%s' to '%s'", src.c_str(), dst.c_str());
}
}
}
}
#ifndef DISABLE_HTTP
std::vector<uint8_t> DownloadPark(const std::string& url)
{
// Download park to buffer in memory
Http::Request request;
request.url = url;
request.method = Http::Method::GET;
Http::Response res;
try
{
res = Do(request);
if (res.status != Http::Status::Ok)
throw std::runtime_error("bad http status");
}
catch (std::exception& e)
{
Console::Error::WriteLine("Failed to download '%s', cause %s", request.url.c_str(), e.what());
return {};
}
std::vector<uint8_t> parkData;
parkData.resize(res.body.size());
std::memcpy(parkData.data(), res.body.c_str(), parkData.size());
return parkData;
}
#endif
bool HasNewVersionInfo() const override
{
return _hasNewVersionInfo;
}
const NewVersionInfo* GetNewVersionInfo() const override
{
return &_newVersionInfo;
}
void SetTimeScale(float newScale) override
{
_timeScale = std::clamp(newScale, GAME_MIN_TIME_SCALE, GAME_MAX_TIME_SCALE);
}
float GetTimeScale() const override
{
return _timeScale;
}
};
Context* Context::Instance = nullptr;
std::unique_ptr<IContext> CreateContext()
{
return CreateContext(CreatePlatformEnvironment(), CreateDummyAudioContext(), CreateDummyUiContext());
}
std::unique_ptr<IContext> CreateContext(
const std::shared_ptr<IPlatformEnvironment>& env, const std::shared_ptr<Audio::IAudioContext>& audioContext,
const std::shared_ptr<IUiContext>& uiContext)
{
return std::make_unique<Context>(env, audioContext, uiContext);
}
IContext* GetContext()
{
return Context::Instance;
}
} // namespace OpenRCT2
void ContextInit()
{
GetContext()->GetUiContext()->GetWindowManager()->Init();
}
bool ContextLoadParkFromStream(void* stream)
{
return GetContext()->LoadParkFromStream(static_cast<IStream*>(stream), "");
}
void OpenRCT2WriteFullVersionInfo(utf8* buffer, size_t bufferSize)
{
String::Set(buffer, bufferSize, gVersionInfoFull);
}
void OpenRCT2Finish()
{
GetContext()->Finish();
}
void ContextSetCurrentCursor(CursorID cursor)
{
GetContext()->GetUiContext()->SetCursor(cursor);
}
void ContextUpdateCursorScale()
{
GetContext()->GetUiContext()->SetCursorScale(static_cast<uint8_t>(std::round(gConfigGeneral.WindowScale)));
}
void ContextHideCursor()
{
GetContext()->GetUiContext()->SetCursorVisible(false);
}
void ContextShowCursor()
{
GetContext()->GetUiContext()->SetCursorVisible(true);
}
ScreenCoordsXY ContextGetCursorPosition()
{
return GetContext()->GetUiContext()->GetCursorPosition();
}
ScreenCoordsXY ContextGetCursorPositionScaled()
{
auto cursorCoords = ContextGetCursorPosition();
// Compensate for window scaling.
return { static_cast<int32_t>(std::ceil(cursorCoords.x / gConfigGeneral.WindowScale)),
static_cast<int32_t>(std::ceil(cursorCoords.y / gConfigGeneral.WindowScale)) };
}
void ContextSetCursorPosition(const ScreenCoordsXY& cursorPosition)
{
GetContext()->GetUiContext()->SetCursorPosition(cursorPosition);
}
const CursorState* ContextGetCursorState()
{
return GetContext()->GetUiContext()->GetCursorState();
}
const uint8_t* ContextGetKeysState()
{
return GetContext()->GetUiContext()->GetKeysState();
}
const uint8_t* ContextGetKeysPressed()
{
return GetContext()->GetUiContext()->GetKeysPressed();
}
TextInputSession* ContextStartTextInput(u8string& buffer, size_t maxLength)
{
return GetContext()->GetUiContext()->StartTextInput(buffer, maxLength);
}
void ContextStopTextInput()
{
GetContext()->GetUiContext()->StopTextInput();
}
bool ContextIsInputActive()
{
return GetContext()->GetUiContext()->IsTextInputActive();
}
void ContextTriggerResize()
{
return GetContext()->GetUiContext()->TriggerResize();
}
void ContextSetFullscreenMode(int32_t mode)
{
return GetContext()->GetUiContext()->SetFullscreenMode(static_cast<FULLSCREEN_MODE>(mode));
}
void ContextRecreateWindow()
{
GetContext()->GetUiContext()->RecreateWindow();
}
int32_t ContextGetWidth()
{
return GetContext()->GetUiContext()->GetWidth();
}
int32_t ContextGetHeight()
{
return GetContext()->GetUiContext()->GetHeight();
}
bool ContextHasFocus()
{
return GetContext()->GetUiContext()->HasFocus();
}
void ContextSetCursorTrap(bool value)
{
GetContext()->GetUiContext()->SetCursorTrap(value);
}
WindowBase* ContextOpenWindow(WindowClass wc)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
return windowManager->OpenWindow(wc);
}
WindowBase* ContextOpenWindowView(uint8_t wc)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
return windowManager->OpenView(wc);
}
WindowBase* ContextOpenDetailWindow(uint8_t type, int32_t id)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
return windowManager->OpenDetails(type, id);
}
WindowBase* ContextOpenIntent(Intent* intent)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
return windowManager->OpenIntent(intent);
}
void ContextBroadcastIntent(Intent* intent)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
windowManager->BroadcastIntent(*intent);
}
void ContextForceCloseWindowByClass(WindowClass windowClass)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
windowManager->ForceClose(windowClass);
}
WindowBase* ContextShowError(StringId title, StringId message, const Formatter& args)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
return windowManager->ShowError(title, message, args);
}
void ContextUpdateMapTooltip()
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
windowManager->UpdateMapTooltip();
}
void ContextHandleInput()
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
windowManager->HandleInput();
}
void ContextInputHandleKeyboard(bool isTitle)
{
auto windowManager = GetContext()->GetUiContext()->GetWindowManager();
windowManager->HandleKeyboard(isTitle);
}
void ContextQuit()
{
GetContext()->Quit();
}
bool ContextOpenCommonFileDialog(utf8* outFilename, OpenRCT2::Ui::FileDialogDesc& desc, size_t outSize)
{
try
{
std::string result = GetContext()->GetUiContext()->ShowFileDialog(desc);
String::Set(outFilename, outSize, result.c_str());
return !result.empty();
}
catch (const std::exception& ex)
{
LOG_ERROR(ex.what());
outFilename[0] = '\0';
return false;
}
}
u8string ContextOpenCommonFileDialog(OpenRCT2::Ui::FileDialogDesc& desc)
{
try
{
return GetContext()->GetUiContext()->ShowFileDialog(desc);
}
catch (const std::exception& ex)
{
LOG_ERROR(ex.what());
return u8string{};
}
}
Reference in New Issue View Git Blame Copy Permalink