123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388 |
- /*************************************************************************/
- /* main.cpp */
- /*************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /*************************************************************************/
- /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
- /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /*************************************************************************/
- #include "main.h"
- #include "core/crypto/crypto.h"
- #include "core/debugger/engine_debugger.h"
- #include "core/input/input.h"
- #include "core/input/input_map.h"
- #include "core/io/file_access_network.h"
- #include "core/io/file_access_pack.h"
- #include "core/io/file_access_zip.h"
- #include "core/io/image_loader.h"
- #include "core/io/ip.h"
- #include "core/io/resource_loader.h"
- #include "core/message_queue.h"
- #include "core/os/dir_access.h"
- #include "core/os/os.h"
- #include "core/project_settings.h"
- #include "core/register_core_types.h"
- #include "core/translation.h"
- #include "core/version.h"
- #include "core/version_hash.gen.h"
- #include "drivers/register_driver_types.h"
- #include "main/app_icon.gen.h"
- #include "main/main_timer_sync.h"
- #include "main/performance.h"
- #include "main/splash.gen.h"
- #include "main/splash_editor.gen.h"
- #include "main/tests/test_main.h"
- #include "modules/modules_enabled.gen.h"
- #include "modules/register_module_types.h"
- #include "platform/register_platform_apis.h"
- #include "scene/main/scene_tree.h"
- #include "scene/main/window.h"
- #include "scene/register_scene_types.h"
- #include "scene/resources/packed_scene.h"
- #include "servers/audio_server.h"
- #include "servers/camera_server.h"
- #include "servers/display_server.h"
- #include "servers/navigation_server_2d.h"
- #include "servers/navigation_server_3d.h"
- #include "servers/physics_server_2d.h"
- #include "servers/physics_server_3d.h"
- #include "servers/register_server_types.h"
- #include "servers/rendering/rendering_server_raster.h"
- #include "servers/rendering/rendering_server_wrap_mt.h"
- #include "servers/xr_server.h"
- #ifdef TOOLS_ENABLED
- #include "editor/doc_data.h"
- #include "editor/doc_data_class_path.gen.h"
- #include "editor/editor_node.h"
- #include "editor/editor_settings.h"
- #include "editor/progress_dialog.h"
- #include "editor/project_manager.h"
- #endif
- /* Static members */
- // Singletons
- // Initialized in setup()
- static Engine *engine = nullptr;
- static ProjectSettings *globals = nullptr;
- static Input *input = nullptr;
- static InputMap *input_map = nullptr;
- static TranslationServer *translation_server = nullptr;
- static Performance *performance = nullptr;
- static PackedData *packed_data = nullptr;
- #ifdef MINIZIP_ENABLED
- static ZipArchive *zip_packed_data = nullptr;
- #endif
- static FileAccessNetworkClient *file_access_network_client = nullptr;
- static MessageQueue *message_queue = nullptr;
- // Initialized in setup2()
- static AudioServer *audio_server = nullptr;
- static DisplayServer *display_server = nullptr;
- static RenderingServer *rendering_server = nullptr;
- static CameraServer *camera_server = nullptr;
- static XRServer *xr_server = nullptr;
- static PhysicsServer3D *physics_server = nullptr;
- static PhysicsServer2D *physics_2d_server = nullptr;
- static NavigationServer3D *navigation_server = nullptr;
- static NavigationServer2D *navigation_2d_server = nullptr;
- // We error out if setup2() doesn't turn this true
- static bool _start_success = false;
- // Drivers
- static int display_driver_idx = -1;
- static int audio_driver_idx = -1;
- // Engine config/tools
- static bool single_window = false;
- static bool editor = false;
- static bool project_manager = false;
- static String locale;
- static bool show_help = false;
- static bool auto_quit = false;
- static OS::ProcessID allow_focus_steal_pid = 0;
- #ifdef TOOLS_ENABLED
- static bool auto_build_solutions = false;
- #endif
- // Display
- static DisplayServer::WindowMode window_mode = DisplayServer::WINDOW_MODE_WINDOWED;
- static DisplayServer::ScreenOrientation window_orientation = DisplayServer::SCREEN_LANDSCAPE;
- static uint32_t window_flags = 0;
- static Size2i window_size = Size2i(1024, 600);
- static bool window_vsync_via_compositor = false;
- static bool disable_wintab = false;
- static int init_screen = -1;
- static bool init_fullscreen = false;
- static bool init_maximized = false;
- static bool init_windowed = false;
- static bool init_always_on_top = false;
- static bool init_use_custom_pos = false;
- static Vector2 init_custom_pos;
- static bool force_lowdpi = false;
- // Debug
- static bool use_debug_profiler = false;
- #ifdef DEBUG_ENABLED
- static bool debug_collisions = false;
- static bool debug_navigation = false;
- #endif
- static int frame_delay = 0;
- static bool disable_render_loop = false;
- static int fixed_fps = -1;
- static bool print_fps = false;
- /* Helper methods */
- // Used by Mono module, should likely be registered in Engine singleton instead
- // FIXME: This is also not 100% accurate, `project_manager` is only true when it was requested,
- // but not if e.g. we fail to load and project and fallback to the manager.
- bool Main::is_project_manager() {
- return project_manager;
- }
- static String unescape_cmdline(const String &p_str) {
- return p_str.replace("%20", " ");
- }
- static String get_full_version_string() {
- String hash = String(VERSION_HASH);
- if (hash.length() != 0)
- hash = "." + hash.left(9);
- return String(VERSION_FULL_BUILD) + hash;
- }
- // FIXME: Could maybe be moved to PhysicsServer3DManager and PhysicsServer2DManager directly
- // to have less code in main.cpp.
- void initialize_physics() {
- /// 3D Physics Server
- physics_server = PhysicsServer3DManager::new_server(ProjectSettings::get_singleton()->get(PhysicsServer3DManager::setting_property_name));
- if (!physics_server) {
- // Physics server not found, Use the default physics
- physics_server = PhysicsServer3DManager::new_default_server();
- }
- ERR_FAIL_COND(!physics_server);
- physics_server->init();
- /// 2D Physics server
- physics_2d_server = PhysicsServer2DManager::new_server(ProjectSettings::get_singleton()->get(PhysicsServer2DManager::setting_property_name));
- if (!physics_2d_server) {
- // Physics server not found, Use the default physics
- physics_2d_server = PhysicsServer2DManager::new_default_server();
- }
- ERR_FAIL_COND(!physics_2d_server);
- physics_2d_server->init();
- }
- void finalize_physics() {
- physics_server->finish();
- memdelete(physics_server);
- physics_2d_server->finish();
- memdelete(physics_2d_server);
- }
- void finalize_display() {
- rendering_server->finish();
- memdelete(rendering_server);
- memdelete(display_server);
- }
- void initialize_navigation_server() {
- ERR_FAIL_COND(navigation_server != nullptr);
- navigation_server = NavigationServer3DManager::new_default_server();
- navigation_2d_server = memnew(NavigationServer2D);
- }
- void finalize_navigation_server() {
- memdelete(navigation_server);
- navigation_server = nullptr;
- memdelete(navigation_2d_server);
- navigation_2d_server = nullptr;
- }
- //#define DEBUG_INIT
- #ifdef DEBUG_INIT
- #define MAIN_PRINT(m_txt) print_line(m_txt)
- #else
- #define MAIN_PRINT(m_txt)
- #endif
- void Main::print_help(const char *p_binary) {
- print_line(String(VERSION_NAME) + " v" + get_full_version_string() + " - " + String(VERSION_WEBSITE));
- OS::get_singleton()->print("Free and open source software under the terms of the MIT license.\n");
- OS::get_singleton()->print("(c) 2007-2020 Juan Linietsky, Ariel Manzur.\n");
- OS::get_singleton()->print("(c) 2014-2020 Godot Engine contributors.\n");
- OS::get_singleton()->print("\n");
- OS::get_singleton()->print("Usage: %s [options] [path to scene or 'project.godot' file]\n", p_binary);
- OS::get_singleton()->print("\n");
- OS::get_singleton()->print("General options:\n");
- OS::get_singleton()->print(" -h, --help Display this help message.\n");
- OS::get_singleton()->print(" --version Display the version string.\n");
- OS::get_singleton()->print(" -v, --verbose Use verbose stdout mode.\n");
- OS::get_singleton()->print(" --quiet Quiet mode, silences stdout messages. Errors are still displayed.\n");
- OS::get_singleton()->print("\n");
- OS::get_singleton()->print("Run options:\n");
- #ifdef TOOLS_ENABLED
- OS::get_singleton()->print(" -e, --editor Start the editor instead of running the scene.\n");
- OS::get_singleton()->print(" -p, --project-manager Start the project manager, even if a project is auto-detected.\n");
- #endif
- OS::get_singleton()->print(" -q, --quit Quit after the first iteration.\n");
- OS::get_singleton()->print(" -l, --language <locale> Use a specific locale (<locale> being a two-letter code).\n");
- OS::get_singleton()->print(" --path <directory> Path to a project (<directory> must contain a 'project.godot' file).\n");
- OS::get_singleton()->print(" -u, --upwards Scan folders upwards for project.godot file.\n");
- OS::get_singleton()->print(" --main-pack <file> Path to a pack (.pck) file to load.\n");
- OS::get_singleton()->print(" --render-thread <mode> Render thread mode ('unsafe', 'safe', 'separate').\n");
- OS::get_singleton()->print(" --remote-fs <address> Remote filesystem (<host/IP>[:<port>] address).\n");
- OS::get_singleton()->print(" --remote-fs-password <password> Password for remote filesystem.\n");
- OS::get_singleton()->print(" --audio-driver <driver> Audio driver [");
- for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
- if (i > 0) {
- OS::get_singleton()->print(", ");
- }
- OS::get_singleton()->print("'%s'", AudioDriverManager::get_driver(i)->get_name());
- }
- OS::get_singleton()->print("].\n");
- OS::get_singleton()->print(" --display-driver <driver> Display driver (and rendering driver) [");
- for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
- if (i > 0) {
- OS::get_singleton()->print(", ");
- }
- OS::get_singleton()->print("'%s' (", DisplayServer::get_create_function_name(i));
- Vector<String> rd = DisplayServer::get_create_function_rendering_drivers(i);
- for (int j = 0; j < rd.size(); j++) {
- if (j > 0) {
- OS::get_singleton()->print(", ");
- }
- OS::get_singleton()->print("'%s'", rd[j].utf8().get_data());
- }
- OS::get_singleton()->print(")");
- }
- OS::get_singleton()->print("].\n");
- OS::get_singleton()->print(" --rendering-driver <driver> Rendering driver (depends on display driver).\n");
- OS::get_singleton()->print("\n");
- #ifndef SERVER_ENABLED
- OS::get_singleton()->print("Display options:\n");
- OS::get_singleton()->print(" -f, --fullscreen Request fullscreen mode.\n");
- OS::get_singleton()->print(" -m, --maximized Request a maximized window.\n");
- OS::get_singleton()->print(" -w, --windowed Request windowed mode.\n");
- OS::get_singleton()->print(" -t, --always-on-top Request an always-on-top window.\n");
- OS::get_singleton()->print(" --resolution <W>x<H> Request window resolution.\n");
- OS::get_singleton()->print(" --position <X>,<Y> Request window position.\n");
- OS::get_singleton()->print(" --low-dpi Force low-DPI mode (macOS and Windows only).\n");
- OS::get_singleton()->print(" --no-window Disable window creation (Windows only). Useful together with --script.\n");
- OS::get_singleton()->print(" --enable-vsync-via-compositor When vsync is enabled, vsync via the OS' window compositor (Windows only).\n");
- OS::get_singleton()->print(" --disable-vsync-via-compositor Disable vsync via the OS' window compositor (Windows only).\n");
- OS::get_singleton()->print(" --single-window Use a single window (no separate subwindows).\n");
- OS::get_singleton()->print(" --disable-wintab Disable WinTab API and always use Windows Ink API for the pen input (Windows only).\n");
- OS::get_singleton()->print("\n");
- #endif
- OS::get_singleton()->print("Debug options:\n");
- OS::get_singleton()->print(" -d, --debug Debug (local stdout debugger).\n");
- OS::get_singleton()->print(" -b, --breakpoints Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead).\n");
- OS::get_singleton()->print(" --profiling Enable profiling in the script debugger.\n");
- OS::get_singleton()->print(" --gpu-abort Abort on GPU errors (usually validation layer errors), may help see the problem if your system freezes.\n");
- OS::get_singleton()->print(" --remote-debug <address> Remote debug (<host/IP>:<port> address).\n");
- #if defined(DEBUG_ENABLED) && !defined(SERVER_ENABLED)
- OS::get_singleton()->print(" --debug-collisions Show collision shapes when running the scene.\n");
- OS::get_singleton()->print(" --debug-navigation Show navigation polygons when running the scene.\n");
- #endif
- OS::get_singleton()->print(" --frame-delay <ms> Simulate high CPU load (delay each frame by <ms> milliseconds).\n");
- OS::get_singleton()->print(" --time-scale <scale> Force time scale (higher values are faster, 1.0 is normal speed).\n");
- OS::get_singleton()->print(" --disable-render-loop Disable render loop so rendering only occurs when called explicitly from script.\n");
- OS::get_singleton()->print(" --disable-crash-handler Disable crash handler when supported by the platform code.\n");
- OS::get_singleton()->print(" --fixed-fps <fps> Force a fixed number of frames per second. This setting disables real-time synchronization.\n");
- OS::get_singleton()->print(" --print-fps Print the frames per second to the stdout.\n");
- OS::get_singleton()->print("\n");
- OS::get_singleton()->print("Standalone tools:\n");
- OS::get_singleton()->print(" -s, --script <script> Run a script.\n");
- OS::get_singleton()->print(" --check-only Only parse for errors and quit (use with --script).\n");
- #ifdef TOOLS_ENABLED
- OS::get_singleton()->print(" --export <preset> <path> Export the project using the given preset and matching release template. The preset name should match one defined in export_presets.cfg.\n");
- OS::get_singleton()->print(" <path> should be absolute or relative to the project directory, and include the filename for the binary (e.g. 'builds/game.exe'). The target directory should exist.\n");
- OS::get_singleton()->print(" --export-debug <preset> <path> Same as --export, but using the debug template.\n");
- OS::get_singleton()->print(" --export-pack <preset> <path> Same as --export, but only export the game pack for the given preset. The <path> extension determines whether it will be in PCK or ZIP format.\n");
- OS::get_singleton()->print(" --doctool <path> Dump the engine API reference to the given <path> in XML format, merging if existing files are found.\n");
- OS::get_singleton()->print(" --no-docbase Disallow dumping the base types (used with --doctool).\n");
- OS::get_singleton()->print(" --build-solutions Build the scripting solutions (e.g. for C# projects). Implies --editor and requires a valid project to edit.\n");
- #ifdef DEBUG_METHODS_ENABLED
- OS::get_singleton()->print(" --gdnative-generate-json-api Generate JSON dump of the Godot API for GDNative bindings.\n");
- #endif
- OS::get_singleton()->print(" --test <test> Run a unit test [");
- const char **test_names = tests_get_names();
- const char *comma = "";
- while (*test_names) {
- OS::get_singleton()->print("%s'%s'", comma, *test_names);
- test_names++;
- comma = ", ";
- }
- OS::get_singleton()->print("].\n");
- #endif
- }
- /* Engine initialization
- *
- * Consists of several methods that are called by each platform's specific main(argc, argv).
- * To fully understand engine init, one should therefore start from the platform's main and
- * see how it calls into the Main class' methods.
- *
- * The initialization is typically done in 3 steps (with the setup2 step triggered either
- * automatically by setup, or manually in the platform's main).
- *
- * - setup(execpath, argc, argv, p_second_phase) is the main entry point for all platforms,
- * responsible for the initialization of all low level singletons and core types, and parsing
- * command line arguments to configure things accordingly.
- * If p_second_phase is true, it will chain into setup2() (default behaviour). This is
- * disabled on some platforms (Android, iOS, UWP) which trigger the second step in their
- * own time.
- *
- * - setup2(p_main_tid_override) registers high level servers and singletons, displays the
- * boot splash, then registers higher level types (scene, editor, etc.).
- *
- * - start() is the last step and that's where command line tools can run, or the main loop
- * can be created eventually and the project settings put into action. That's also where
- * the editor node is created, if relevant.
- * start() does it own argument parsing for a subset of the command line arguments described
- * in help, it's a bit messy and should be globalized with the setup() parsing somehow.
- */
- Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_phase) {
- OS::get_singleton()->initialize();
- engine = memnew(Engine);
- ClassDB::init();
- MAIN_PRINT("Main: Initialize CORE");
- register_core_types();
- register_core_driver_types();
- MAIN_PRINT("Main: Initialize Globals");
- Thread::_main_thread_id = Thread::get_caller_id();
- globals = memnew(ProjectSettings);
- input_map = memnew(InputMap);
- register_core_settings(); //here globals is present
- translation_server = memnew(TranslationServer);
- performance = memnew(Performance);
- ClassDB::register_class<Performance>();
- engine->add_singleton(Engine::Singleton("Performance", performance));
- GLOBAL_DEF("debug/settings/crash_handler/message", String("Please include this when reporting the bug on https://github.com/godotengine/godot/issues"));
- MAIN_PRINT("Main: Parse CMDLine");
- /* argument parsing and main creation */
- List<String> args;
- List<String> main_args;
- for (int i = 0; i < argc; i++) {
- args.push_back(String::utf8(argv[i]));
- }
- List<String>::Element *I = args.front();
- I = args.front();
- while (I) {
- I->get() = unescape_cmdline(I->get().strip_edges());
- I = I->next();
- }
- I = args.front();
- String display_driver = "";
- String audio_driver = "";
- String project_path = ".";
- bool upwards = false;
- String debug_uri = "";
- bool skip_breakpoints = false;
- String main_pack;
- bool quiet_stdout = false;
- int rtm = -1;
- String remotefs;
- String remotefs_pass;
- Vector<String> breakpoints;
- bool use_custom_res = true;
- bool force_res = false;
- bool saw_vsync_via_compositor_override = false;
- #ifdef TOOLS_ENABLED
- bool found_project = false;
- #endif
- bool use_vsync = false;
- packed_data = PackedData::get_singleton();
- if (!packed_data)
- packed_data = memnew(PackedData);
- #ifdef MINIZIP_ENABLED
- //XXX: always get_singleton() == 0x0
- zip_packed_data = ZipArchive::get_singleton();
- //TODO: remove this temporary fix
- if (!zip_packed_data) {
- zip_packed_data = memnew(ZipArchive);
- }
- packed_data->add_pack_source(zip_packed_data);
- #endif
- I = args.front();
- while (I) {
- #ifdef OSX_ENABLED
- // Ignore the process serial number argument passed by macOS Gatekeeper.
- // Otherwise, Godot would try to open a non-existent project on the first start and abort.
- if (I->get().begins_with("-psn_")) {
- I = I->next();
- continue;
- }
- #endif
- List<String>::Element *N = I->next();
- if (I->get() == "-h" || I->get() == "--help" || I->get() == "/?") { // display help
- show_help = true;
- goto error;
- } else if (I->get() == "--version") {
- print_line(get_full_version_string());
- goto error;
- } else if (I->get() == "-v" || I->get() == "--verbose") { // verbose output
- OS::get_singleton()->_verbose_stdout = true;
- } else if (I->get() == "--quiet") { // quieter output
- quiet_stdout = true;
- } else if (I->get() == "--audio-driver") { // audio driver
- if (I->next()) {
- audio_driver = I->next()->get();
- bool found = false;
- for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
- if (audio_driver == AudioDriverManager::get_driver(i)->get_name()) {
- found = true;
- }
- }
- if (!found) {
- OS::get_singleton()->print("Unknown audio driver '%s', aborting.\nValid options are ", audio_driver.utf8().get_data());
- for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
- if (i == AudioDriverManager::get_driver_count() - 1) {
- OS::get_singleton()->print(" and ");
- } else if (i != 0) {
- OS::get_singleton()->print(", ");
- }
- OS::get_singleton()->print("'%s'", AudioDriverManager::get_driver(i)->get_name());
- }
- OS::get_singleton()->print(".\n");
- goto error;
- }
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing audio driver argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--display-driver") { // force video driver
- if (I->next()) {
- display_driver = I->next()->get();
- bool found = false;
- for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
- if (display_driver == DisplayServer::get_create_function_name(i)) {
- found = true;
- }
- }
- if (!found) {
- OS::get_singleton()->print("Unknown display driver '%s', aborting.\nValid options are ", display_driver.utf8().get_data());
- for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
- if (i == DisplayServer::get_create_function_count() - 1) {
- OS::get_singleton()->print(" and ");
- } else if (i != 0) {
- OS::get_singleton()->print(", ");
- }
- OS::get_singleton()->print("'%s'", DisplayServer::get_create_function_name(i));
- }
- OS::get_singleton()->print(".\n");
- goto error;
- }
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing video driver argument, aborting.\n");
- goto error;
- }
- #ifndef SERVER_ENABLED
- } else if (I->get() == "-f" || I->get() == "--fullscreen") { // force fullscreen
- init_fullscreen = true;
- } else if (I->get() == "-m" || I->get() == "--maximized") { // force maximized window
- init_maximized = true;
- window_mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
- } else if (I->get() == "-w" || I->get() == "--windowed") { // force windowed window
- init_windowed = true;
- } else if (I->get() == "--gpu-abort") { // force windowed window
- Engine::singleton->abort_on_gpu_errors = true;
- } else if (I->get() == "--disable-wintab") {
- disable_wintab = true;
- } else if (I->get() == "--single-window") { // force single window
- single_window = true;
- } else if (I->get() == "-t" || I->get() == "--always-on-top") { // force always-on-top window
- init_always_on_top = true;
- } else if (I->get() == "--resolution") { // force resolution
- if (I->next()) {
- String vm = I->next()->get();
- if (vm.find("x") == -1) { // invalid parameter format
- OS::get_singleton()->print("Invalid resolution '%s', it should be e.g. '1280x720'.\n", vm.utf8().get_data());
- goto error;
- }
- int w = vm.get_slice("x", 0).to_int();
- int h = vm.get_slice("x", 1).to_int();
- if (w <= 0 || h <= 0) {
- OS::get_singleton()->print("Invalid resolution '%s', width and height must be above 0.\n", vm.utf8().get_data());
- goto error;
- }
- window_size.width = w;
- window_size.height = h;
- force_res = true;
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing resolution argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--position") { // set window position
- if (I->next()) {
- String vm = I->next()->get();
- if (vm.find(",") == -1) { // invalid parameter format
- OS::get_singleton()->print("Invalid position '%s', it should be e.g. '80,128'.\n", vm.utf8().get_data());
- goto error;
- }
- int x = vm.get_slice(",", 0).to_int();
- int y = vm.get_slice(",", 1).to_int();
- init_custom_pos = Point2(x, y);
- init_use_custom_pos = true;
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing position argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--low-dpi") { // force low DPI (macOS only)
- force_lowdpi = true;
- } else if (I->get() == "--no-window") { // disable window creation (Windows only)
- OS::get_singleton()->set_no_window_mode(true);
- } else if (I->get() == "--enable-vsync-via-compositor") {
- window_vsync_via_compositor = true;
- saw_vsync_via_compositor_override = true;
- } else if (I->get() == "--disable-vsync-via-compositor") {
- window_vsync_via_compositor = false;
- saw_vsync_via_compositor_override = true;
- #endif
- } else if (I->get() == "--profiling") { // enable profiling
- use_debug_profiler = true;
- } else if (I->get() == "-l" || I->get() == "--language") { // language
- if (I->next()) {
- locale = I->next()->get();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing language argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--remote-fs") { // remote filesystem
- if (I->next()) {
- remotefs = I->next()->get();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing remote filesystem address, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--remote-fs-password") { // remote filesystem password
- if (I->next()) {
- remotefs_pass = I->next()->get();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing remote filesystem password, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--render-thread") { // render thread mode
- if (I->next()) {
- if (I->next()->get() == "safe")
- rtm = OS::RENDER_THREAD_SAFE;
- else if (I->next()->get() == "unsafe")
- rtm = OS::RENDER_THREAD_UNSAFE;
- else if (I->next()->get() == "separate")
- rtm = OS::RENDER_SEPARATE_THREAD;
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing render thread mode argument, aborting.\n");
- goto error;
- }
- #ifdef TOOLS_ENABLED
- } else if (I->get() == "-e" || I->get() == "--editor") { // starts editor
- editor = true;
- } else if (I->get() == "-p" || I->get() == "--project-manager") { // starts project manager
- project_manager = true;
- } else if (I->get() == "--build-solutions") { // Build the scripting solution such C#
- auto_build_solutions = true;
- editor = true;
- #ifdef DEBUG_METHODS_ENABLED
- } else if (I->get() == "--gdnative-generate-json-api") {
- // Register as an editor instance to use low-end fallback if relevant.
- editor = true;
- // We still pass it to the main arguments since the argument handling itself is not done in this function
- main_args.push_back(I->get());
- #endif
- } else if (I->get() == "--export" || I->get() == "--export-debug" || I->get() == "--export-pack") { // Export project
- editor = true;
- main_args.push_back(I->get());
- #endif
- } else if (I->get() == "--path") { // set path of project to start or edit
- if (I->next()) {
- String p = I->next()->get();
- if (OS::get_singleton()->set_cwd(p) == OK) {
- //nothing
- } else {
- project_path = I->next()->get(); //use project_path instead
- }
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing relative or absolute path, aborting.\n");
- goto error;
- }
- } else if (I->get() == "-u" || I->get() == "--upwards") { // scan folders upwards
- upwards = true;
- } else if (I->get() == "-q" || I->get() == "--quit") { // Auto quit at the end of the first main loop iteration
- auto_quit = true;
- } else if (I->get().ends_with("project.godot")) {
- String path;
- String file = I->get();
- int sep = MAX(file.find_last("/"), file.find_last("\\"));
- if (sep == -1)
- path = ".";
- else {
- path = file.substr(0, sep);
- }
- if (OS::get_singleton()->set_cwd(path) == OK) {
- // path already specified, don't override
- } else {
- project_path = path;
- }
- #ifdef TOOLS_ENABLED
- editor = true;
- #endif
- } else if (I->get() == "-b" || I->get() == "--breakpoints") { // add breakpoints
- if (I->next()) {
- String bplist = I->next()->get();
- breakpoints = bplist.split(",");
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing list of breakpoints, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--frame-delay") { // force frame delay
- if (I->next()) {
- frame_delay = I->next()->get().to_int();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing frame delay argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--time-scale") { // force time scale
- if (I->next()) {
- Engine::get_singleton()->set_time_scale(I->next()->get().to_double());
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing time scale argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--main-pack") {
- if (I->next()) {
- main_pack = I->next()->get();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing path to main pack file, aborting.\n");
- goto error;
- };
- } else if (I->get() == "-d" || I->get() == "--debug") {
- debug_uri = "local://";
- #if defined(DEBUG_ENABLED) && !defined(SERVER_ENABLED)
- } else if (I->get() == "--debug-collisions") {
- debug_collisions = true;
- } else if (I->get() == "--debug-navigation") {
- debug_navigation = true;
- #endif
- } else if (I->get() == "--remote-debug") {
- if (I->next()) {
- debug_uri = I->next()->get();
- if (debug_uri.find(":") == -1) { // wrong address
- OS::get_singleton()->print("Invalid debug host address, it should be of the form <host/IP>:<port>.\n");
- goto error;
- }
- debug_uri = "tcp://" + debug_uri; // will support multiple protocols eventually.
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing remote debug host address, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--allow_focus_steal_pid") { // not exposed to user
- if (I->next()) {
- allow_focus_steal_pid = I->next()->get().to_int64();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing editor PID argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--disable-render-loop") {
- disable_render_loop = true;
- } else if (I->get() == "--fixed-fps") {
- if (I->next()) {
- fixed_fps = I->next()->get().to_int();
- N = I->next()->next();
- } else {
- OS::get_singleton()->print("Missing fixed-fps argument, aborting.\n");
- goto error;
- }
- } else if (I->get() == "--print-fps") {
- print_fps = true;
- } else if (I->get() == "--disable-crash-handler") {
- OS::get_singleton()->disable_crash_handler();
- } else if (I->get() == "--skip-breakpoints") {
- skip_breakpoints = true;
- } else {
- main_args.push_back(I->get());
- }
- I = N;
- }
- #ifdef TOOLS_ENABLED
- if (editor && project_manager) {
- OS::get_singleton()->print("Error: Command line arguments implied opening both editor and project manager, which is not possible. Aborting.\n");
- goto error;
- }
- #endif
- // Network file system needs to be configured before globals, since globals are based on the
- // 'project.godot' file which will only be available through the network if this is enabled
- FileAccessNetwork::configure();
- if (remotefs != "") {
- file_access_network_client = memnew(FileAccessNetworkClient);
- int port;
- if (remotefs.find(":") != -1) {
- port = remotefs.get_slicec(':', 1).to_int();
- remotefs = remotefs.get_slicec(':', 0);
- } else {
- port = 6010;
- }
- Error err = file_access_network_client->connect(remotefs, port, remotefs_pass);
- if (err) {
- OS::get_singleton()->printerr("Could not connect to remotefs: %s:%i.\n", remotefs.utf8().get_data(), port);
- goto error;
- }
- FileAccess::make_default<FileAccessNetwork>(FileAccess::ACCESS_RESOURCES);
- }
- if (globals->setup(project_path, main_pack, upwards) == OK) {
- #ifdef TOOLS_ENABLED
- found_project = true;
- #endif
- } else {
- #ifdef TOOLS_ENABLED
- editor = false;
- #else
- const String error_msg = "Error: Couldn't load project data at path \"" + project_path + "\". Is the .pck file missing?\nIf you've renamed the executable, the associated .pck file should also be renamed to match the executable's name (without the extension).\n";
- OS::get_singleton()->print("%s", error_msg.ascii().get_data());
- DisplayServer::get_singleton()->alert(error_msg);
- goto error;
- #endif
- }
- GLOBAL_DEF("memory/limits/multithreaded_server/rid_pool_prealloc", 60);
- ProjectSettings::get_singleton()->set_custom_property_info("memory/limits/multithreaded_server/rid_pool_prealloc", PropertyInfo(Variant::INT, "memory/limits/multithreaded_server/rid_pool_prealloc", PROPERTY_HINT_RANGE, "0,500,1")); // No negative and limit to 500 due to crashes
- GLOBAL_DEF("network/limits/debugger/max_chars_per_second", 32768);
- ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger/max_chars_per_second", PropertyInfo(Variant::INT, "network/limits/debugger/max_chars_per_second", PROPERTY_HINT_RANGE, "0, 4096, 1, or_greater"));
- GLOBAL_DEF("network/limits/debugger/max_queued_messages", 2048);
- ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger/max_queued_messages", PropertyInfo(Variant::INT, "network/limits/debugger/max_queued_messages", PROPERTY_HINT_RANGE, "0, 8192, 1, or_greater"));
- GLOBAL_DEF("network/limits/debugger/max_errors_per_second", 400);
- ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger/max_errors_per_second", PropertyInfo(Variant::INT, "network/limits/debugger/max_errors_per_second", PROPERTY_HINT_RANGE, "0, 200, 1, or_greater"));
- GLOBAL_DEF("network/limits/debugger/max_warnings_per_second", 400);
- ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger/max_warnings_per_second", PropertyInfo(Variant::INT, "network/limits/debugger/max_warnings_per_second", PROPERTY_HINT_RANGE, "0, 200, 1, or_greater"));
- EngineDebugger::initialize(debug_uri, skip_breakpoints, breakpoints);
- #ifdef TOOLS_ENABLED
- if (editor) {
- packed_data->set_disabled(true);
- globals->set_disable_feature_overrides(true);
- }
- #endif
- GLOBAL_DEF("logging/file_logging/enable_file_logging", false);
- GLOBAL_DEF("logging/file_logging/log_path", "user://logs/log.txt");
- GLOBAL_DEF("logging/file_logging/max_log_files", 10);
- ProjectSettings::get_singleton()->set_custom_property_info("logging/file_logging/max_log_files", PropertyInfo(Variant::INT, "logging/file_logging/max_log_files", PROPERTY_HINT_RANGE, "0,20,1,or_greater")); //no negative numbers
- if (FileAccess::get_create_func(FileAccess::ACCESS_USERDATA) && GLOBAL_GET("logging/file_logging/enable_file_logging")) {
- String base_path = GLOBAL_GET("logging/file_logging/log_path");
- int max_files = GLOBAL_GET("logging/file_logging/max_log_files");
- OS::get_singleton()->add_logger(memnew(RotatedFileLogger(base_path, max_files)));
- }
- #ifdef TOOLS_ENABLED
- if (editor) {
- Engine::get_singleton()->set_editor_hint(true);
- main_args.push_back("--editor");
- if (!init_windowed) {
- init_maximized = true;
- window_mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
- }
- }
- if (!project_manager && !editor) {
- // Determine if the project manager should be requested
- project_manager = main_args.size() == 0 && !found_project;
- }
- #endif
- if (main_args.size() == 0 && String(GLOBAL_DEF("application/run/main_scene", "")) == "") {
- #ifdef TOOLS_ENABLED
- if (!editor && !project_manager) {
- #endif
- OS::get_singleton()->print("Error: Can't run project: no main scene defined.\n");
- goto error;
- #ifdef TOOLS_ENABLED
- }
- #endif
- }
- if (editor || project_manager) {
- Engine::get_singleton()->set_editor_hint(true);
- use_custom_res = false;
- input_map->load_default(); //keys for editor
- } else {
- input_map->load_from_globals(); //keys for game
- }
- if (bool(ProjectSettings::get_singleton()->get("application/run/disable_stdout"))) {
- quiet_stdout = true;
- }
- if (bool(ProjectSettings::get_singleton()->get("application/run/disable_stderr"))) {
- _print_error_enabled = false;
- };
- if (quiet_stdout)
- _print_line_enabled = false;
- OS::get_singleton()->set_cmdline(execpath, main_args);
- GLOBAL_DEF("rendering/quality/driver/driver_name", "Vulkan");
- ProjectSettings::get_singleton()->set_custom_property_info("rendering/quality/driver/driver_name", PropertyInfo(Variant::STRING, "rendering/quality/driver/driver_name", PROPERTY_HINT_ENUM, "Vulkan,GLES2"));
- if (display_driver == "") {
- display_driver = GLOBAL_GET("rendering/quality/driver/driver_name");
- }
- // Assigning here even though it's GLES2-specific, to be sure that it appears in docs
- GLOBAL_DEF("rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround", false);
- GLOBAL_DEF("display/window/size/width", 1024);
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/size/width", PropertyInfo(Variant::INT, "display/window/size/width", PROPERTY_HINT_RANGE, "0,7680,or_greater")); // 8K resolution
- GLOBAL_DEF("display/window/size/height", 600);
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/size/height", PropertyInfo(Variant::INT, "display/window/size/height", PROPERTY_HINT_RANGE, "0,4320,or_greater")); // 8K resolution
- GLOBAL_DEF("display/window/size/resizable", true);
- GLOBAL_DEF("display/window/size/borderless", false);
- GLOBAL_DEF("display/window/size/fullscreen", false);
- GLOBAL_DEF("display/window/size/always_on_top", false);
- GLOBAL_DEF("display/window/size/test_width", 0);
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/size/test_width", PropertyInfo(Variant::INT, "display/window/size/test_width", PROPERTY_HINT_RANGE, "0,7680,or_greater")); // 8K resolution
- GLOBAL_DEF("display/window/size/test_height", 0);
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/size/test_height", PropertyInfo(Variant::INT, "display/window/size/test_height", PROPERTY_HINT_RANGE, "0,4320,or_greater")); // 8K resolution
- if (use_custom_res) {
- if (!force_res) {
- window_size.width = GLOBAL_GET("display/window/size/width");
- window_size.height = GLOBAL_GET("display/window/size/height");
- if (globals->has_setting("display/window/size/test_width") && globals->has_setting("display/window/size/test_height")) {
- int tw = globals->get("display/window/size/test_width");
- if (tw > 0) {
- window_size.width = tw;
- }
- int th = globals->get("display/window/size/test_height");
- if (th > 0) {
- window_size.height = th;
- }
- }
- }
- if (!bool(GLOBAL_GET("display/window/size/resizable"))) {
- window_flags |= DisplayServer::WINDOW_FLAG_RESIZE_DISABLED_BIT;
- }
- if (bool(GLOBAL_GET("display/window/size/borderless"))) {
- window_flags |= DisplayServer::WINDOW_FLAG_BORDERLESS_BIT;
- }
- if (bool(GLOBAL_GET("display/window/size/fullscreen"))) {
- window_mode = DisplayServer::WINDOW_MODE_FULLSCREEN;
- }
- if (bool(GLOBAL_GET("display/window/size/always_on_top"))) {
- window_flags |= DisplayServer::WINDOW_FLAG_ALWAYS_ON_TOP;
- }
- }
- if (!force_lowdpi) {
- OS::get_singleton()->_allow_hidpi = GLOBAL_DEF("display/window/dpi/allow_hidpi", false);
- }
- use_vsync = GLOBAL_DEF_RST("display/window/vsync/use_vsync", true);
- OS::get_singleton()->_use_vsync = use_vsync;
- if (!saw_vsync_via_compositor_override) {
- // If one of the command line options to enable/disable vsync via the
- // window compositor ("--enable-vsync-via-compositor" or
- // "--disable-vsync-via-compositor") was present then it overrides the
- // project setting.
- window_vsync_via_compositor = GLOBAL_DEF("display/window/vsync/vsync_via_compositor", false);
- }
- OS::get_singleton()->_vsync_via_compositor = window_vsync_via_compositor;
- if (!disable_wintab) {
- // No "--disable_wintab" option
- disable_wintab = GLOBAL_DEF("display/window/disable_wintab_api", false);
- }
- OS::get_singleton()->_disable_wintab = disable_wintab;
- /* todo restore
- OS::get_singleton()->_allow_layered = GLOBAL_DEF("display/window/per_pixel_transparency/allowed", false);
- video_mode.layered = GLOBAL_DEF("display/window/per_pixel_transparency/enabled", false);
- */
- GLOBAL_DEF("rendering/quality/intended_usage/framebuffer_allocation", 2);
- GLOBAL_DEF("rendering/quality/intended_usage/framebuffer_allocation.mobile", 3);
- if (editor || project_manager) {
- // The editor and project manager always detect and use hiDPI if needed
- OS::get_singleton()->_allow_hidpi = true;
- OS::get_singleton()->_allow_layered = false;
- }
- Engine::get_singleton()->_pixel_snap = GLOBAL_DEF("rendering/quality/2d/use_pixel_snap", false);
- OS::get_singleton()->_keep_screen_on = GLOBAL_DEF("display/window/energy_saving/keep_screen_on", true);
- if (rtm == -1) {
- rtm = GLOBAL_DEF("rendering/threads/thread_model", OS::RENDER_THREAD_SAFE);
- }
- if (rtm >= 0 && rtm < 3) {
- if (editor) {
- rtm = OS::RENDER_THREAD_SAFE;
- }
- OS::get_singleton()->_render_thread_mode = OS::RenderThreadMode(rtm);
- }
- /* Determine audio and video drivers */
- for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
- if (display_driver == DisplayServer::get_create_function_name(i)) {
- display_driver_idx = i;
- break;
- }
- }
- if (display_driver_idx < 0) {
- display_driver_idx = 0;
- }
- if (audio_driver == "") { // specified in project.godot
- audio_driver = GLOBAL_DEF_RST("audio/driver", AudioDriverManager::get_driver(0)->get_name());
- }
- for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
- if (audio_driver == AudioDriverManager::get_driver(i)->get_name()) {
- audio_driver_idx = i;
- break;
- }
- }
- if (audio_driver_idx < 0) {
- audio_driver_idx = 0;
- }
- {
- String orientation = GLOBAL_DEF("display/window/handheld/orientation", "landscape");
- if (orientation == "portrait")
- window_orientation = DisplayServer::SCREEN_PORTRAIT;
- else if (orientation == "reverse_landscape")
- window_orientation = DisplayServer::SCREEN_REVERSE_LANDSCAPE;
- else if (orientation == "reverse_portrait")
- window_orientation = DisplayServer::SCREEN_REVERSE_PORTRAIT;
- else if (orientation == "sensor_landscape")
- window_orientation = DisplayServer::SCREEN_SENSOR_LANDSCAPE;
- else if (orientation == "sensor_portrait")
- window_orientation = DisplayServer::SCREEN_SENSOR_PORTRAIT;
- else if (orientation == "sensor")
- window_orientation = DisplayServer::SCREEN_SENSOR;
- else
- window_orientation = DisplayServer::SCREEN_LANDSCAPE;
- }
- Engine::get_singleton()->set_iterations_per_second(GLOBAL_DEF("physics/common/physics_fps", 60));
- ProjectSettings::get_singleton()->set_custom_property_info("physics/common/physics_fps", PropertyInfo(Variant::INT, "physics/common/physics_fps", PROPERTY_HINT_RANGE, "1,120,1,or_greater"));
- Engine::get_singleton()->set_physics_jitter_fix(GLOBAL_DEF("physics/common/physics_jitter_fix", 0.5));
- Engine::get_singleton()->set_target_fps(GLOBAL_DEF("debug/settings/fps/force_fps", 0));
- ProjectSettings::get_singleton()->set_custom_property_info("debug/settings/fps/force_fps", PropertyInfo(Variant::INT, "debug/settings/fps/force_fps", PROPERTY_HINT_RANGE, "0,120,1,or_greater"));
- GLOBAL_DEF("debug/settings/stdout/print_fps", false);
- GLOBAL_DEF("debug/settings/stdout/verbose_stdout", false);
- if (!OS::get_singleton()->_verbose_stdout) { // Not manually overridden.
- OS::get_singleton()->_verbose_stdout = GLOBAL_GET("debug/settings/stdout/verbose_stdout");
- }
- if (frame_delay == 0) {
- frame_delay = GLOBAL_DEF("application/run/frame_delay_msec", 0);
- ProjectSettings::get_singleton()->set_custom_property_info("application/run/frame_delay_msec", PropertyInfo(Variant::INT, "application/run/frame_delay_msec", PROPERTY_HINT_RANGE, "0,100,1,or_greater")); // No negative numbers
- }
- OS::get_singleton()->set_low_processor_usage_mode(GLOBAL_DEF("application/run/low_processor_mode", false));
- OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(GLOBAL_DEF("application/run/low_processor_mode_sleep_usec", 6900)); // Roughly 144 FPS
- ProjectSettings::get_singleton()->set_custom_property_info("application/run/low_processor_mode_sleep_usec", PropertyInfo(Variant::INT, "application/run/low_processor_mode_sleep_usec", PROPERTY_HINT_RANGE, "0,33200,1,or_greater")); // No negative numbers
- GLOBAL_DEF("display/window/ios/hide_home_indicator", true);
- Engine::get_singleton()->set_frame_delay(frame_delay);
- message_queue = memnew(MessageQueue);
- if (p_second_phase)
- return setup2();
- return OK;
- error:
- display_driver = "";
- audio_driver = "";
- project_path = "";
- args.clear();
- main_args.clear();
- if (show_help)
- print_help(execpath);
- EngineDebugger::deinitialize();
- if (performance)
- memdelete(performance);
- if (input_map)
- memdelete(input_map);
- if (translation_server)
- memdelete(translation_server);
- if (globals)
- memdelete(globals);
- if (engine)
- memdelete(engine);
- if (packed_data)
- memdelete(packed_data);
- if (file_access_network_client)
- memdelete(file_access_network_client);
- unregister_core_driver_types();
- unregister_core_types();
- OS::get_singleton()->_cmdline.clear();
- if (message_queue)
- memdelete(message_queue);
- OS::get_singleton()->finalize_core();
- locale = String();
- return ERR_INVALID_PARAMETER;
- }
- Error Main::setup2(Thread::ID p_main_tid_override) {
- preregister_module_types();
- preregister_server_types();
- // Print engine name and version
- print_line(String(VERSION_NAME) + " v" + get_full_version_string() + " - " + String(VERSION_WEBSITE));
- if (p_main_tid_override) {
- Thread::_main_thread_id = p_main_tid_override;
- }
- /* Initialize user data dir */
- OS::get_singleton()->ensure_user_data_dir();
- /* Initialize Input */
- input = memnew(Input);
- /* Iniitalize Display Server */
- {
- String rendering_driver; // temp broken
- Error err;
- display_server = DisplayServer::create(display_driver_idx, rendering_driver, window_mode, window_flags, window_size, err);
- if (err != OK) {
- //ok i guess we can't use this display server, try other ones
- for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
- if (i == display_driver_idx) {
- continue; //don't try the same twice
- }
- display_server = DisplayServer::create(display_driver_idx, rendering_driver, window_mode, window_flags, window_size, err);
- if (err == OK) {
- break;
- }
- }
- }
- if (!display_server) {
- ERR_PRINT("Unable to create DisplayServer, all display drivers failed.");
- return err;
- }
- }
- if (display_server->has_feature(DisplayServer::FEATURE_ORIENTATION)) {
- display_server->screen_set_orientation(window_orientation);
- }
- /* Initialize Visual Server */
- rendering_server = memnew(RenderingServerRaster);
- if (OS::get_singleton()->get_render_thread_mode() != OS::RENDER_THREAD_UNSAFE) {
- rendering_server = memnew(RenderingServerWrapMT(rendering_server, OS::get_singleton()->get_render_thread_mode() == OS::RENDER_SEPARATE_THREAD));
- }
- rendering_server->init();
- OS::get_singleton()->initialize_joypads();
- /* Initialize Audio Driver */
- AudioDriverManager::initialize(audio_driver_idx);
- print_line(" "); //add a blank line for readability
- if (init_use_custom_pos) {
- display_server->window_set_position(init_custom_pos);
- }
- // right moment to create and initialize the audio server
- audio_server = memnew(AudioServer);
- audio_server->init();
- // also init our xr_server from here
- xr_server = memnew(XRServer);
- register_core_singletons();
- MAIN_PRINT("Main: Setup Logo");
- #ifdef JAVASCRIPT_ENABLED
- bool show_logo = false;
- #else
- bool show_logo = true;
- #endif
- if (init_screen != -1) {
- DisplayServer::get_singleton()->window_set_current_screen(init_screen);
- }
- if (init_windowed) {
- //do none..
- } else if (init_maximized) {
- DisplayServer::get_singleton()->window_set_mode(DisplayServer::WINDOW_MODE_MAXIMIZED);
- } else if (init_fullscreen) {
- DisplayServer::get_singleton()->window_set_mode(DisplayServer::WINDOW_MODE_FULLSCREEN);
- }
- if (init_always_on_top) {
- DisplayServer::get_singleton()->window_set_flag(DisplayServer::WINDOW_FLAG_ALWAYS_ON_TOP, true);
- }
- if (allow_focus_steal_pid) {
- DisplayServer::get_singleton()->enable_for_stealing_focus(allow_focus_steal_pid);
- }
- register_server_types();
- MAIN_PRINT("Main: Load Remaps");
- Color clear = GLOBAL_DEF("rendering/environment/default_clear_color", Color(0.3, 0.3, 0.3));
- RenderingServer::get_singleton()->set_default_clear_color(clear);
- if (show_logo) { //boot logo!
- String boot_logo_path = GLOBAL_DEF("application/boot_splash/image", String());
- bool boot_logo_scale = GLOBAL_DEF("application/boot_splash/fullsize", true);
- bool boot_logo_filter = GLOBAL_DEF("application/boot_splash/use_filter", true);
- ProjectSettings::get_singleton()->set_custom_property_info("application/boot_splash/image", PropertyInfo(Variant::STRING, "application/boot_splash/image", PROPERTY_HINT_FILE, "*.png"));
- Ref<Image> boot_logo;
- boot_logo_path = boot_logo_path.strip_edges();
- if (boot_logo_path != String()) {
- boot_logo.instance();
- Error load_err = ImageLoader::load_image(boot_logo_path, boot_logo);
- if (load_err)
- ERR_PRINT("Non-existing or invalid boot splash at '" + boot_logo_path + "'. Loading default splash.");
- }
- Color boot_bg_color = GLOBAL_DEF("application/boot_splash/bg_color", boot_splash_bg_color);
- if (boot_logo.is_valid()) {
- OS::get_singleton()->_msec_splash = OS::get_singleton()->get_ticks_msec();
- RenderingServer::get_singleton()->set_boot_image(boot_logo, boot_bg_color, boot_logo_scale, boot_logo_filter);
- } else {
- #ifndef NO_DEFAULT_BOOT_LOGO
- MAIN_PRINT("Main: Create bootsplash");
- #if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
- Ref<Image> splash = (editor || project_manager) ? memnew(Image(boot_splash_editor_png)) : memnew(Image(boot_splash_png));
- #else
- Ref<Image> splash = memnew(Image(boot_splash_png));
- #endif
- MAIN_PRINT("Main: ClearColor");
- RenderingServer::get_singleton()->set_default_clear_color(boot_bg_color);
- MAIN_PRINT("Main: Image");
- RenderingServer::get_singleton()->set_boot_image(splash, boot_bg_color, false);
- #endif
- }
- #ifdef TOOLS_ENABLED
- Ref<Image> icon = memnew(Image(app_icon_png));
- DisplayServer::get_singleton()->set_icon(icon);
- #endif
- }
- MAIN_PRINT("Main: DCC");
- RenderingServer::get_singleton()->set_default_clear_color(GLOBAL_DEF("rendering/environment/default_clear_color", Color(0.3, 0.3, 0.3)));
- MAIN_PRINT("Main: END");
- GLOBAL_DEF("application/config/icon", String());
- ProjectSettings::get_singleton()->set_custom_property_info("application/config/icon", PropertyInfo(Variant::STRING, "application/config/icon", PROPERTY_HINT_FILE, "*.png,*.webp"));
- GLOBAL_DEF("application/config/macos_native_icon", String());
- ProjectSettings::get_singleton()->set_custom_property_info("application/config/macos_native_icon", PropertyInfo(Variant::STRING, "application/config/macos_native_icon", PROPERTY_HINT_FILE, "*.icns"));
- GLOBAL_DEF("application/config/windows_native_icon", String());
- ProjectSettings::get_singleton()->set_custom_property_info("application/config/windows_native_icon", PropertyInfo(Variant::STRING, "application/config/windows_native_icon", PROPERTY_HINT_FILE, "*.ico"));
- Input *id = Input::get_singleton();
- if (id) {
- if (bool(GLOBAL_DEF("input_devices/pointing/emulate_touch_from_mouse", false)) && !(editor || project_manager)) {
- bool found_touchscreen = false;
- for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
- if (DisplayServer::get_singleton()->screen_is_touchscreen(i)) {
- found_touchscreen = true;
- }
- }
- if (!found_touchscreen) {
- //only if no touchscreen ui hint, set emulation
- id->set_emulate_touch_from_mouse(true);
- }
- }
- id->set_emulate_mouse_from_touch(bool(GLOBAL_DEF("input_devices/pointing/emulate_mouse_from_touch", true)));
- }
- MAIN_PRINT("Main: Load Remaps");
- MAIN_PRINT("Main: Load Scene Types");
- register_scene_types();
- GLOBAL_DEF("display/mouse_cursor/custom_image", String());
- GLOBAL_DEF("display/mouse_cursor/custom_image_hotspot", Vector2());
- GLOBAL_DEF("display/mouse_cursor/tooltip_position_offset", Point2(10, 10));
- ProjectSettings::get_singleton()->set_custom_property_info("display/mouse_cursor/custom_image", PropertyInfo(Variant::STRING, "display/mouse_cursor/custom_image", PROPERTY_HINT_FILE, "*.png,*.webp"));
- if (String(ProjectSettings::get_singleton()->get("display/mouse_cursor/custom_image")) != String()) {
- Ref<Texture2D> cursor = ResourceLoader::load(ProjectSettings::get_singleton()->get("display/mouse_cursor/custom_image"));
- if (cursor.is_valid()) {
- Vector2 hotspot = ProjectSettings::get_singleton()->get("display/mouse_cursor/custom_image_hotspot");
- Input::get_singleton()->set_custom_mouse_cursor(cursor, Input::CURSOR_ARROW, hotspot);
- }
- }
- #ifdef TOOLS_ENABLED
- ClassDB::set_current_api(ClassDB::API_EDITOR);
- EditorNode::register_editor_types();
- ClassDB::set_current_api(ClassDB::API_CORE);
- #endif
- MAIN_PRINT("Main: Load Modules, Physics, Drivers, Scripts");
- register_platform_apis();
- register_module_types();
- camera_server = CameraServer::create();
- initialize_physics();
- initialize_navigation_server();
- register_server_singletons();
- register_driver_types();
- // This loads global classes, so it must happen before custom loaders and savers are registered
- ScriptServer::init_languages();
- MAIN_PRINT("Main: Load Translations");
- translation_server->setup(); //register translations, load them, etc.
- if (locale != "") {
- translation_server->set_locale(locale);
- }
- translation_server->load_translations();
- ResourceLoader::load_translation_remaps(); //load remaps for resources
- ResourceLoader::load_path_remaps();
- audio_server->load_default_bus_layout();
- if (use_debug_profiler && EngineDebugger::is_active()) {
- // Start the "scripts" profiler, used in local debugging.
- // We could add more, and make the CLI arg require a comma-separated list of profilers.
- EngineDebugger::get_singleton()->profiler_enable("scripts", true);
- }
- if (!project_manager) {
- // If not running the project manager, and now that the engine is
- // able to load resources, load the global shader variables.
- // If running on editor, dont load the textures because the editor
- // may want to import them first. Editor will reload those later.
- rendering_server->global_variables_load_settings(!editor);
- }
- _start_success = true;
- locale = String();
- ClassDB::set_current_api(ClassDB::API_NONE); //no more api is registered at this point
- print_verbose("CORE API HASH: " + uitos(ClassDB::get_api_hash(ClassDB::API_CORE)));
- print_verbose("EDITOR API HASH: " + uitos(ClassDB::get_api_hash(ClassDB::API_EDITOR)));
- MAIN_PRINT("Main: Done");
- return OK;
- }
- // everything the main loop needs to know about frame timings
- static MainTimerSync main_timer_sync;
- bool Main::start() {
- ERR_FAIL_COND_V(!_start_success, false);
- bool hasicon = false;
- String doc_tool;
- List<String> removal_docs;
- String positional_arg;
- String game_path;
- String script;
- String test;
- bool check_only = false;
- #ifdef TOOLS_ENABLED
- bool doc_base = true;
- String _export_preset;
- bool export_debug = false;
- bool export_pack_only = false;
- #endif
- main_timer_sync.init(OS::get_singleton()->get_ticks_usec());
- List<String> args = OS::get_singleton()->get_cmdline_args();
- for (int i = 0; i < args.size(); i++) {
- //parameters that do not have an argument to the right
- if (args[i] == "--check-only") {
- check_only = true;
- #ifdef TOOLS_ENABLED
- } else if (args[i] == "--no-docbase") {
- doc_base = false;
- } else if (args[i] == "-e" || args[i] == "--editor") {
- editor = true;
- } else if (args[i] == "-p" || args[i] == "--project-manager") {
- project_manager = true;
- #endif
- } else if (args[i].length() && args[i][0] != '-' && positional_arg == "") {
- positional_arg = args[i];
- if (args[i].ends_with(".scn") || args[i].ends_with(".tscn") || args[i].ends_with(".escn")) {
- // Only consider the positional argument to be a scene path if it ends with
- // a file extension associated with Godot scenes. This makes it possible
- // for projects to parse command-line arguments for custom CLI arguments
- // or other file extensions without trouble. This can be used to implement
- // "drag-and-drop onto executable" logic, which can prove helpful
- // for non-game applications.
- game_path = args[i];
- }
- }
- //parameters that have an argument to the right
- else if (i < (args.size() - 1)) {
- bool parsed_pair = true;
- if (args[i] == "-s" || args[i] == "--script") {
- script = args[i + 1];
- } else if (args[i] == "--test") {
- test = args[i + 1];
- #ifdef TOOLS_ENABLED
- } else if (args[i] == "--doctool") {
- doc_tool = args[i + 1];
- for (int j = i + 2; j < args.size(); j++)
- removal_docs.push_back(args[j]);
- } else if (args[i] == "--export") {
- editor = true; //needs editor
- _export_preset = args[i + 1];
- } else if (args[i] == "--export-debug") {
- editor = true; //needs editor
- _export_preset = args[i + 1];
- export_debug = true;
- } else if (args[i] == "--export-pack") {
- editor = true;
- _export_preset = args[i + 1];
- export_pack_only = true;
- #endif
- } else {
- // The parameter does not match anything known, don't skip the next argument
- parsed_pair = false;
- }
- if (parsed_pair) {
- i++;
- }
- }
- }
- String main_loop_type;
- #ifdef TOOLS_ENABLED
- if (doc_tool != "") {
- Engine::get_singleton()->set_editor_hint(true); // Needed to instance editor-only classes for their default values
- {
- DirAccessRef da = DirAccess::open(doc_tool);
- ERR_FAIL_COND_V_MSG(!da, false, "Argument supplied to --doctool must be a base Godot build directory.");
- }
- #ifndef MODULE_MONO_ENABLED
- // Hack to define Mono-specific project settings even on non-Mono builds,
- // so that we don't lose their descriptions and default values in DocData.
- // Default values should be synced with mono_gd/gd_mono.cpp.
- GLOBAL_DEF("mono/debugger_agent/port", 23685);
- GLOBAL_DEF("mono/debugger_agent/wait_for_debugger", false);
- GLOBAL_DEF("mono/debugger_agent/wait_timeout", 3000);
- GLOBAL_DEF("mono/profiler/args", "log:calls,alloc,sample,output=output.mlpd");
- GLOBAL_DEF("mono/profiler/enabled", false);
- GLOBAL_DEF("mono/unhandled_exception_policy", 0);
- #endif
- DocData doc;
- doc.generate(doc_base);
- DocData docsrc;
- Map<String, String> doc_data_classes;
- Set<String> checked_paths;
- print_line("Loading docs...");
- for (int i = 0; i < _doc_data_class_path_count; i++) {
- String path = doc_tool.plus_file(_doc_data_class_paths[i].path);
- String name = _doc_data_class_paths[i].name;
- doc_data_classes[name] = path;
- if (!checked_paths.has(path)) {
- checked_paths.insert(path);
- // Create the module documentation directory if it doesn't exist
- DirAccess *da = DirAccess::create_for_path(path);
- da->make_dir_recursive(path);
- memdelete(da);
- docsrc.load_classes(path);
- print_line("Loading docs from: " + path);
- }
- }
- String index_path = doc_tool.plus_file("doc/classes");
- // Create the main documentation directory if it doesn't exist
- DirAccess *da = DirAccess::create_for_path(index_path);
- da->make_dir_recursive(index_path);
- memdelete(da);
- docsrc.load_classes(index_path);
- checked_paths.insert(index_path);
- print_line("Loading docs from: " + index_path);
- print_line("Merging docs...");
- doc.merge_from(docsrc);
- for (Set<String>::Element *E = checked_paths.front(); E; E = E->next()) {
- print_line("Erasing old docs at: " + E->get());
- DocData::erase_classes(E->get());
- }
- print_line("Generating new docs...");
- doc.save_classes(index_path, doc_data_classes);
- return false;
- }
- if (_export_preset != "") {
- if (positional_arg == "") {
- String err = "Command line includes export parameter option, but no destination path was given.\n";
- err += "Please specify the binary's file path to export to. Aborting export.";
- ERR_PRINT(err);
- return false;
- }
- }
- #endif
- if (script == "" && game_path == "" && String(GLOBAL_DEF("application/run/main_scene", "")) != "") {
- game_path = GLOBAL_DEF("application/run/main_scene", "");
- }
- MainLoop *main_loop = nullptr;
- if (editor) {
- main_loop = memnew(SceneTree);
- };
- if (test != "") {
- #ifdef TOOLS_ENABLED
- main_loop = test_main(test, args);
- if (!main_loop)
- return false;
- #endif
- } else if (script != "") {
- Ref<Script> script_res = ResourceLoader::load(script);
- ERR_FAIL_COND_V_MSG(script_res.is_null(), false, "Can't load script: " + script);
- if (check_only) {
- if (!script_res->is_valid()) {
- OS::get_singleton()->set_exit_code(1);
- }
- return false;
- }
- if (script_res->can_instance()) {
- StringName instance_type = script_res->get_instance_base_type();
- Object *obj = ClassDB::instance(instance_type);
- MainLoop *script_loop = Object::cast_to<MainLoop>(obj);
- if (!script_loop) {
- if (obj)
- memdelete(obj);
- ERR_FAIL_V_MSG(false, vformat("Can't load the script \"%s\" as it doesn't inherit from SceneTree or MainLoop.", script));
- }
- script_loop->set_init_script(script_res);
- main_loop = script_loop;
- } else {
- return false;
- }
- } else {
- main_loop_type = GLOBAL_DEF("application/run/main_loop_type", "");
- }
- if (!main_loop && main_loop_type == "")
- main_loop_type = "SceneTree";
- if (!main_loop) {
- if (!ClassDB::class_exists(main_loop_type)) {
- DisplayServer::get_singleton()->alert("Error: MainLoop type doesn't exist: " + main_loop_type);
- return false;
- } else {
- Object *ml = ClassDB::instance(main_loop_type);
- ERR_FAIL_COND_V_MSG(!ml, false, "Can't instance MainLoop type.");
- main_loop = Object::cast_to<MainLoop>(ml);
- if (!main_loop) {
- memdelete(ml);
- ERR_FAIL_V_MSG(false, "Invalid MainLoop type.");
- }
- }
- }
- if (main_loop->is_class("SceneTree")) {
- SceneTree *sml = Object::cast_to<SceneTree>(main_loop);
- #ifdef DEBUG_ENABLED
- if (debug_collisions) {
- sml->set_debug_collisions_hint(true);
- }
- if (debug_navigation) {
- sml->set_debug_navigation_hint(true);
- }
- #endif
- bool embed_subwindows = GLOBAL_DEF("display/window/subwindows/embed_subwindows", false);
- if (single_window || (!project_manager && !editor && embed_subwindows)) {
- sml->get_root()->set_embed_subwindows_hint(true);
- }
- ResourceLoader::add_custom_loaders();
- ResourceSaver::add_custom_savers();
- if (!project_manager && !editor) { // game
- if (game_path != "" || script != "") {
- //autoload
- List<PropertyInfo> props;
- ProjectSettings::get_singleton()->get_property_list(&props);
- //first pass, add the constants so they exist before any script is loaded
- for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
- String s = E->get().name;
- if (!s.begins_with("autoload/"))
- continue;
- String name = s.get_slicec('/', 1);
- String path = ProjectSettings::get_singleton()->get(s);
- bool global_var = false;
- if (path.begins_with("*")) {
- global_var = true;
- }
- if (global_var) {
- for (int i = 0; i < ScriptServer::get_language_count(); i++) {
- ScriptServer::get_language(i)->add_global_constant(name, Variant());
- }
- }
- }
- //second pass, load into global constants
- List<Node *> to_add;
- for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
- String s = E->get().name;
- if (!s.begins_with("autoload/"))
- continue;
- String name = s.get_slicec('/', 1);
- String path = ProjectSettings::get_singleton()->get(s);
- bool global_var = false;
- if (path.begins_with("*")) {
- global_var = true;
- path = path.substr(1, path.length() - 1);
- }
- RES res = ResourceLoader::load(path);
- ERR_CONTINUE_MSG(res.is_null(), "Can't autoload: " + path);
- Node *n = nullptr;
- if (res->is_class("PackedScene")) {
- Ref<PackedScene> ps = res;
- n = ps->instance();
- } else if (res->is_class("Script")) {
- Ref<Script> script_res = res;
- StringName ibt = script_res->get_instance_base_type();
- bool valid_type = ClassDB::is_parent_class(ibt, "Node");
- ERR_CONTINUE_MSG(!valid_type, "Script does not inherit a Node: " + path);
- Object *obj = ClassDB::instance(ibt);
- ERR_CONTINUE_MSG(obj == nullptr, "Cannot instance script for autoload, expected 'Node' inheritance, got: " + String(ibt));
- n = Object::cast_to<Node>(obj);
- n->set_script(script_res);
- }
- ERR_CONTINUE_MSG(!n, "Path in autoload not a node or script: " + path);
- n->set_name(name);
- //defer so references are all valid on _ready()
- to_add.push_back(n);
- if (global_var) {
- for (int i = 0; i < ScriptServer::get_language_count(); i++) {
- ScriptServer::get_language(i)->add_global_constant(name, n);
- }
- }
- }
- for (List<Node *>::Element *E = to_add.front(); E; E = E->next()) {
- sml->get_root()->add_child(E->get());
- }
- }
- }
- #ifdef TOOLS_ENABLED
- EditorNode *editor_node = nullptr;
- if (editor) {
- editor_node = memnew(EditorNode);
- sml->get_root()->add_child(editor_node);
- if (_export_preset != "") {
- editor_node->export_preset(_export_preset, positional_arg, export_debug, export_pack_only);
- game_path = ""; // Do not load anything.
- }
- }
- #endif
- {
- int directional_atlas_size = GLOBAL_GET("rendering/quality/directional_shadow/size");
- RenderingServer::get_singleton()->directional_shadow_atlas_set_size(directional_atlas_size);
- }
- if (!editor && !project_manager) {
- //standard helpers that can be changed from main config
- String stretch_mode = GLOBAL_DEF("display/window/stretch/mode", "disabled");
- String stretch_aspect = GLOBAL_DEF("display/window/stretch/aspect", "ignore");
- Size2i stretch_size = Size2(GLOBAL_DEF("display/window/size/width", 0), GLOBAL_DEF("display/window/size/height", 0));
- Window::ContentScaleMode cs_sm = Window::CONTENT_SCALE_MODE_DISABLED;
- if (stretch_mode == "objects")
- cs_sm = Window::CONTENT_SCALE_MODE_OBJECTS;
- else if (stretch_mode == "pixels")
- cs_sm = Window::CONTENT_SCALE_MODE_PIXELS;
- Window::ContentScaleAspect cs_aspect = Window::CONTENT_SCALE_ASPECT_IGNORE;
- if (stretch_aspect == "keep")
- cs_aspect = Window::CONTENT_SCALE_ASPECT_KEEP;
- else if (stretch_aspect == "keep_width")
- cs_aspect = Window::CONTENT_SCALE_ASPECT_KEEP_WIDTH;
- else if (stretch_aspect == "keep_height")
- cs_aspect = Window::CONTENT_SCALE_ASPECT_KEEP_HEIGHT;
- else if (stretch_aspect == "expand")
- cs_aspect = Window::CONTENT_SCALE_ASPECT_EXPAND;
- sml->get_root()->set_content_scale_mode(cs_sm);
- sml->get_root()->set_content_scale_aspect(cs_aspect);
- sml->get_root()->set_content_scale_size(stretch_size);
- sml->set_auto_accept_quit(GLOBAL_DEF("application/config/auto_accept_quit", true));
- sml->set_quit_on_go_back(GLOBAL_DEF("application/config/quit_on_go_back", true));
- String appname = ProjectSettings::get_singleton()->get("application/config/name");
- appname = TranslationServer::get_singleton()->translate(appname);
- DisplayServer::get_singleton()->window_set_title(appname);
- int shadow_atlas_size = GLOBAL_GET("rendering/quality/shadow_atlas/size");
- int shadow_atlas_q0_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_0_subdiv");
- int shadow_atlas_q1_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_1_subdiv");
- int shadow_atlas_q2_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_2_subdiv");
- int shadow_atlas_q3_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_3_subdiv");
- sml->get_root()->set_shadow_atlas_size(shadow_atlas_size);
- sml->get_root()->set_shadow_atlas_quadrant_subdiv(0, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q0_subdiv));
- sml->get_root()->set_shadow_atlas_quadrant_subdiv(1, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q1_subdiv));
- sml->get_root()->set_shadow_atlas_quadrant_subdiv(2, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q2_subdiv));
- sml->get_root()->set_shadow_atlas_quadrant_subdiv(3, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q3_subdiv));
- bool snap_controls = GLOBAL_DEF("gui/common/snap_controls_to_pixels", true);
- sml->get_root()->set_snap_controls_to_pixels(snap_controls);
- bool font_oversampling = GLOBAL_DEF("rendering/quality/dynamic_fonts/use_oversampling", true);
- sml->get_root()->set_use_font_oversampling(font_oversampling);
- int texture_filter = GLOBAL_DEF("rendering/canvas_textures/default_texture_filter", 1);
- int texture_repeat = GLOBAL_DEF("rendering/canvas_textures/default_texture_repeat", 0);
- sml->get_root()->set_default_canvas_item_texture_filter(Viewport::DefaultCanvasItemTextureFilter(texture_filter));
- sml->get_root()->set_default_canvas_item_texture_repeat(Viewport::DefaultCanvasItemTextureRepeat(texture_repeat));
- } else {
- GLOBAL_DEF("display/window/stretch/mode", "disabled");
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/stretch/mode", PropertyInfo(Variant::STRING, "display/window/stretch/mode", PROPERTY_HINT_ENUM, "disabled,2d,viewport"));
- GLOBAL_DEF("display/window/stretch/aspect", "ignore");
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/stretch/aspect", PropertyInfo(Variant::STRING, "display/window/stretch/aspect", PROPERTY_HINT_ENUM, "ignore,keep,keep_width,keep_height,expand"));
- GLOBAL_DEF("display/window/stretch/shrink", 1.0);
- ProjectSettings::get_singleton()->set_custom_property_info("display/window/stretch/shrink", PropertyInfo(Variant::FLOAT, "display/window/stretch/shrink", PROPERTY_HINT_RANGE, "1.0,8.0,0.1"));
- sml->set_auto_accept_quit(GLOBAL_DEF("application/config/auto_accept_quit", true));
- sml->set_quit_on_go_back(GLOBAL_DEF("application/config/quit_on_go_back", true));
- GLOBAL_DEF("gui/common/snap_controls_to_pixels", true);
- GLOBAL_DEF("rendering/quality/dynamic_fonts/use_oversampling", true);
- GLOBAL_DEF("rendering/canvas_textures/default_texture_filter", 1);
- ProjectSettings::get_singleton()->set_custom_property_info("rendering/canvas_textures/default_texture_filter", PropertyInfo(Variant::INT, "rendering/canvas_textures/default_texture_filter", PROPERTY_HINT_ENUM, "Nearest,Linear,MipmapLinear,MipmapNearest"));
- GLOBAL_DEF("rendering/canvas_textures/default_texture_repeat", 0);
- ProjectSettings::get_singleton()->set_custom_property_info("rendering/canvas_textures/default_texture_repeat", PropertyInfo(Variant::INT, "rendering/canvas_textures/default_texture_repeat", PROPERTY_HINT_ENUM, "Disable,Enable,Mirror"));
- }
- String local_game_path;
- if (game_path != "" && !project_manager) {
- local_game_path = game_path.replace("\\", "/");
- if (!local_game_path.begins_with("res://")) {
- bool absolute = (local_game_path.size() > 1) && (local_game_path[0] == '/' || local_game_path[1] == ':');
- if (!absolute) {
- if (ProjectSettings::get_singleton()->is_using_datapack()) {
- local_game_path = "res://" + local_game_path;
- } else {
- int sep = local_game_path.find_last("/");
- if (sep == -1) {
- DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- local_game_path = da->get_current_dir().plus_file(local_game_path);
- memdelete(da);
- } else {
- DirAccess *da = DirAccess::open(local_game_path.substr(0, sep));
- if (da) {
- local_game_path = da->get_current_dir().plus_file(local_game_path.substr(sep + 1, local_game_path.length()));
- memdelete(da);
- }
- }
- }
- }
- }
- local_game_path = ProjectSettings::get_singleton()->localize_path(local_game_path);
- #ifdef TOOLS_ENABLED
- if (editor) {
- bool editor_embed_subwindows = EditorSettings::get_singleton()->get_setting("interface/editor/single_window_mode");
- if (editor_embed_subwindows) {
- sml->get_root()->set_embed_subwindows_hint(true);
- }
- if (game_path != GLOBAL_GET("application/run/main_scene") || !editor_node->has_scenes_in_session()) {
- Error serr = editor_node->load_scene(local_game_path);
- if (serr != OK)
- ERR_PRINT("Failed to load scene");
- }
- DisplayServer::get_singleton()->set_context(DisplayServer::CONTEXT_EDITOR);
- }
- #endif
- if (!editor) {
- DisplayServer::get_singleton()->set_context(DisplayServer::CONTEXT_ENGINE);
- }
- }
- if (!project_manager && !editor) { // game
- // Load SSL Certificates from Project Settings (or builtin).
- Crypto::load_default_certificates(GLOBAL_DEF("network/ssl/certificates", ""));
- if (game_path != "") {
- Node *scene = nullptr;
- Ref<PackedScene> scenedata = ResourceLoader::load(local_game_path);
- if (scenedata.is_valid())
- scene = scenedata->instance();
- ERR_FAIL_COND_V_MSG(!scene, false, "Failed loading scene: " + local_game_path);
- sml->add_current_scene(scene);
- #ifdef OSX_ENABLED
- String mac_iconpath = GLOBAL_DEF("application/config/macos_native_icon", "Variant()");
- if (mac_iconpath != "") {
- DisplayServer::get_singleton()->set_native_icon(mac_iconpath);
- hasicon = true;
- }
- #endif
- #ifdef WINDOWS_ENABLED
- String win_iconpath = GLOBAL_DEF("application/config/windows_native_icon", "Variant()");
- if (win_iconpath != "") {
- DisplayServer::get_singleton()->set_native_icon(win_iconpath);
- hasicon = true;
- }
- #endif
- String iconpath = GLOBAL_DEF("application/config/icon", "Variant()");
- if ((iconpath != "") && (!hasicon)) {
- Ref<Image> icon;
- icon.instance();
- if (ImageLoader::load_image(iconpath, icon) == OK) {
- DisplayServer::get_singleton()->set_icon(icon);
- hasicon = true;
- }
- }
- }
- }
- #ifdef TOOLS_ENABLED
- if (project_manager || (script == "" && test == "" && game_path == "" && !editor)) {
- Engine::get_singleton()->set_editor_hint(true);
- ProjectManager *pmanager = memnew(ProjectManager);
- ProgressDialog *progress_dialog = memnew(ProgressDialog);
- pmanager->add_child(progress_dialog);
- sml->get_root()->add_child(pmanager);
- DisplayServer::get_singleton()->set_context(DisplayServer::CONTEXT_PROJECTMAN);
- project_manager = true;
- }
- if (project_manager || editor) {
- // Hide console window if requested (Windows-only).
- bool hide_console = EditorSettings::get_singleton()->get_setting("interface/editor/hide_console_window");
- DisplayServer::get_singleton()->console_set_visible(!hide_console);
- // Load SSL Certificates from Editor Settings (or builtin)
- Crypto::load_default_certificates(EditorSettings::get_singleton()->get_setting("network/ssl/editor_ssl_certificates").operator String());
- }
- #endif
- }
- if (!hasicon) {
- Ref<Image> icon = memnew(Image(app_icon_png));
- DisplayServer::get_singleton()->set_icon(icon);
- }
- OS::get_singleton()->set_main_loop(main_loop);
- return true;
- }
- /* Main iteration
- *
- * This is the iteration of the engine's game loop, advancing the state of physics,
- * rendering and audio.
- * It's called directly by the platform's OS::run method, where the loop is created
- * and monitored.
- *
- * The OS implementation can impact its draw step with the Main::force_redraw() method.
- */
- uint64_t Main::last_ticks = 0;
- uint64_t Main::target_ticks = 0;
- uint32_t Main::frames = 0;
- uint32_t Main::frame = 0;
- bool Main::force_redraw_requested = false;
- int Main::iterating = 0;
- bool Main::is_iterating() {
- return iterating > 0;
- }
- // For performance metrics.
- static uint64_t physics_process_max = 0;
- static uint64_t idle_process_max = 0;
- bool Main::iteration() {
- //for now do not error on this
- //ERR_FAIL_COND_V(iterating, false);
- iterating++;
- uint64_t ticks = OS::get_singleton()->get_ticks_usec();
- Engine::get_singleton()->_frame_ticks = ticks;
- main_timer_sync.set_cpu_ticks_usec(ticks);
- main_timer_sync.set_fixed_fps(fixed_fps);
- uint64_t ticks_elapsed = ticks - last_ticks;
- int physics_fps = Engine::get_singleton()->get_iterations_per_second();
- float frame_slice = 1.0 / physics_fps;
- float time_scale = Engine::get_singleton()->get_time_scale();
- MainFrameTime advance = main_timer_sync.advance(frame_slice, physics_fps);
- double step = advance.idle_step;
- double scaled_step = step * time_scale;
- Engine::get_singleton()->_frame_step = step;
- Engine::get_singleton()->_physics_interpolation_fraction = advance.interpolation_fraction;
- uint64_t physics_process_ticks = 0;
- uint64_t idle_process_ticks = 0;
- frame += ticks_elapsed;
- last_ticks = ticks;
- static const int max_physics_steps = 8;
- if (fixed_fps == -1 && advance.physics_steps > max_physics_steps) {
- step -= (advance.physics_steps - max_physics_steps) * frame_slice;
- advance.physics_steps = max_physics_steps;
- }
- bool exit = false;
- Engine::get_singleton()->_in_physics = true;
- for (int iters = 0; iters < advance.physics_steps; ++iters) {
- uint64_t physics_begin = OS::get_singleton()->get_ticks_usec();
- PhysicsServer3D::get_singleton()->sync();
- PhysicsServer3D::get_singleton()->flush_queries();
- PhysicsServer2D::get_singleton()->sync();
- PhysicsServer2D::get_singleton()->flush_queries();
- if (OS::get_singleton()->get_main_loop()->iteration(frame_slice * time_scale)) {
- exit = true;
- break;
- }
- NavigationServer3D::get_singleton_mut()->process(frame_slice * time_scale);
- message_queue->flush();
- PhysicsServer3D::get_singleton()->step(frame_slice * time_scale);
- PhysicsServer2D::get_singleton()->end_sync();
- PhysicsServer2D::get_singleton()->step(frame_slice * time_scale);
- message_queue->flush();
- physics_process_ticks = MAX(physics_process_ticks, OS::get_singleton()->get_ticks_usec() - physics_begin); // keep the largest one for reference
- physics_process_max = MAX(OS::get_singleton()->get_ticks_usec() - physics_begin, physics_process_max);
- Engine::get_singleton()->_physics_frames++;
- }
- Engine::get_singleton()->_in_physics = false;
- uint64_t idle_begin = OS::get_singleton()->get_ticks_usec();
- if (OS::get_singleton()->get_main_loop()->idle(step * time_scale)) {
- exit = true;
- }
- message_queue->flush();
- RenderingServer::get_singleton()->sync(); //sync if still drawing from previous frames.
- if (DisplayServer::get_singleton()->can_any_window_draw() && !disable_render_loop) {
- if ((!force_redraw_requested) && OS::get_singleton()->is_in_low_processor_usage_mode()) {
- if (RenderingServer::get_singleton()->has_changed()) {
- RenderingServer::get_singleton()->draw(true, scaled_step); // flush visual commands
- Engine::get_singleton()->frames_drawn++;
- }
- } else {
- RenderingServer::get_singleton()->draw(true, scaled_step); // flush visual commands
- Engine::get_singleton()->frames_drawn++;
- force_redraw_requested = false;
- }
- }
- idle_process_ticks = OS::get_singleton()->get_ticks_usec() - idle_begin;
- idle_process_max = MAX(idle_process_ticks, idle_process_max);
- uint64_t frame_time = OS::get_singleton()->get_ticks_usec() - ticks;
- for (int i = 0; i < ScriptServer::get_language_count(); i++) {
- ScriptServer::get_language(i)->frame();
- }
- AudioServer::get_singleton()->update();
- if (EngineDebugger::is_active())
- EngineDebugger::get_singleton()->iteration(frame_time, idle_process_ticks, physics_process_ticks, frame_slice);
- frames++;
- Engine::get_singleton()->_idle_frames++;
- if (frame > 1000000) {
- if (editor || project_manager) {
- if (print_fps) {
- print_line("Editor FPS: " + itos(frames));
- }
- } else if (GLOBAL_GET("debug/settings/stdout/print_fps") || print_fps) {
- print_line("Game FPS: " + itos(frames));
- }
- Engine::get_singleton()->_fps = frames;
- performance->set_process_time(USEC_TO_SEC(idle_process_max));
- performance->set_physics_process_time(USEC_TO_SEC(physics_process_max));
- idle_process_max = 0;
- physics_process_max = 0;
- frame %= 1000000;
- frames = 0;
- }
- iterating--;
- if (fixed_fps != -1)
- return exit;
- if (OS::get_singleton()->is_in_low_processor_usage_mode() || !DisplayServer::get_singleton()->can_any_window_draw())
- OS::get_singleton()->delay_usec(OS::get_singleton()->get_low_processor_usage_mode_sleep_usec()); //apply some delay to force idle time
- else {
- uint32_t frame_delay = Engine::get_singleton()->get_frame_delay();
- if (frame_delay)
- OS::get_singleton()->delay_usec(Engine::get_singleton()->get_frame_delay() * 1000);
- }
- int target_fps = Engine::get_singleton()->get_target_fps();
- if (target_fps > 0 && !Engine::get_singleton()->is_editor_hint()) {
- uint64_t time_step = 1000000L / target_fps;
- target_ticks += time_step;
- uint64_t current_ticks = OS::get_singleton()->get_ticks_usec();
- if (current_ticks < target_ticks)
- OS::get_singleton()->delay_usec(target_ticks - current_ticks);
- current_ticks = OS::get_singleton()->get_ticks_usec();
- target_ticks = MIN(MAX(target_ticks, current_ticks - time_step), current_ticks + time_step);
- }
- #ifdef TOOLS_ENABLED
- if (auto_build_solutions) {
- auto_build_solutions = false;
- // Only relevant when running the editor.
- if (!editor) {
- ERR_FAIL_V_MSG(true, "Command line option --build-solutions was passed, but no project is being edited. Aborting.");
- }
- if (!EditorNode::get_singleton()->call_build()) {
- ERR_FAIL_V_MSG(true, "Command line option --build-solutions was passed, but the build callback failed. Aborting.");
- }
- }
- #endif
- return exit || auto_quit;
- }
- void Main::force_redraw() {
- force_redraw_requested = true;
- }
- /* Engine deinitialization
- *
- * Responsible for freeing all the memory allocated by previous setup steps,
- * so that the engine closes cleanly without leaking memory or crashing.
- * The order matters as some of those steps are linked with each other.
- */
- void Main::cleanup() {
- ERR_FAIL_COND(!_start_success);
- EngineDebugger::deinitialize();
- ResourceLoader::remove_custom_loaders();
- ResourceSaver::remove_custom_savers();
- message_queue->flush();
- memdelete(message_queue);
- OS::get_singleton()->delete_main_loop();
- OS::get_singleton()->_cmdline.clear();
- OS::get_singleton()->_execpath = "";
- OS::get_singleton()->_local_clipboard = "";
- ResourceLoader::clear_translation_remaps();
- ResourceLoader::clear_path_remaps();
- ScriptServer::finish_languages();
- // Sync pending commands that may have been queued from a different thread during ScriptServer finalization
- RenderingServer::get_singleton()->sync();
- //clear global shader variables before scene and other graphics stuff is deinitialized.
- rendering_server->global_variables_clear();
- #ifdef TOOLS_ENABLED
- EditorNode::unregister_editor_types();
- #endif
- if (xr_server) {
- // cleanup now before we pull the rug from underneath...
- memdelete(xr_server);
- }
- ImageLoader::cleanup();
- unregister_driver_types();
- unregister_module_types();
- unregister_platform_apis();
- unregister_scene_types();
- unregister_server_types();
- if (audio_server) {
- audio_server->finish();
- memdelete(audio_server);
- }
- if (camera_server) {
- memdelete(camera_server);
- }
- OS::get_singleton()->finalize();
- finalize_physics();
- finalize_navigation_server();
- finalize_display();
- if (input) {
- memdelete(input);
- }
- if (packed_data)
- memdelete(packed_data);
- if (file_access_network_client)
- memdelete(file_access_network_client);
- if (performance)
- memdelete(performance);
- if (input_map)
- memdelete(input_map);
- if (translation_server)
- memdelete(translation_server);
- if (globals)
- memdelete(globals);
- if (engine)
- memdelete(engine);
- if (OS::get_singleton()->is_restart_on_exit_set()) {
- //attempt to restart with arguments
- String exec = OS::get_singleton()->get_executable_path();
- List<String> args = OS::get_singleton()->get_restart_on_exit_arguments();
- OS::ProcessID pid = 0;
- OS::get_singleton()->execute(exec, args, false, &pid);
- OS::get_singleton()->set_restart_on_exit(false, List<String>()); //clear list (uses memory)
- }
- unregister_core_driver_types();
- unregister_core_types();
- OS::get_singleton()->finalize_core();
- }
|