main.cpp 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317
  1. /*************************************************************************/
  2. /* main.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "main.h"
  31. #include "core/crypto/crypto.h"
  32. #include "core/input_map.h"
  33. #include "core/io/file_access_network.h"
  34. #include "core/io/file_access_pack.h"
  35. #include "core/io/file_access_zip.h"
  36. #include "core/io/image_loader.h"
  37. #include "core/io/ip.h"
  38. #include "core/io/resource_loader.h"
  39. #include "core/message_queue.h"
  40. #include "core/os/dir_access.h"
  41. #include "core/os/os.h"
  42. #include "core/project_settings.h"
  43. #include "core/register_core_types.h"
  44. #include "core/script_debugger_local.h"
  45. #include "core/script_language.h"
  46. #include "core/translation.h"
  47. #include "core/version.h"
  48. #include "core/version_hash.gen.h"
  49. #include "drivers/register_driver_types.h"
  50. #include "main/app_icon.gen.h"
  51. #include "main/input_default.h"
  52. #include "main/main_timer_sync.h"
  53. #include "main/performance.h"
  54. #include "main/splash.gen.h"
  55. #include "main/splash_editor.gen.h"
  56. #include "main/tests/test_main.h"
  57. #include "modules/register_module_types.h"
  58. #include "platform/register_platform_apis.h"
  59. #include "scene/debugger/script_debugger_remote.h"
  60. #include "scene/main/scene_tree.h"
  61. #include "scene/main/viewport.h"
  62. #include "scene/register_scene_types.h"
  63. #include "scene/resources/packed_scene.h"
  64. #include "servers/arvr_server.h"
  65. #include "servers/audio_server.h"
  66. #include "servers/camera_server.h"
  67. #include "servers/physics_2d_server.h"
  68. #include "servers/physics_server.h"
  69. #include "servers/register_server_types.h"
  70. #ifdef TOOLS_ENABLED
  71. #include "editor/doc/doc_data.h"
  72. #include "editor/doc/doc_data_class_path.gen.h"
  73. #include "editor/editor_node.h"
  74. #include "editor/editor_settings.h"
  75. #include "editor/progress_dialog.h"
  76. #include "editor/project_manager.h"
  77. #endif
  78. /* Static members */
  79. // Singletons
  80. // Initialized in setup()
  81. static Engine *engine = NULL;
  82. static ProjectSettings *globals = NULL;
  83. static InputMap *input_map = NULL;
  84. static TranslationServer *translation_server = NULL;
  85. static Performance *performance = NULL;
  86. static PackedData *packed_data = NULL;
  87. #ifdef MINIZIP_ENABLED
  88. static ZipArchive *zip_packed_data = NULL;
  89. #endif
  90. static FileAccessNetworkClient *file_access_network_client = NULL;
  91. static ScriptDebugger *script_debugger = NULL;
  92. static MessageQueue *message_queue = NULL;
  93. // Initialized in setup2()
  94. static AudioServer *audio_server = NULL;
  95. static CameraServer *camera_server = NULL;
  96. static ARVRServer *arvr_server = NULL;
  97. static PhysicsServer *physics_server = NULL;
  98. static Physics2DServer *physics_2d_server = NULL;
  99. // We error out if setup2() doesn't turn this true
  100. static bool _start_success = false;
  101. // Drivers
  102. static int video_driver_idx = -1;
  103. static int audio_driver_idx = -1;
  104. // Engine config/tools
  105. static bool editor = false;
  106. static bool project_manager = false;
  107. static String locale;
  108. static bool show_help = false;
  109. static bool auto_quit = false;
  110. static OS::ProcessID allow_focus_steal_pid = 0;
  111. #ifdef TOOLS_ENABLED
  112. static bool auto_build_solutions = false;
  113. #endif
  114. // Display
  115. static OS::VideoMode video_mode;
  116. static int init_screen = -1;
  117. static bool init_fullscreen = false;
  118. static bool init_maximized = false;
  119. static bool init_windowed = false;
  120. static bool init_always_on_top = false;
  121. static bool init_use_custom_pos = false;
  122. static Vector2 init_custom_pos;
  123. static bool force_lowdpi = false;
  124. // Debug
  125. static bool use_debug_profiler = false;
  126. #ifdef DEBUG_ENABLED
  127. static bool debug_collisions = false;
  128. static bool debug_navigation = false;
  129. #endif
  130. static int frame_delay = 0;
  131. static bool disable_render_loop = false;
  132. static int fixed_fps = -1;
  133. static bool print_fps = false;
  134. /* Helper methods */
  135. // Used by Mono module, should likely be registered in Engine singleton instead
  136. // FIXME: This is also not 100% accurate, `project_manager` is only true when it was requested,
  137. // but not if e.g. we fail to load and project and fallback to the manager.
  138. bool Main::is_project_manager() {
  139. return project_manager;
  140. }
  141. static String unescape_cmdline(const String &p_str) {
  142. return p_str.replace("%20", " ");
  143. }
  144. static String get_full_version_string() {
  145. String hash = String(VERSION_HASH);
  146. if (hash.length() != 0)
  147. hash = "." + hash.left(9);
  148. return String(VERSION_FULL_BUILD) + hash;
  149. }
  150. // FIXME: Could maybe be moved to PhysicsServerManager and Physics2DServerManager directly
  151. // to have less code in main.cpp.
  152. void initialize_physics() {
  153. // This must be defined BEFORE the 3d physics server is created
  154. GLOBAL_DEF("physics/3d/godot_physics/use_bvh", true);
  155. /// 3D Physics Server
  156. physics_server = PhysicsServerManager::new_server(ProjectSettings::get_singleton()->get(PhysicsServerManager::setting_property_name));
  157. if (!physics_server) {
  158. // Physics server not found, Use the default physics
  159. physics_server = PhysicsServerManager::new_default_server();
  160. }
  161. ERR_FAIL_COND(!physics_server);
  162. physics_server->init();
  163. /// 2D Physics server
  164. physics_2d_server = Physics2DServerManager::new_server(ProjectSettings::get_singleton()->get(Physics2DServerManager::setting_property_name));
  165. if (!physics_2d_server) {
  166. // Physics server not found, Use the default physics
  167. physics_2d_server = Physics2DServerManager::new_default_server();
  168. }
  169. ERR_FAIL_COND(!physics_2d_server);
  170. physics_2d_server->init();
  171. }
  172. void finalize_physics() {
  173. physics_server->finish();
  174. memdelete(physics_server);
  175. physics_2d_server->finish();
  176. memdelete(physics_2d_server);
  177. }
  178. //#define DEBUG_INIT
  179. #ifdef DEBUG_INIT
  180. #define MAIN_PRINT(m_txt) print_line(m_txt)
  181. #else
  182. #define MAIN_PRINT(m_txt)
  183. #endif
  184. void Main::print_help(const char *p_binary) {
  185. print_line(String(VERSION_NAME) + " v" + get_full_version_string() + " - " + String(VERSION_WEBSITE));
  186. OS::get_singleton()->print("Free and open source software under the terms of the MIT license.\n");
  187. OS::get_singleton()->print("(c) 2007-2021 Juan Linietsky, Ariel Manzur.\n");
  188. OS::get_singleton()->print("(c) 2014-2021 Godot Engine contributors.\n");
  189. OS::get_singleton()->print("\n");
  190. OS::get_singleton()->print("Usage: %s [options] [path to scene or 'project.godot' file]\n", p_binary);
  191. OS::get_singleton()->print("\n");
  192. OS::get_singleton()->print("General options:\n");
  193. OS::get_singleton()->print(" -h, --help Display this help message.\n");
  194. OS::get_singleton()->print(" --version Display the version string.\n");
  195. OS::get_singleton()->print(" -v, --verbose Use verbose stdout mode.\n");
  196. OS::get_singleton()->print(" --quiet Quiet mode, silences stdout messages. Errors are still displayed.\n");
  197. OS::get_singleton()->print("\n");
  198. OS::get_singleton()->print("Run options:\n");
  199. #ifdef TOOLS_ENABLED
  200. OS::get_singleton()->print(" -e, --editor Start the editor instead of running the scene.\n");
  201. OS::get_singleton()->print(" -p, --project-manager Start the project manager, even if a project is auto-detected.\n");
  202. #endif
  203. OS::get_singleton()->print(" -q, --quit Quit after the first iteration.\n");
  204. OS::get_singleton()->print(" -l, --language <locale> Use a specific locale (<locale> being a two-letter code).\n");
  205. OS::get_singleton()->print(" --path <directory> Path to a project (<directory> must contain a 'project.godot' file).\n");
  206. OS::get_singleton()->print(" -u, --upwards Scan folders upwards for project.godot file.\n");
  207. OS::get_singleton()->print(" --main-pack <file> Path to a pack (.pck) file to load.\n");
  208. OS::get_singleton()->print(" --render-thread <mode> Render thread mode ('unsafe', 'safe', 'separate').\n");
  209. OS::get_singleton()->print(" --remote-fs <address> Remote filesystem (<host/IP>[:<port>] address).\n");
  210. OS::get_singleton()->print(" --remote-fs-password <password> Password for remote filesystem.\n");
  211. OS::get_singleton()->print(" --audio-driver <driver> Audio driver (");
  212. for (int i = 0; i < OS::get_singleton()->get_audio_driver_count(); i++) {
  213. if (i != 0)
  214. OS::get_singleton()->print(", ");
  215. OS::get_singleton()->print("'%s'", OS::get_singleton()->get_audio_driver_name(i));
  216. }
  217. OS::get_singleton()->print(").\n");
  218. OS::get_singleton()->print(" --video-driver <driver> Video driver (");
  219. for (int i = 0; i < OS::get_singleton()->get_video_driver_count(); i++) {
  220. if (i != 0)
  221. OS::get_singleton()->print(", ");
  222. OS::get_singleton()->print("'%s'", OS::get_singleton()->get_video_driver_name(i));
  223. }
  224. OS::get_singleton()->print(").\n");
  225. OS::get_singleton()->print("\n");
  226. #ifndef SERVER_ENABLED
  227. OS::get_singleton()->print("Display options:\n");
  228. OS::get_singleton()->print(" -f, --fullscreen Request fullscreen mode.\n");
  229. OS::get_singleton()->print(" -m, --maximized Request a maximized window.\n");
  230. OS::get_singleton()->print(" -w, --windowed Request windowed mode.\n");
  231. OS::get_singleton()->print(" -t, --always-on-top Request an always-on-top window.\n");
  232. OS::get_singleton()->print(" --resolution <W>x<H> Request window resolution.\n");
  233. OS::get_singleton()->print(" --position <X>,<Y> Request window position.\n");
  234. OS::get_singleton()->print(" --low-dpi Force low-DPI mode (macOS and Windows only).\n");
  235. OS::get_singleton()->print(" --no-window Run with invisible window. Useful together with --script.\n");
  236. OS::get_singleton()->print(" --enable-vsync-via-compositor When vsync is enabled, vsync via the OS' window compositor (Windows only).\n");
  237. OS::get_singleton()->print(" --disable-vsync-via-compositor Disable vsync via the OS' window compositor (Windows only).\n");
  238. OS::get_singleton()->print(" --tablet-driver Tablet input driver (");
  239. for (int i = 0; i < OS::get_singleton()->get_tablet_driver_count(); i++) {
  240. if (i != 0)
  241. OS::get_singleton()->print(", ");
  242. OS::get_singleton()->print("'%s'", OS::get_singleton()->get_tablet_driver_name(i).utf8().get_data());
  243. }
  244. OS::get_singleton()->print(") (Windows only).\n");
  245. OS::get_singleton()->print("\n");
  246. #endif
  247. OS::get_singleton()->print("Debug options:\n");
  248. OS::get_singleton()->print(" -d, --debug Debug (local stdout debugger).\n");
  249. OS::get_singleton()->print(" -b, --breakpoints Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead).\n");
  250. OS::get_singleton()->print(" --profiling Enable profiling in the script debugger.\n");
  251. OS::get_singleton()->print(" --remote-debug <address> Remote debug (<host/IP>:<port> address).\n");
  252. #if defined(DEBUG_ENABLED) && !defined(SERVER_ENABLED)
  253. OS::get_singleton()->print(" --debug-collisions Show collision shapes when running the scene.\n");
  254. OS::get_singleton()->print(" --debug-navigation Show navigation polygons when running the scene.\n");
  255. #endif
  256. OS::get_singleton()->print(" --frame-delay <ms> Simulate high CPU load (delay each frame by <ms> milliseconds).\n");
  257. OS::get_singleton()->print(" --time-scale <scale> Force time scale (higher values are faster, 1.0 is normal speed).\n");
  258. OS::get_singleton()->print(" --disable-render-loop Disable render loop so rendering only occurs when called explicitly from script.\n");
  259. OS::get_singleton()->print(" --disable-crash-handler Disable crash handler when supported by the platform code.\n");
  260. OS::get_singleton()->print(" --fixed-fps <fps> Force a fixed number of frames per second. This setting disables real-time synchronization.\n");
  261. OS::get_singleton()->print(" --print-fps Print the frames per second to the stdout.\n");
  262. OS::get_singleton()->print("\n");
  263. OS::get_singleton()->print("Standalone tools:\n");
  264. OS::get_singleton()->print(" -s, --script <script> Run a script.\n");
  265. OS::get_singleton()->print(" --check-only Only parse for errors and quit (use with --script).\n");
  266. #ifdef TOOLS_ENABLED
  267. 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");
  268. 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");
  269. OS::get_singleton()->print(" --export-debug <preset> <path> Same as --export, but using the debug template.\n");
  270. 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");
  271. 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");
  272. OS::get_singleton()->print(" --no-docbase Disallow dumping the base types (used with --doctool).\n");
  273. 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");
  274. #ifdef DEBUG_METHODS_ENABLED
  275. OS::get_singleton()->print(" --gdnative-generate-json-api Generate JSON dump of the Godot API for GDNative bindings.\n");
  276. #endif
  277. OS::get_singleton()->print(" --test <test> Run a unit test (");
  278. const char **test_names = tests_get_names();
  279. const char *comma = "";
  280. while (*test_names) {
  281. OS::get_singleton()->print("%s'%s'", comma, *test_names);
  282. test_names++;
  283. comma = ", ";
  284. }
  285. OS::get_singleton()->print(").\n");
  286. #endif
  287. }
  288. /* Engine initialization
  289. *
  290. * Consists of several methods that are called by each platform's specific main(argc, argv).
  291. * To fully understand engine init, one should therefore start from the platform's main and
  292. * see how it calls into the Main class' methods.
  293. *
  294. * The initialization is typically done in 3 steps (with the setup2 step triggered either
  295. * automatically by setup, or manually in the platform's main).
  296. *
  297. * - setup(execpath, argc, argv, p_second_phase) is the main entry point for all platforms,
  298. * responsible for the initialization of all low level singletons and core types, and parsing
  299. * command line arguments to configure things accordingly.
  300. * If p_second_phase is true, it will chain into setup2() (default behaviour). This is
  301. * disabled on some platforms (Android, iOS, UWP) which trigger the second step in their
  302. * own time.
  303. *
  304. * - setup2(p_main_tid_override) registers high level servers and singletons, displays the
  305. * boot splash, then registers higher level types (scene, editor, etc.).
  306. *
  307. * - start() is the last step and that's where command line tools can run, or the main loop
  308. * can be created eventually and the project settings put into action. That's also where
  309. * the editor node is created, if relevant.
  310. * start() does it own argument parsing for a subset of the command line arguments described
  311. * in help, it's a bit messy and should be globalized with the setup() parsing somehow.
  312. */
  313. Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_phase) {
  314. #if defined(DEBUG_ENABLED) && !defined(NO_THREADS)
  315. check_lockless_atomics();
  316. #endif
  317. RID_OwnerBase::init_rid();
  318. OS::get_singleton()->initialize_core();
  319. engine = memnew(Engine);
  320. MAIN_PRINT("Main: Initialize CORE");
  321. register_core_types();
  322. register_core_driver_types();
  323. MAIN_PRINT("Main: Initialize Globals");
  324. globals = memnew(ProjectSettings);
  325. input_map = memnew(InputMap);
  326. register_core_settings(); //here globals is present
  327. translation_server = memnew(TranslationServer);
  328. performance = memnew(Performance);
  329. ClassDB::register_class<Performance>();
  330. engine->add_singleton(Engine::Singleton("Performance", performance));
  331. GLOBAL_DEF("debug/settings/crash_handler/message", String("Please include this when reporting the bug on https://github.com/godotengine/godot/issues"));
  332. MAIN_PRINT("Main: Parse CMDLine");
  333. /* argument parsing and main creation */
  334. List<String> args;
  335. List<String> main_args;
  336. for (int i = 0; i < argc; i++) {
  337. args.push_back(String::utf8(argv[i]));
  338. }
  339. List<String>::Element *I = args.front();
  340. I = args.front();
  341. while (I) {
  342. I->get() = unescape_cmdline(I->get().strip_edges());
  343. I = I->next();
  344. }
  345. I = args.front();
  346. String video_driver = "";
  347. String audio_driver = "";
  348. String tablet_driver = "";
  349. String project_path = ".";
  350. bool upwards = false;
  351. String debug_mode;
  352. String debug_host;
  353. bool skip_breakpoints = false;
  354. String main_pack;
  355. bool quiet_stdout = false;
  356. int rtm = -1;
  357. String remotefs;
  358. String remotefs_pass;
  359. Vector<String> breakpoints;
  360. bool use_custom_res = true;
  361. bool force_res = false;
  362. bool saw_vsync_via_compositor_override = false;
  363. #ifdef TOOLS_ENABLED
  364. bool found_project = false;
  365. #endif
  366. packed_data = PackedData::get_singleton();
  367. if (!packed_data)
  368. packed_data = memnew(PackedData);
  369. #ifdef MINIZIP_ENABLED
  370. //XXX: always get_singleton() == 0x0
  371. zip_packed_data = ZipArchive::get_singleton();
  372. //TODO: remove this temporary fix
  373. if (!zip_packed_data) {
  374. zip_packed_data = memnew(ZipArchive);
  375. }
  376. packed_data->add_pack_source(zip_packed_data);
  377. #endif
  378. I = args.front();
  379. while (I) {
  380. #ifdef OSX_ENABLED
  381. // Ignore the process serial number argument passed by macOS Gatekeeper.
  382. // Otherwise, Godot would try to open a non-existent project on the first start and abort.
  383. if (I->get().begins_with("-psn_")) {
  384. I = I->next();
  385. continue;
  386. }
  387. #endif
  388. List<String>::Element *N = I->next();
  389. if (I->get() == "-h" || I->get() == "--help" || I->get() == "/?") { // display help
  390. show_help = true;
  391. goto error;
  392. } else if (I->get() == "--version") {
  393. print_line(get_full_version_string());
  394. goto error;
  395. } else if (I->get() == "-v" || I->get() == "--verbose") { // verbose output
  396. OS::get_singleton()->_verbose_stdout = true;
  397. } else if (I->get() == "--quiet") { // quieter output
  398. quiet_stdout = true;
  399. } else if (I->get() == "--audio-driver") { // audio driver
  400. if (I->next()) {
  401. audio_driver = I->next()->get();
  402. bool found = false;
  403. for (int i = 0; i < OS::get_singleton()->get_audio_driver_count(); i++) {
  404. if (audio_driver == OS::get_singleton()->get_audio_driver_name(i)) {
  405. found = true;
  406. }
  407. }
  408. if (!found) {
  409. OS::get_singleton()->print("Unknown audio driver '%s', aborting.\nValid options are ", audio_driver.utf8().get_data());
  410. for (int i = 0; i < OS::get_singleton()->get_audio_driver_count(); i++) {
  411. if (i == OS::get_singleton()->get_audio_driver_count() - 1) {
  412. OS::get_singleton()->print(" and ");
  413. } else if (i != 0) {
  414. OS::get_singleton()->print(", ");
  415. }
  416. OS::get_singleton()->print("'%s'", OS::get_singleton()->get_audio_driver_name(i));
  417. }
  418. OS::get_singleton()->print(".\n");
  419. goto error;
  420. }
  421. N = I->next()->next();
  422. } else {
  423. OS::get_singleton()->print("Missing audio driver argument, aborting.\n");
  424. goto error;
  425. }
  426. } else if (I->get() == "--video-driver") { // force video driver
  427. if (I->next()) {
  428. video_driver = I->next()->get();
  429. bool found = false;
  430. for (int i = 0; i < OS::get_singleton()->get_video_driver_count(); i++) {
  431. if (video_driver == OS::get_singleton()->get_video_driver_name(i)) {
  432. found = true;
  433. }
  434. }
  435. if (!found) {
  436. OS::get_singleton()->print("Unknown video driver '%s', aborting.\nValid options are ", video_driver.utf8().get_data());
  437. for (int i = 0; i < OS::get_singleton()->get_video_driver_count(); i++) {
  438. if (i == OS::get_singleton()->get_video_driver_count() - 1) {
  439. OS::get_singleton()->print(" and ");
  440. } else if (i != 0) {
  441. OS::get_singleton()->print(", ");
  442. }
  443. OS::get_singleton()->print("'%s'", OS::get_singleton()->get_video_driver_name(i));
  444. }
  445. OS::get_singleton()->print(".\n");
  446. goto error;
  447. }
  448. N = I->next()->next();
  449. } else {
  450. OS::get_singleton()->print("Missing video driver argument, aborting.\n");
  451. goto error;
  452. }
  453. #ifndef SERVER_ENABLED
  454. } else if (I->get() == "-f" || I->get() == "--fullscreen") { // force fullscreen
  455. init_fullscreen = true;
  456. } else if (I->get() == "-m" || I->get() == "--maximized") { // force maximized window
  457. init_maximized = true;
  458. video_mode.maximized = true;
  459. } else if (I->get() == "-w" || I->get() == "--windowed") { // force windowed window
  460. init_windowed = true;
  461. } else if (I->get() == "-t" || I->get() == "--always-on-top") { // force always-on-top window
  462. init_always_on_top = true;
  463. } else if (I->get() == "--resolution") { // force resolution
  464. if (I->next()) {
  465. String vm = I->next()->get();
  466. if (vm.find("x") == -1) { // invalid parameter format
  467. OS::get_singleton()->print("Invalid resolution '%s', it should be e.g. '1280x720'.\n", vm.utf8().get_data());
  468. goto error;
  469. }
  470. int w = vm.get_slice("x", 0).to_int();
  471. int h = vm.get_slice("x", 1).to_int();
  472. if (w <= 0 || h <= 0) {
  473. OS::get_singleton()->print("Invalid resolution '%s', width and height must be above 0.\n", vm.utf8().get_data());
  474. goto error;
  475. }
  476. video_mode.width = w;
  477. video_mode.height = h;
  478. force_res = true;
  479. N = I->next()->next();
  480. } else {
  481. OS::get_singleton()->print("Missing resolution argument, aborting.\n");
  482. goto error;
  483. }
  484. } else if (I->get() == "--position") { // set window position
  485. if (I->next()) {
  486. String vm = I->next()->get();
  487. if (vm.find(",") == -1) { // invalid parameter format
  488. OS::get_singleton()->print("Invalid position '%s', it should be e.g. '80,128'.\n", vm.utf8().get_data());
  489. goto error;
  490. }
  491. int x = vm.get_slice(",", 0).to_int();
  492. int y = vm.get_slice(",", 1).to_int();
  493. init_custom_pos = Point2(x, y);
  494. init_use_custom_pos = true;
  495. N = I->next()->next();
  496. } else {
  497. OS::get_singleton()->print("Missing position argument, aborting.\n");
  498. goto error;
  499. }
  500. } else if (I->get() == "--low-dpi") { // force low DPI (macOS only)
  501. force_lowdpi = true;
  502. } else if (I->get() == "--no-window") { // run with an invisible window
  503. OS::get_singleton()->set_no_window_mode(true);
  504. } else if (I->get() == "--tablet-driver") {
  505. if (I->next()) {
  506. tablet_driver = I->next()->get();
  507. bool found = false;
  508. for (int i = 0; i < OS::get_singleton()->get_tablet_driver_count(); i++) {
  509. if (tablet_driver == OS::get_singleton()->get_tablet_driver_name(i)) {
  510. found = true;
  511. }
  512. }
  513. if (!found) {
  514. OS::get_singleton()->print("Unknown tablet driver '%s', aborting.\n", tablet_driver.utf8().get_data());
  515. goto error;
  516. }
  517. N = I->next()->next();
  518. } else {
  519. OS::get_singleton()->print("Missing tablet driver argument, aborting.\n");
  520. goto error;
  521. }
  522. } else if (I->get() == "--enable-vsync-via-compositor") {
  523. video_mode.vsync_via_compositor = true;
  524. saw_vsync_via_compositor_override = true;
  525. } else if (I->get() == "--disable-vsync-via-compositor") {
  526. video_mode.vsync_via_compositor = false;
  527. saw_vsync_via_compositor_override = true;
  528. #endif
  529. } else if (I->get() == "--profiling") { // enable profiling
  530. use_debug_profiler = true;
  531. } else if (I->get() == "-l" || I->get() == "--language") { // language
  532. if (I->next()) {
  533. locale = I->next()->get();
  534. N = I->next()->next();
  535. } else {
  536. OS::get_singleton()->print("Missing language argument, aborting.\n");
  537. goto error;
  538. }
  539. } else if (I->get() == "--remote-fs") { // remote filesystem
  540. if (I->next()) {
  541. remotefs = I->next()->get();
  542. N = I->next()->next();
  543. } else {
  544. OS::get_singleton()->print("Missing remote filesystem address, aborting.\n");
  545. goto error;
  546. }
  547. } else if (I->get() == "--remote-fs-password") { // remote filesystem password
  548. if (I->next()) {
  549. remotefs_pass = I->next()->get();
  550. N = I->next()->next();
  551. } else {
  552. OS::get_singleton()->print("Missing remote filesystem password, aborting.\n");
  553. goto error;
  554. }
  555. } else if (I->get() == "--render-thread") { // render thread mode
  556. if (I->next()) {
  557. if (I->next()->get() == "safe")
  558. rtm = OS::RENDER_THREAD_SAFE;
  559. else if (I->next()->get() == "unsafe")
  560. rtm = OS::RENDER_THREAD_UNSAFE;
  561. else if (I->next()->get() == "separate")
  562. rtm = OS::RENDER_SEPARATE_THREAD;
  563. N = I->next()->next();
  564. } else {
  565. OS::get_singleton()->print("Missing render thread mode argument, aborting.\n");
  566. goto error;
  567. }
  568. #ifdef TOOLS_ENABLED
  569. } else if (I->get() == "-e" || I->get() == "--editor") { // starts editor
  570. editor = true;
  571. } else if (I->get() == "-p" || I->get() == "--project-manager") { // starts project manager
  572. project_manager = true;
  573. } else if (I->get() == "--build-solutions") { // Build the scripting solution such C#
  574. auto_build_solutions = true;
  575. editor = true;
  576. #ifdef DEBUG_METHODS_ENABLED
  577. } else if (I->get() == "--gdnative-generate-json-api") {
  578. // Register as an editor instance to use the GLES2 fallback automatically on hardware that doesn't support the GLES3 backend
  579. editor = true;
  580. // We still pass it to the main arguments since the argument handling itself is not done in this function
  581. main_args.push_back(I->get());
  582. #endif
  583. } else if (I->get() == "--export" || I->get() == "--export-debug" || I->get() == "--export-pack") { // Export project
  584. editor = true;
  585. main_args.push_back(I->get());
  586. #endif
  587. } else if (I->get() == "--path") { // set path of project to start or edit
  588. if (I->next()) {
  589. String p = I->next()->get();
  590. if (OS::get_singleton()->set_cwd(p) == OK) {
  591. //nothing
  592. } else {
  593. project_path = I->next()->get(); //use project_path instead
  594. }
  595. N = I->next()->next();
  596. } else {
  597. OS::get_singleton()->print("Missing relative or absolute path, aborting.\n");
  598. goto error;
  599. }
  600. } else if (I->get() == "-u" || I->get() == "--upwards") { // scan folders upwards
  601. upwards = true;
  602. } else if (I->get() == "-q" || I->get() == "--quit") { // Auto quit at the end of the first main loop iteration
  603. auto_quit = true;
  604. } else if (I->get().ends_with("project.godot")) {
  605. String path;
  606. String file = I->get();
  607. int sep = MAX(file.find_last("/"), file.find_last("\\"));
  608. if (sep == -1)
  609. path = ".";
  610. else {
  611. path = file.substr(0, sep);
  612. }
  613. if (OS::get_singleton()->set_cwd(path) == OK) {
  614. // path already specified, don't override
  615. } else {
  616. project_path = path;
  617. }
  618. #ifdef TOOLS_ENABLED
  619. editor = true;
  620. #endif
  621. } else if (I->get() == "-b" || I->get() == "--breakpoints") { // add breakpoints
  622. if (I->next()) {
  623. String bplist = I->next()->get();
  624. breakpoints = bplist.split(",");
  625. N = I->next()->next();
  626. } else {
  627. OS::get_singleton()->print("Missing list of breakpoints, aborting.\n");
  628. goto error;
  629. }
  630. } else if (I->get() == "--frame-delay") { // force frame delay
  631. if (I->next()) {
  632. frame_delay = I->next()->get().to_int();
  633. N = I->next()->next();
  634. } else {
  635. OS::get_singleton()->print("Missing frame delay argument, aborting.\n");
  636. goto error;
  637. }
  638. } else if (I->get() == "--time-scale") { // force time scale
  639. if (I->next()) {
  640. Engine::get_singleton()->set_time_scale(I->next()->get().to_double());
  641. N = I->next()->next();
  642. } else {
  643. OS::get_singleton()->print("Missing time scale argument, aborting.\n");
  644. goto error;
  645. }
  646. } else if (I->get() == "--main-pack") {
  647. if (I->next()) {
  648. main_pack = I->next()->get();
  649. N = I->next()->next();
  650. } else {
  651. OS::get_singleton()->print("Missing path to main pack file, aborting.\n");
  652. goto error;
  653. };
  654. } else if (I->get() == "-d" || I->get() == "--debug") {
  655. debug_mode = "local";
  656. OS::get_singleton()->_debug_stdout = true;
  657. #if defined(DEBUG_ENABLED) && !defined(SERVER_ENABLED)
  658. } else if (I->get() == "--debug-collisions") {
  659. debug_collisions = true;
  660. } else if (I->get() == "--debug-navigation") {
  661. debug_navigation = true;
  662. #endif
  663. } else if (I->get() == "--remote-debug") {
  664. if (I->next()) {
  665. debug_mode = "remote";
  666. debug_host = I->next()->get();
  667. if (debug_host.find(":") == -1) { // wrong address
  668. OS::get_singleton()->print("Invalid debug host address, it should be of the form <host/IP>:<port>.\n");
  669. goto error;
  670. }
  671. N = I->next()->next();
  672. } else {
  673. OS::get_singleton()->print("Missing remote debug host address, aborting.\n");
  674. goto error;
  675. }
  676. } else if (I->get() == "--allow_focus_steal_pid") { // not exposed to user
  677. if (I->next()) {
  678. allow_focus_steal_pid = I->next()->get().to_int64();
  679. N = I->next()->next();
  680. } else {
  681. OS::get_singleton()->print("Missing editor PID argument, aborting.\n");
  682. goto error;
  683. }
  684. } else if (I->get() == "--disable-render-loop") {
  685. disable_render_loop = true;
  686. } else if (I->get() == "--fixed-fps") {
  687. if (I->next()) {
  688. fixed_fps = I->next()->get().to_int();
  689. N = I->next()->next();
  690. } else {
  691. OS::get_singleton()->print("Missing fixed-fps argument, aborting.\n");
  692. goto error;
  693. }
  694. } else if (I->get() == "--print-fps") {
  695. print_fps = true;
  696. } else if (I->get() == "--disable-crash-handler") {
  697. OS::get_singleton()->disable_crash_handler();
  698. } else if (I->get() == "--skip-breakpoints") {
  699. skip_breakpoints = true;
  700. } else {
  701. main_args.push_back(I->get());
  702. }
  703. I = N;
  704. }
  705. #ifdef TOOLS_ENABLED
  706. if (editor && project_manager) {
  707. OS::get_singleton()->print("Error: Command line arguments implied opening both editor and project manager, which is not possible. Aborting.\n");
  708. goto error;
  709. }
  710. #endif
  711. // Network file system needs to be configured before globals, since globals are based on the
  712. // 'project.godot' file which will only be available through the network if this is enabled
  713. FileAccessNetwork::configure();
  714. if (remotefs != "") {
  715. file_access_network_client = memnew(FileAccessNetworkClient);
  716. int port;
  717. if (remotefs.find(":") != -1) {
  718. port = remotefs.get_slicec(':', 1).to_int();
  719. remotefs = remotefs.get_slicec(':', 0);
  720. } else {
  721. port = 6010;
  722. }
  723. Error err = file_access_network_client->connect(remotefs, port, remotefs_pass);
  724. if (err) {
  725. OS::get_singleton()->printerr("Could not connect to remotefs: %s:%i.\n", remotefs.utf8().get_data(), port);
  726. goto error;
  727. }
  728. FileAccess::make_default<FileAccessNetwork>(FileAccess::ACCESS_RESOURCES);
  729. }
  730. if (globals->setup(project_path, main_pack, upwards) == OK) {
  731. #ifdef TOOLS_ENABLED
  732. found_project = true;
  733. #endif
  734. } else {
  735. #ifdef TOOLS_ENABLED
  736. editor = false;
  737. #else
  738. 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";
  739. OS::get_singleton()->print("%s", error_msg.ascii().get_data());
  740. OS::get_singleton()->alert(error_msg);
  741. goto error;
  742. #endif
  743. }
  744. // Initialize user data dir.
  745. OS::get_singleton()->ensure_user_data_dir();
  746. GLOBAL_DEF("memory/limits/multithreaded_server/rid_pool_prealloc", 60);
  747. 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
  748. GLOBAL_DEF("network/limits/debugger_stdout/max_chars_per_second", 2048);
  749. ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger_stdout/max_chars_per_second", PropertyInfo(Variant::INT, "network/limits/debugger_stdout/max_chars_per_second", PROPERTY_HINT_RANGE, "0, 4096, 1, or_greater"));
  750. GLOBAL_DEF("network/limits/debugger_stdout/max_messages_per_frame", 10);
  751. ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger_stdout/max_messages_per_frame", PropertyInfo(Variant::INT, "network/limits/debugger_stdout/max_messages_per_frame", PROPERTY_HINT_RANGE, "0, 20, 1, or_greater"));
  752. GLOBAL_DEF("network/limits/debugger_stdout/max_errors_per_second", 100);
  753. ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger_stdout/max_errors_per_second", PropertyInfo(Variant::INT, "network/limits/debugger_stdout/max_errors_per_second", PROPERTY_HINT_RANGE, "0, 200, 1, or_greater"));
  754. GLOBAL_DEF("network/limits/debugger_stdout/max_warnings_per_second", 100);
  755. ProjectSettings::get_singleton()->set_custom_property_info("network/limits/debugger_stdout/max_warnings_per_second", PropertyInfo(Variant::INT, "network/limits/debugger_stdout/max_warnings_per_second", PROPERTY_HINT_RANGE, "0, 200, 1, or_greater"));
  756. if (debug_mode == "remote") {
  757. ScriptDebuggerRemote *sdr = memnew(ScriptDebuggerRemote);
  758. uint16_t debug_port = 6007;
  759. if (debug_host.find(":") != -1) {
  760. int sep_pos = debug_host.find_last(":");
  761. debug_port = debug_host.substr(sep_pos + 1, debug_host.length()).to_int();
  762. debug_host = debug_host.substr(0, sep_pos);
  763. }
  764. Error derr = sdr->connect_to_host(debug_host, debug_port);
  765. sdr->set_skip_breakpoints(skip_breakpoints);
  766. if (derr != OK) {
  767. memdelete(sdr);
  768. } else {
  769. script_debugger = sdr;
  770. sdr->set_allow_focus_steal_pid(allow_focus_steal_pid);
  771. }
  772. } else if (debug_mode == "local") {
  773. script_debugger = memnew(ScriptDebuggerLocal);
  774. OS::get_singleton()->initialize_debugging();
  775. }
  776. if (script_debugger) {
  777. //there is a debugger, parse breakpoints
  778. for (int i = 0; i < breakpoints.size(); i++) {
  779. String bp = breakpoints[i];
  780. int sp = bp.find_last(":");
  781. ERR_CONTINUE_MSG(sp == -1, "Invalid breakpoint: '" + bp + "', expected file:line format.");
  782. script_debugger->insert_breakpoint(bp.substr(sp + 1, bp.length()).to_int(), bp.substr(0, sp));
  783. }
  784. }
  785. #ifdef TOOLS_ENABLED
  786. if (editor) {
  787. packed_data->set_disabled(true);
  788. globals->set_disable_feature_overrides(true);
  789. }
  790. #endif
  791. #ifdef TOOLS_ENABLED
  792. if (editor) {
  793. Engine::get_singleton()->set_editor_hint(true);
  794. main_args.push_back("--editor");
  795. if (!init_windowed) {
  796. init_maximized = true;
  797. video_mode.maximized = true;
  798. }
  799. }
  800. if (!project_manager && !editor) {
  801. // Determine if the project manager should be requested
  802. project_manager = main_args.size() == 0 && !found_project;
  803. }
  804. #endif
  805. // Only flush stdout in debug builds by default, as spamming `print()` will
  806. // decrease performance if this is enabled.
  807. GLOBAL_DEF_RST("application/run/flush_stdout_on_print", false);
  808. GLOBAL_DEF_RST("application/run/flush_stdout_on_print.debug", true);
  809. GLOBAL_DEF("logging/file_logging/enable_file_logging", false);
  810. // Only file logging by default on desktop platforms as logs can't be
  811. // accessed easily on mobile/Web platforms (if at all).
  812. // This also prevents logs from being created for the editor instance, as feature tags
  813. // are disabled while in the editor (even if they should logically apply).
  814. GLOBAL_DEF("logging/file_logging/enable_file_logging.pc", true);
  815. GLOBAL_DEF("logging/file_logging/log_path", "user://logs/godot.log");
  816. GLOBAL_DEF("logging/file_logging/max_log_files", 5);
  817. 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
  818. if (!project_manager && !editor && FileAccess::get_create_func(FileAccess::ACCESS_USERDATA) && GLOBAL_GET("logging/file_logging/enable_file_logging")) {
  819. // Don't create logs for the project manager as they would be written to
  820. // the current working directory, which is inconvenient.
  821. String base_path = GLOBAL_GET("logging/file_logging/log_path");
  822. int max_files = GLOBAL_GET("logging/file_logging/max_log_files");
  823. OS::get_singleton()->add_logger(memnew(RotatedFileLogger(base_path, max_files)));
  824. }
  825. if (main_args.size() == 0 && String(GLOBAL_DEF("application/run/main_scene", "")) == "") {
  826. #ifdef TOOLS_ENABLED
  827. if (!editor && !project_manager) {
  828. #endif
  829. OS::get_singleton()->print("Error: Can't run project: no main scene defined.\n");
  830. goto error;
  831. #ifdef TOOLS_ENABLED
  832. }
  833. #endif
  834. }
  835. if (editor || project_manager) {
  836. Engine::get_singleton()->set_editor_hint(true);
  837. use_custom_res = false;
  838. input_map->load_default(); //keys for editor
  839. } else {
  840. input_map->load_from_globals(); //keys for game
  841. }
  842. if (bool(ProjectSettings::get_singleton()->get("application/run/disable_stdout"))) {
  843. quiet_stdout = true;
  844. }
  845. if (bool(ProjectSettings::get_singleton()->get("application/run/disable_stderr"))) {
  846. _print_error_enabled = false;
  847. };
  848. if (quiet_stdout)
  849. _print_line_enabled = false;
  850. Logger::set_flush_stdout_on_print(ProjectSettings::get_singleton()->get("application/run/flush_stdout_on_print"));
  851. OS::get_singleton()->set_cmdline(execpath, main_args);
  852. GLOBAL_DEF("rendering/quality/driver/driver_name", "GLES3");
  853. ProjectSettings::get_singleton()->set_custom_property_info("rendering/quality/driver/driver_name", PropertyInfo(Variant::STRING, "rendering/quality/driver/driver_name", PROPERTY_HINT_ENUM, "GLES2,GLES3"));
  854. if (video_driver == "") {
  855. video_driver = GLOBAL_GET("rendering/quality/driver/driver_name");
  856. }
  857. GLOBAL_DEF("rendering/quality/driver/fallback_to_gles2", false);
  858. // Assigning here, to be sure that it appears in docs
  859. GLOBAL_DEF("rendering/2d/options/use_nvidia_rect_flicker_workaround", false);
  860. GLOBAL_DEF("display/window/size/width", 1024);
  861. 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
  862. GLOBAL_DEF("display/window/size/height", 600);
  863. 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
  864. GLOBAL_DEF("display/window/size/resizable", true);
  865. GLOBAL_DEF("display/window/size/borderless", false);
  866. GLOBAL_DEF("display/window/size/fullscreen", false);
  867. GLOBAL_DEF("display/window/size/always_on_top", false);
  868. GLOBAL_DEF("display/window/size/test_width", 0);
  869. 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
  870. GLOBAL_DEF("display/window/size/test_height", 0);
  871. 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
  872. if (use_custom_res) {
  873. if (!force_res) {
  874. video_mode.width = GLOBAL_GET("display/window/size/width");
  875. video_mode.height = GLOBAL_GET("display/window/size/height");
  876. if (globals->has_setting("display/window/size/test_width") && globals->has_setting("display/window/size/test_height")) {
  877. int tw = globals->get("display/window/size/test_width");
  878. if (tw > 0) {
  879. video_mode.width = tw;
  880. }
  881. int th = globals->get("display/window/size/test_height");
  882. if (th > 0) {
  883. video_mode.height = th;
  884. }
  885. }
  886. }
  887. video_mode.resizable = GLOBAL_GET("display/window/size/resizable");
  888. video_mode.borderless_window = GLOBAL_GET("display/window/size/borderless");
  889. video_mode.fullscreen = GLOBAL_GET("display/window/size/fullscreen");
  890. video_mode.always_on_top = GLOBAL_GET("display/window/size/always_on_top");
  891. }
  892. if (!force_lowdpi) {
  893. OS::get_singleton()->_allow_hidpi = GLOBAL_DEF("display/window/dpi/allow_hidpi", false);
  894. }
  895. video_mode.use_vsync = GLOBAL_DEF_RST("display/window/vsync/use_vsync", true);
  896. OS::get_singleton()->_use_vsync = video_mode.use_vsync;
  897. if (!saw_vsync_via_compositor_override) {
  898. // If one of the command line options to enable/disable vsync via the
  899. // window compositor ("--enable-vsync-via-compositor" or
  900. // "--disable-vsync-via-compositor") was present then it overrides the
  901. // project setting.
  902. video_mode.vsync_via_compositor = GLOBAL_DEF("display/window/vsync/vsync_via_compositor", false);
  903. }
  904. OS::get_singleton()->_vsync_via_compositor = video_mode.vsync_via_compositor;
  905. if (tablet_driver == "") { // specified in project.godot
  906. tablet_driver = GLOBAL_DEF_RST("display/window/tablet_driver", OS::get_singleton()->get_tablet_driver_name(0));
  907. }
  908. for (int i = 0; i < OS::get_singleton()->get_tablet_driver_count(); i++) {
  909. if (tablet_driver == OS::get_singleton()->get_tablet_driver_name(i)) {
  910. OS::get_singleton()->set_current_tablet_driver(OS::get_singleton()->get_tablet_driver_name(i));
  911. break;
  912. }
  913. }
  914. if (tablet_driver == "") {
  915. OS::get_singleton()->set_current_tablet_driver(OS::get_singleton()->get_tablet_driver_name(0));
  916. }
  917. OS::get_singleton()->_allow_layered = GLOBAL_DEF("display/window/per_pixel_transparency/allowed", false);
  918. video_mode.layered = GLOBAL_DEF("display/window/per_pixel_transparency/enabled", false);
  919. GLOBAL_DEF("rendering/quality/intended_usage/framebuffer_allocation", 2);
  920. GLOBAL_DEF("rendering/quality/intended_usage/framebuffer_allocation.mobile", 3);
  921. if (editor || project_manager) {
  922. // The editor and project manager always detect and use hiDPI if needed
  923. OS::get_singleton()->_allow_hidpi = true;
  924. OS::get_singleton()->_allow_layered = false;
  925. }
  926. Engine::get_singleton()->_gpu_pixel_snap = GLOBAL_DEF_ALIAS("rendering/2d/snapping/use_gpu_pixel_snap", "rendering/quality/2d/use_pixel_snap", false);
  927. OS::get_singleton()->_keep_screen_on = GLOBAL_DEF("display/window/energy_saving/keep_screen_on", true);
  928. if (rtm == -1) {
  929. rtm = GLOBAL_DEF("rendering/threads/thread_model", OS::RENDER_THREAD_SAFE);
  930. }
  931. if (rtm >= 0 && rtm < 3) {
  932. #ifdef NO_THREADS
  933. rtm = OS::RENDER_THREAD_UNSAFE; // No threads available on this platform.
  934. #else
  935. if (editor) {
  936. rtm = OS::RENDER_THREAD_SAFE;
  937. }
  938. #endif
  939. OS::get_singleton()->_render_thread_mode = OS::RenderThreadMode(rtm);
  940. }
  941. /* Determine audio and video drivers */
  942. for (int i = 0; i < OS::get_singleton()->get_video_driver_count(); i++) {
  943. if (video_driver == OS::get_singleton()->get_video_driver_name(i)) {
  944. video_driver_idx = i;
  945. break;
  946. }
  947. }
  948. if (video_driver_idx < 0) {
  949. video_driver_idx = 0;
  950. }
  951. if (audio_driver == "") { // specified in project.godot
  952. audio_driver = GLOBAL_DEF_RST("audio/driver", OS::get_singleton()->get_audio_driver_name(0));
  953. }
  954. for (int i = 0; i < OS::get_singleton()->get_audio_driver_count(); i++) {
  955. if (audio_driver == OS::get_singleton()->get_audio_driver_name(i)) {
  956. audio_driver_idx = i;
  957. break;
  958. }
  959. }
  960. if (audio_driver_idx < 0) {
  961. audio_driver_idx = 0;
  962. }
  963. {
  964. String orientation = GLOBAL_DEF("display/window/handheld/orientation", "landscape");
  965. if (orientation == "portrait")
  966. OS::get_singleton()->set_screen_orientation(OS::SCREEN_PORTRAIT);
  967. else if (orientation == "reverse_landscape")
  968. OS::get_singleton()->set_screen_orientation(OS::SCREEN_REVERSE_LANDSCAPE);
  969. else if (orientation == "reverse_portrait")
  970. OS::get_singleton()->set_screen_orientation(OS::SCREEN_REVERSE_PORTRAIT);
  971. else if (orientation == "sensor_landscape")
  972. OS::get_singleton()->set_screen_orientation(OS::SCREEN_SENSOR_LANDSCAPE);
  973. else if (orientation == "sensor_portrait")
  974. OS::get_singleton()->set_screen_orientation(OS::SCREEN_SENSOR_PORTRAIT);
  975. else if (orientation == "sensor")
  976. OS::get_singleton()->set_screen_orientation(OS::SCREEN_SENSOR);
  977. else
  978. OS::get_singleton()->set_screen_orientation(OS::SCREEN_LANDSCAPE);
  979. }
  980. Engine::get_singleton()->set_iterations_per_second(GLOBAL_DEF("physics/common/physics_fps", 60));
  981. ProjectSettings::get_singleton()->set_custom_property_info("physics/common/physics_fps", PropertyInfo(Variant::INT, "physics/common/physics_fps", PROPERTY_HINT_RANGE, "1,1000,1"));
  982. Engine::get_singleton()->set_physics_jitter_fix(GLOBAL_DEF("physics/common/physics_jitter_fix", 0.5));
  983. Engine::get_singleton()->set_target_fps(GLOBAL_DEF("debug/settings/fps/force_fps", 0));
  984. ProjectSettings::get_singleton()->set_custom_property_info("debug/settings/fps/force_fps", PropertyInfo(Variant::INT, "debug/settings/fps/force_fps", PROPERTY_HINT_RANGE, "0,1000,1"));
  985. GLOBAL_DEF("physics/common/enable_pause_aware_picking", false);
  986. GLOBAL_DEF("debug/settings/stdout/print_fps", false);
  987. GLOBAL_DEF("debug/settings/stdout/verbose_stdout", false);
  988. if (!OS::get_singleton()->_verbose_stdout) { // Not manually overridden.
  989. OS::get_singleton()->_verbose_stdout = GLOBAL_GET("debug/settings/stdout/verbose_stdout");
  990. }
  991. if (frame_delay == 0) {
  992. frame_delay = GLOBAL_DEF("application/run/frame_delay_msec", 0);
  993. 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
  994. }
  995. OS::get_singleton()->set_low_processor_usage_mode(GLOBAL_DEF("application/run/low_processor_mode", false));
  996. OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(GLOBAL_DEF("application/run/low_processor_mode_sleep_usec", 6900)); // Roughly 144 FPS
  997. 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
  998. GLOBAL_DEF("display/window/ios/hide_home_indicator", true);
  999. GLOBAL_DEF("input_devices/pointing/ios/touch_delay", 0.150);
  1000. Engine::get_singleton()->set_frame_delay(frame_delay);
  1001. message_queue = memnew(MessageQueue);
  1002. if (p_second_phase)
  1003. return setup2();
  1004. return OK;
  1005. error:
  1006. video_driver = "";
  1007. audio_driver = "";
  1008. tablet_driver = "";
  1009. project_path = "";
  1010. args.clear();
  1011. main_args.clear();
  1012. if (show_help)
  1013. print_help(execpath);
  1014. if (performance)
  1015. memdelete(performance);
  1016. if (input_map)
  1017. memdelete(input_map);
  1018. if (translation_server)
  1019. memdelete(translation_server);
  1020. if (globals)
  1021. memdelete(globals);
  1022. if (engine)
  1023. memdelete(engine);
  1024. if (script_debugger)
  1025. memdelete(script_debugger);
  1026. if (packed_data)
  1027. memdelete(packed_data);
  1028. if (file_access_network_client)
  1029. memdelete(file_access_network_client);
  1030. unregister_core_driver_types();
  1031. unregister_core_types();
  1032. OS::get_singleton()->_cmdline.clear();
  1033. if (message_queue)
  1034. memdelete(message_queue);
  1035. OS::get_singleton()->finalize_core();
  1036. locale = String();
  1037. return ERR_INVALID_PARAMETER;
  1038. }
  1039. Error Main::setup2(Thread::ID p_main_tid_override) {
  1040. // Print engine name and version
  1041. print_line(String(VERSION_NAME) + " v" + get_full_version_string() + " - " + String(VERSION_WEBSITE));
  1042. #if !defined(NO_THREADS)
  1043. if (p_main_tid_override) {
  1044. Thread::main_thread_id = p_main_tid_override;
  1045. }
  1046. #endif
  1047. Error err = OS::get_singleton()->initialize(video_mode, video_driver_idx, audio_driver_idx);
  1048. if (err != OK) {
  1049. return err;
  1050. }
  1051. print_line(" "); //add a blank line for readability
  1052. if (init_use_custom_pos) {
  1053. OS::get_singleton()->set_window_position(init_custom_pos);
  1054. }
  1055. // right moment to create and initialize the audio server
  1056. audio_server = memnew(AudioServer);
  1057. audio_server->init();
  1058. // also init our arvr_server from here
  1059. arvr_server = memnew(ARVRServer);
  1060. // and finally setup this property under visual_server
  1061. VisualServer::get_singleton()->set_render_loop_enabled(!disable_render_loop);
  1062. register_core_singletons();
  1063. MAIN_PRINT("Main: Setup Logo");
  1064. #if defined(JAVASCRIPT_ENABLED) || defined(ANDROID_ENABLED)
  1065. bool show_logo = false;
  1066. #else
  1067. bool show_logo = true;
  1068. #endif
  1069. if (init_screen != -1) {
  1070. OS::get_singleton()->set_current_screen(init_screen);
  1071. }
  1072. if (init_windowed) {
  1073. //do none..
  1074. } else if (init_maximized) {
  1075. OS::get_singleton()->set_window_maximized(true);
  1076. } else if (init_fullscreen) {
  1077. OS::get_singleton()->set_window_fullscreen(true);
  1078. }
  1079. if (init_always_on_top) {
  1080. OS::get_singleton()->set_window_always_on_top(true);
  1081. }
  1082. register_server_types();
  1083. MAIN_PRINT("Main: Load Boot Image");
  1084. Color clear = GLOBAL_DEF("rendering/environment/default_clear_color", Color(0.3, 0.3, 0.3));
  1085. VisualServer::get_singleton()->set_default_clear_color(clear);
  1086. if (show_logo) { //boot logo!
  1087. String boot_logo_path = GLOBAL_DEF("application/boot_splash/image", String());
  1088. bool boot_logo_scale = GLOBAL_DEF("application/boot_splash/fullsize", true);
  1089. bool boot_logo_filter = GLOBAL_DEF("application/boot_splash/use_filter", true);
  1090. ProjectSettings::get_singleton()->set_custom_property_info("application/boot_splash/image", PropertyInfo(Variant::STRING, "application/boot_splash/image", PROPERTY_HINT_FILE, "*.png"));
  1091. Ref<Image> boot_logo;
  1092. boot_logo_path = boot_logo_path.strip_edges();
  1093. if (boot_logo_path != String()) {
  1094. boot_logo.instance();
  1095. Error load_err = ImageLoader::load_image(boot_logo_path, boot_logo);
  1096. if (load_err)
  1097. ERR_PRINTS("Non-existing or invalid boot splash at '" + boot_logo_path + "'. Loading default splash.");
  1098. }
  1099. #if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
  1100. const Color boot_bg_color =
  1101. GLOBAL_DEF("application/boot_splash/bg_color",
  1102. (editor || project_manager) ? boot_splash_editor_bg_color : boot_splash_bg_color);
  1103. #else
  1104. const Color boot_bg_color = GLOBAL_DEF("application/boot_splash/bg_color", boot_splash_bg_color);
  1105. #endif
  1106. if (boot_logo.is_valid()) {
  1107. OS::get_singleton()->_msec_splash = OS::get_singleton()->get_ticks_msec();
  1108. VisualServer::get_singleton()->set_boot_image(boot_logo, boot_bg_color, boot_logo_scale, boot_logo_filter);
  1109. } else {
  1110. #ifndef NO_DEFAULT_BOOT_LOGO
  1111. MAIN_PRINT("Main: Create bootsplash");
  1112. #if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
  1113. Ref<Image> splash = (editor || project_manager) ? memnew(Image(boot_splash_editor_png)) : memnew(Image(boot_splash_png));
  1114. #else
  1115. Ref<Image> splash = memnew(Image(boot_splash_png));
  1116. #endif
  1117. MAIN_PRINT("Main: ClearColor");
  1118. VisualServer::get_singleton()->set_default_clear_color(boot_bg_color);
  1119. MAIN_PRINT("Main: Image");
  1120. VisualServer::get_singleton()->set_boot_image(splash, boot_bg_color, false);
  1121. #endif
  1122. }
  1123. #ifdef TOOLS_ENABLED
  1124. Ref<Image> icon = memnew(Image(app_icon_png));
  1125. OS::get_singleton()->set_icon(icon);
  1126. #endif
  1127. }
  1128. MAIN_PRINT("Main: DCC");
  1129. VisualServer::get_singleton()->set_default_clear_color(GLOBAL_DEF("rendering/environment/default_clear_color", Color(0.3, 0.3, 0.3)));
  1130. GLOBAL_DEF("application/config/icon", String());
  1131. ProjectSettings::get_singleton()->set_custom_property_info("application/config/icon",
  1132. PropertyInfo(Variant::STRING, "application/config/icon",
  1133. PROPERTY_HINT_FILE, "*.png,*.webp,*.svg,*.svgz"));
  1134. GLOBAL_DEF("application/config/macos_native_icon", String());
  1135. ProjectSettings::get_singleton()->set_custom_property_info("application/config/macos_native_icon", PropertyInfo(Variant::STRING, "application/config/macos_native_icon", PROPERTY_HINT_FILE, "*.icns"));
  1136. GLOBAL_DEF("application/config/windows_native_icon", String());
  1137. ProjectSettings::get_singleton()->set_custom_property_info("application/config/windows_native_icon", PropertyInfo(Variant::STRING, "application/config/windows_native_icon", PROPERTY_HINT_FILE, "*.ico"));
  1138. InputDefault *id = Object::cast_to<InputDefault>(Input::get_singleton());
  1139. if (id) {
  1140. if (bool(GLOBAL_DEF("input_devices/pointing/emulate_touch_from_mouse", false)) && !(editor || project_manager)) {
  1141. if (!OS::get_singleton()->has_touchscreen_ui_hint()) {
  1142. //only if no touchscreen ui hint, set emulation
  1143. id->set_emulate_touch_from_mouse(true);
  1144. }
  1145. }
  1146. id->set_emulate_mouse_from_touch(bool(GLOBAL_DEF("input_devices/pointing/emulate_mouse_from_touch", true)));
  1147. }
  1148. MAIN_PRINT("Main: Load Translations and Remaps");
  1149. translation_server->setup(); //register translations, load them, etc.
  1150. if (locale != "") {
  1151. translation_server->set_locale(locale);
  1152. }
  1153. translation_server->load_translations();
  1154. ResourceLoader::load_translation_remaps(); //load remaps for resources
  1155. ResourceLoader::load_path_remaps();
  1156. MAIN_PRINT("Main: Load Scene Types");
  1157. register_scene_types();
  1158. #ifdef TOOLS_ENABLED
  1159. ClassDB::set_current_api(ClassDB::API_EDITOR);
  1160. EditorNode::register_editor_types();
  1161. ClassDB::set_current_api(ClassDB::API_CORE);
  1162. #endif
  1163. MAIN_PRINT("Main: Load Modules, Physics, Drivers, Scripts");
  1164. register_platform_apis();
  1165. register_module_types();
  1166. GLOBAL_DEF("display/mouse_cursor/custom_image", String());
  1167. GLOBAL_DEF("display/mouse_cursor/custom_image_hotspot", Vector2());
  1168. GLOBAL_DEF("display/mouse_cursor/tooltip_position_offset", Point2(10, 10));
  1169. 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"));
  1170. if (String(ProjectSettings::get_singleton()->get("display/mouse_cursor/custom_image")) != String()) {
  1171. Ref<Texture> cursor = ResourceLoader::load(ProjectSettings::get_singleton()->get("display/mouse_cursor/custom_image"));
  1172. if (cursor.is_valid()) {
  1173. Vector2 hotspot = ProjectSettings::get_singleton()->get("display/mouse_cursor/custom_image_hotspot");
  1174. Input::get_singleton()->set_custom_mouse_cursor(cursor, Input::CURSOR_ARROW, hotspot);
  1175. }
  1176. }
  1177. camera_server = CameraServer::create();
  1178. initialize_physics();
  1179. register_server_singletons();
  1180. register_driver_types();
  1181. // This loads global classes, so it must happen before custom loaders and savers are registered
  1182. ScriptServer::init_languages();
  1183. audio_server->load_default_bus_layout();
  1184. if (use_debug_profiler && script_debugger) {
  1185. script_debugger->profiling_start();
  1186. }
  1187. _start_success = true;
  1188. locale = String();
  1189. ClassDB::set_current_api(ClassDB::API_NONE); //no more api is registered at this point
  1190. print_verbose("CORE API HASH: " + uitos(ClassDB::get_api_hash(ClassDB::API_CORE)));
  1191. print_verbose("EDITOR API HASH: " + uitos(ClassDB::get_api_hash(ClassDB::API_EDITOR)));
  1192. MAIN_PRINT("Main: Done");
  1193. return OK;
  1194. }
  1195. // everything the main loop needs to know about frame timings
  1196. static MainTimerSync main_timer_sync;
  1197. bool Main::start() {
  1198. ERR_FAIL_COND_V(!_start_success, false);
  1199. bool hasicon = false;
  1200. String doc_tool;
  1201. List<String> removal_docs;
  1202. String positional_arg;
  1203. String game_path;
  1204. String script;
  1205. String test;
  1206. bool check_only = false;
  1207. #ifdef TOOLS_ENABLED
  1208. bool doc_base = true;
  1209. String _export_preset;
  1210. bool export_debug = false;
  1211. bool export_pack_only = false;
  1212. #endif
  1213. main_timer_sync.init(OS::get_singleton()->get_ticks_usec());
  1214. List<String> args = OS::get_singleton()->get_cmdline_args();
  1215. for (int i = 0; i < args.size(); i++) {
  1216. //parameters that do not have an argument to the right
  1217. if (args[i] == "--check-only") {
  1218. check_only = true;
  1219. #ifdef TOOLS_ENABLED
  1220. } else if (args[i] == "--no-docbase") {
  1221. doc_base = false;
  1222. } else if (args[i] == "-e" || args[i] == "--editor") {
  1223. editor = true;
  1224. } else if (args[i] == "-p" || args[i] == "--project-manager") {
  1225. project_manager = true;
  1226. #endif
  1227. } else if (args[i].length() && args[i][0] != '-' && positional_arg == "") {
  1228. positional_arg = args[i];
  1229. if (args[i].ends_with(".scn") ||
  1230. args[i].ends_with(".tscn") ||
  1231. args[i].ends_with(".escn") ||
  1232. args[i].ends_with(".res") ||
  1233. args[i].ends_with(".tres")) {
  1234. // Only consider the positional argument to be a scene path if it ends with
  1235. // a file extension associated with Godot scenes. This makes it possible
  1236. // for projects to parse command-line arguments for custom CLI arguments
  1237. // or other file extensions without trouble. This can be used to implement
  1238. // "drag-and-drop onto executable" logic, which can prove helpful
  1239. // for non-game applications.
  1240. game_path = args[i];
  1241. }
  1242. }
  1243. //parameters that have an argument to the right
  1244. else if (i < (args.size() - 1)) {
  1245. bool parsed_pair = true;
  1246. if (args[i] == "-s" || args[i] == "--script") {
  1247. script = args[i + 1];
  1248. } else if (args[i] == "--test") {
  1249. test = args[i + 1];
  1250. #ifdef TOOLS_ENABLED
  1251. } else if (args[i] == "--doctool") {
  1252. doc_tool = args[i + 1];
  1253. for (int j = i + 2; j < args.size(); j++)
  1254. removal_docs.push_back(args[j]);
  1255. } else if (args[i] == "--export") {
  1256. editor = true; //needs editor
  1257. _export_preset = args[i + 1];
  1258. } else if (args[i] == "--export-debug") {
  1259. editor = true; //needs editor
  1260. _export_preset = args[i + 1];
  1261. export_debug = true;
  1262. } else if (args[i] == "--export-pack") {
  1263. editor = true;
  1264. _export_preset = args[i + 1];
  1265. export_pack_only = true;
  1266. #endif
  1267. } else {
  1268. // The parameter does not match anything known, don't skip the next argument
  1269. parsed_pair = false;
  1270. }
  1271. if (parsed_pair) {
  1272. i++;
  1273. }
  1274. }
  1275. }
  1276. String main_loop_type;
  1277. #ifdef TOOLS_ENABLED
  1278. if (doc_tool != "") {
  1279. Engine::get_singleton()->set_editor_hint(true); // Needed to instance editor-only classes for their default values
  1280. {
  1281. DirAccessRef da = DirAccess::open(doc_tool);
  1282. ERR_FAIL_COND_V_MSG(!da, false, "Argument supplied to --doctool must be a valid directory path.");
  1283. }
  1284. DocData doc;
  1285. doc.generate(doc_base);
  1286. DocData docsrc;
  1287. Map<String, String> doc_data_classes;
  1288. Set<String> checked_paths;
  1289. print_line("Loading docs...");
  1290. for (int i = 0; i < _doc_data_class_path_count; i++) {
  1291. // Custom modules are always located by absolute path.
  1292. String path = _doc_data_class_paths[i].path;
  1293. if (path.is_rel_path()) {
  1294. path = doc_tool.plus_file(path);
  1295. }
  1296. String name = _doc_data_class_paths[i].name;
  1297. doc_data_classes[name] = path;
  1298. if (!checked_paths.has(path)) {
  1299. checked_paths.insert(path);
  1300. // Create the module documentation directory if it doesn't exist
  1301. DirAccess *da = DirAccess::create_for_path(path);
  1302. da->make_dir_recursive(path);
  1303. memdelete(da);
  1304. docsrc.load_classes(path);
  1305. print_line("Loading docs from: " + path);
  1306. }
  1307. }
  1308. String index_path = doc_tool.plus_file("doc/classes");
  1309. // Create the main documentation directory if it doesn't exist
  1310. DirAccess *da = DirAccess::create_for_path(index_path);
  1311. da->make_dir_recursive(index_path);
  1312. memdelete(da);
  1313. docsrc.load_classes(index_path);
  1314. checked_paths.insert(index_path);
  1315. print_line("Loading docs from: " + index_path);
  1316. print_line("Merging docs...");
  1317. doc.merge_from(docsrc);
  1318. for (Set<String>::Element *E = checked_paths.front(); E; E = E->next()) {
  1319. print_line("Erasing old docs at: " + E->get());
  1320. DocData::erase_classes(E->get());
  1321. }
  1322. print_line("Generating new docs...");
  1323. doc.save_classes(index_path, doc_data_classes);
  1324. return false;
  1325. }
  1326. #endif
  1327. if (script == "" && game_path == "" && String(GLOBAL_DEF("application/run/main_scene", "")) != "") {
  1328. game_path = GLOBAL_DEF("application/run/main_scene", "");
  1329. }
  1330. MainLoop *main_loop = NULL;
  1331. if (editor) {
  1332. main_loop = memnew(SceneTree);
  1333. };
  1334. if (test != "") {
  1335. #ifdef TOOLS_ENABLED
  1336. main_loop = test_main(test, args);
  1337. if (!main_loop)
  1338. return false;
  1339. #endif
  1340. } else if (script != "") {
  1341. Ref<Script> script_res = ResourceLoader::load(script);
  1342. ERR_FAIL_COND_V_MSG(script_res.is_null(), false, "Can't load script: " + script);
  1343. if (check_only) {
  1344. if (!script_res->is_valid()) {
  1345. OS::get_singleton()->set_exit_code(1);
  1346. }
  1347. return false;
  1348. }
  1349. if (script_res->can_instance()) {
  1350. StringName instance_type = script_res->get_instance_base_type();
  1351. Object *obj = ClassDB::instance(instance_type);
  1352. MainLoop *script_loop = Object::cast_to<MainLoop>(obj);
  1353. if (!script_loop) {
  1354. if (obj)
  1355. memdelete(obj);
  1356. ERR_FAIL_V_MSG(false, vformat("Can't load the script \"%s\" as it doesn't inherit from SceneTree or MainLoop.", script));
  1357. }
  1358. script_loop->set_init_script(script_res);
  1359. main_loop = script_loop;
  1360. } else {
  1361. return false;
  1362. }
  1363. } else {
  1364. main_loop_type = GLOBAL_DEF("application/run/main_loop_type", "");
  1365. }
  1366. if (!main_loop && main_loop_type == "")
  1367. main_loop_type = "SceneTree";
  1368. if (!main_loop) {
  1369. if (!ClassDB::class_exists(main_loop_type)) {
  1370. OS::get_singleton()->alert("Error: MainLoop type doesn't exist: " + main_loop_type);
  1371. return false;
  1372. } else {
  1373. Object *ml = ClassDB::instance(main_loop_type);
  1374. ERR_FAIL_COND_V_MSG(!ml, false, "Can't instance MainLoop type.");
  1375. main_loop = Object::cast_to<MainLoop>(ml);
  1376. if (!main_loop) {
  1377. memdelete(ml);
  1378. ERR_FAIL_V_MSG(false, "Invalid MainLoop type.");
  1379. }
  1380. }
  1381. }
  1382. if (main_loop->is_class("SceneTree")) {
  1383. SceneTree *sml = Object::cast_to<SceneTree>(main_loop);
  1384. #ifdef DEBUG_ENABLED
  1385. if (debug_collisions) {
  1386. sml->set_debug_collisions_hint(true);
  1387. }
  1388. if (debug_navigation) {
  1389. sml->set_debug_navigation_hint(true);
  1390. }
  1391. #endif
  1392. ResourceLoader::add_custom_loaders();
  1393. ResourceSaver::add_custom_savers();
  1394. if (!project_manager && !editor) { // game
  1395. if (game_path != "" || script != "") {
  1396. if (script_debugger && script_debugger->is_remote()) {
  1397. ScriptDebuggerRemote *remote_debugger = static_cast<ScriptDebuggerRemote *>(script_debugger);
  1398. remote_debugger->set_scene_tree(sml);
  1399. }
  1400. //autoload
  1401. List<PropertyInfo> props;
  1402. ProjectSettings::get_singleton()->get_property_list(&props);
  1403. //first pass, add the constants so they exist before any script is loaded
  1404. for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
  1405. String s = E->get().name;
  1406. if (!s.begins_with("autoload/"))
  1407. continue;
  1408. String name = s.get_slicec('/', 1);
  1409. String path = ProjectSettings::get_singleton()->get(s);
  1410. bool global_var = false;
  1411. if (path.begins_with("*")) {
  1412. global_var = true;
  1413. }
  1414. if (global_var) {
  1415. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  1416. ScriptServer::get_language(i)->add_global_constant(name, Variant());
  1417. }
  1418. }
  1419. }
  1420. //second pass, load into global constants
  1421. List<Node *> to_add;
  1422. for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
  1423. String s = E->get().name;
  1424. if (!s.begins_with("autoload/"))
  1425. continue;
  1426. String name = s.get_slicec('/', 1);
  1427. String path = ProjectSettings::get_singleton()->get(s);
  1428. bool global_var = false;
  1429. if (path.begins_with("*")) {
  1430. global_var = true;
  1431. path = path.substr(1, path.length() - 1);
  1432. }
  1433. RES res = ResourceLoader::load(path);
  1434. ERR_CONTINUE_MSG(res.is_null(), "Can't autoload: " + path);
  1435. Node *n = NULL;
  1436. if (res->is_class("PackedScene")) {
  1437. Ref<PackedScene> ps = res;
  1438. n = ps->instance();
  1439. } else if (res->is_class("Script")) {
  1440. Ref<Script> script_res = res;
  1441. StringName ibt = script_res->get_instance_base_type();
  1442. bool valid_type = ClassDB::is_parent_class(ibt, "Node");
  1443. ERR_CONTINUE_MSG(!valid_type, "Script does not inherit a Node: " + path);
  1444. Object *obj = ClassDB::instance(ibt);
  1445. ERR_CONTINUE_MSG(obj == NULL, "Cannot instance script for autoload, expected 'Node' inheritance, got: " + String(ibt));
  1446. n = Object::cast_to<Node>(obj);
  1447. n->set_script(script_res.get_ref_ptr());
  1448. }
  1449. ERR_CONTINUE_MSG(!n, "Path in autoload not a node or script: " + path);
  1450. n->set_name(name);
  1451. //defer so references are all valid on _ready()
  1452. to_add.push_back(n);
  1453. if (global_var) {
  1454. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  1455. ScriptServer::get_language(i)->add_global_constant(name, n);
  1456. }
  1457. }
  1458. }
  1459. for (List<Node *>::Element *E = to_add.front(); E; E = E->next()) {
  1460. sml->get_root()->add_child(E->get());
  1461. }
  1462. }
  1463. }
  1464. #ifdef TOOLS_ENABLED
  1465. EditorNode *editor_node = NULL;
  1466. if (editor) {
  1467. editor_node = memnew(EditorNode);
  1468. sml->get_root()->add_child(editor_node);
  1469. if (_export_preset != "") {
  1470. editor_node->export_preset(_export_preset, positional_arg, export_debug, export_pack_only);
  1471. game_path = ""; // Do not load anything.
  1472. }
  1473. }
  1474. #endif
  1475. if (!editor && !project_manager) {
  1476. //standard helpers that can be changed from main config
  1477. String stretch_mode = GLOBAL_DEF("display/window/stretch/mode", "disabled");
  1478. String stretch_aspect = GLOBAL_DEF("display/window/stretch/aspect", "ignore");
  1479. Size2i stretch_size = Size2(GLOBAL_DEF("display/window/size/width", 0), GLOBAL_DEF("display/window/size/height", 0));
  1480. real_t stretch_shrink = GLOBAL_DEF("display/window/stretch/shrink", 1.0);
  1481. SceneTree::StretchMode sml_sm = SceneTree::STRETCH_MODE_DISABLED;
  1482. if (stretch_mode == "2d")
  1483. sml_sm = SceneTree::STRETCH_MODE_2D;
  1484. else if (stretch_mode == "viewport")
  1485. sml_sm = SceneTree::STRETCH_MODE_VIEWPORT;
  1486. SceneTree::StretchAspect sml_aspect = SceneTree::STRETCH_ASPECT_IGNORE;
  1487. if (stretch_aspect == "keep")
  1488. sml_aspect = SceneTree::STRETCH_ASPECT_KEEP;
  1489. else if (stretch_aspect == "keep_width")
  1490. sml_aspect = SceneTree::STRETCH_ASPECT_KEEP_WIDTH;
  1491. else if (stretch_aspect == "keep_height")
  1492. sml_aspect = SceneTree::STRETCH_ASPECT_KEEP_HEIGHT;
  1493. else if (stretch_aspect == "expand")
  1494. sml_aspect = SceneTree::STRETCH_ASPECT_EXPAND;
  1495. sml->set_screen_stretch(sml_sm, sml_aspect, stretch_size, stretch_shrink);
  1496. sml->set_auto_accept_quit(GLOBAL_DEF("application/config/auto_accept_quit", true));
  1497. sml->set_quit_on_go_back(GLOBAL_DEF("application/config/quit_on_go_back", true));
  1498. String appname = ProjectSettings::get_singleton()->get("application/config/name");
  1499. appname = TranslationServer::get_singleton()->translate(appname);
  1500. #ifdef DEBUG_ENABLED
  1501. // Append a suffix to the window title to denote that the project is running
  1502. // from a debug build (including the editor). Since this results in lower performance,
  1503. // this should be clearly presented to the user.
  1504. OS::get_singleton()->set_window_title(vformat("%s (DEBUG)", appname));
  1505. #else
  1506. OS::get_singleton()->set_window_title(appname);
  1507. #endif
  1508. int shadow_atlas_size = GLOBAL_GET("rendering/quality/shadow_atlas/size");
  1509. int shadow_atlas_q0_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_0_subdiv");
  1510. int shadow_atlas_q1_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_1_subdiv");
  1511. int shadow_atlas_q2_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_2_subdiv");
  1512. int shadow_atlas_q3_subdiv = GLOBAL_GET("rendering/quality/shadow_atlas/quadrant_3_subdiv");
  1513. sml->get_root()->set_shadow_atlas_size(shadow_atlas_size);
  1514. sml->get_root()->set_shadow_atlas_quadrant_subdiv(0, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q0_subdiv));
  1515. sml->get_root()->set_shadow_atlas_quadrant_subdiv(1, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q1_subdiv));
  1516. sml->get_root()->set_shadow_atlas_quadrant_subdiv(2, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q2_subdiv));
  1517. sml->get_root()->set_shadow_atlas_quadrant_subdiv(3, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q3_subdiv));
  1518. Viewport::Usage usage = Viewport::Usage(int(GLOBAL_GET("rendering/quality/intended_usage/framebuffer_allocation")));
  1519. sml->get_root()->set_usage(usage);
  1520. bool snap_controls = GLOBAL_DEF("gui/common/snap_controls_to_pixels", true);
  1521. sml->get_root()->set_snap_controls_to_pixels(snap_controls);
  1522. bool font_oversampling = GLOBAL_DEF("rendering/quality/dynamic_fonts/use_oversampling", true);
  1523. sml->set_use_font_oversampling(font_oversampling);
  1524. } else {
  1525. GLOBAL_DEF("display/window/stretch/mode", "disabled");
  1526. ProjectSettings::get_singleton()->set_custom_property_info("display/window/stretch/mode", PropertyInfo(Variant::STRING, "display/window/stretch/mode", PROPERTY_HINT_ENUM, "disabled,2d,viewport"));
  1527. GLOBAL_DEF("display/window/stretch/aspect", "ignore");
  1528. 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"));
  1529. GLOBAL_DEF("display/window/stretch/shrink", 1.0);
  1530. ProjectSettings::get_singleton()->set_custom_property_info("display/window/stretch/shrink", PropertyInfo(Variant::REAL, "display/window/stretch/shrink", PROPERTY_HINT_RANGE, "1.0,8.0,0.1"));
  1531. sml->set_auto_accept_quit(GLOBAL_DEF("application/config/auto_accept_quit", true));
  1532. sml->set_quit_on_go_back(GLOBAL_DEF("application/config/quit_on_go_back", true));
  1533. GLOBAL_DEF("gui/common/snap_controls_to_pixels", true);
  1534. GLOBAL_DEF("rendering/quality/dynamic_fonts/use_oversampling", true);
  1535. }
  1536. String local_game_path;
  1537. if (game_path != "" && !project_manager) {
  1538. local_game_path = game_path.replace("\\", "/");
  1539. if (!local_game_path.begins_with("res://")) {
  1540. bool absolute = (local_game_path.size() > 1) && (local_game_path[0] == '/' || local_game_path[1] == ':');
  1541. if (!absolute) {
  1542. if (ProjectSettings::get_singleton()->is_using_datapack()) {
  1543. local_game_path = "res://" + local_game_path;
  1544. } else {
  1545. int sep = local_game_path.find_last("/");
  1546. if (sep == -1) {
  1547. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1548. local_game_path = da->get_current_dir().plus_file(local_game_path);
  1549. memdelete(da);
  1550. } else {
  1551. DirAccess *da = DirAccess::open(local_game_path.substr(0, sep));
  1552. if (da) {
  1553. local_game_path = da->get_current_dir().plus_file(local_game_path.substr(sep + 1, local_game_path.length()));
  1554. memdelete(da);
  1555. }
  1556. }
  1557. }
  1558. }
  1559. }
  1560. local_game_path = ProjectSettings::get_singleton()->localize_path(local_game_path);
  1561. #ifdef TOOLS_ENABLED
  1562. if (editor) {
  1563. if (game_path != GLOBAL_GET("application/run/main_scene") || !editor_node->has_scenes_in_session()) {
  1564. Error serr = editor_node->load_scene(local_game_path);
  1565. if (serr != OK)
  1566. ERR_PRINT("Failed to load scene");
  1567. }
  1568. OS::get_singleton()->set_context(OS::CONTEXT_EDITOR);
  1569. }
  1570. #endif
  1571. if (!editor) {
  1572. OS::get_singleton()->set_context(OS::CONTEXT_ENGINE);
  1573. }
  1574. }
  1575. if (!project_manager && !editor) { // game
  1576. // Load SSL Certificates from Project Settings (or builtin).
  1577. Crypto::load_default_certificates(GLOBAL_DEF("network/ssl/certificates", ""));
  1578. if (game_path != "") {
  1579. Node *scene = NULL;
  1580. Ref<PackedScene> scenedata = ResourceLoader::load(local_game_path);
  1581. if (scenedata.is_valid())
  1582. scene = scenedata->instance();
  1583. ERR_FAIL_COND_V_MSG(!scene, false, "Failed loading scene: " + local_game_path);
  1584. sml->add_current_scene(scene);
  1585. #ifdef OSX_ENABLED
  1586. String mac_iconpath = GLOBAL_DEF("application/config/macos_native_icon", "Variant()");
  1587. if (mac_iconpath != "") {
  1588. OS::get_singleton()->set_native_icon(mac_iconpath);
  1589. hasicon = true;
  1590. }
  1591. #endif
  1592. #ifdef WINDOWS_ENABLED
  1593. String win_iconpath = GLOBAL_DEF("application/config/windows_native_icon", "Variant()");
  1594. if (win_iconpath != "") {
  1595. OS::get_singleton()->set_native_icon(win_iconpath);
  1596. hasicon = true;
  1597. }
  1598. #endif
  1599. String iconpath = GLOBAL_DEF("application/config/icon", "Variant()");
  1600. if ((iconpath != "") && (!hasicon)) {
  1601. Ref<Image> icon;
  1602. icon.instance();
  1603. if (ImageLoader::load_image(iconpath, icon) == OK) {
  1604. OS::get_singleton()->set_icon(icon);
  1605. hasicon = true;
  1606. }
  1607. }
  1608. }
  1609. }
  1610. #ifdef TOOLS_ENABLED
  1611. if (project_manager || (script == "" && test == "" && game_path == "" && !editor)) {
  1612. Engine::get_singleton()->set_editor_hint(true);
  1613. ProjectManager *pmanager = memnew(ProjectManager);
  1614. ProgressDialog *progress_dialog = memnew(ProgressDialog);
  1615. pmanager->add_child(progress_dialog);
  1616. sml->get_root()->add_child(pmanager);
  1617. OS::get_singleton()->set_context(OS::CONTEXT_PROJECTMAN);
  1618. project_manager = true;
  1619. }
  1620. if (project_manager || editor) {
  1621. // Hide console window if requested (Windows-only).
  1622. bool hide_console = EditorSettings::get_singleton()->get_setting("interface/editor/hide_console_window");
  1623. OS::get_singleton()->set_console_visible(!hide_console);
  1624. // Load SSL Certificates from Editor Settings (or builtin)
  1625. Crypto::load_default_certificates(EditorSettings::get_singleton()->get_setting("network/ssl/editor_ssl_certificates").operator String());
  1626. }
  1627. #endif
  1628. }
  1629. if (!hasicon) {
  1630. Ref<Image> icon = memnew(Image(app_icon_png));
  1631. OS::get_singleton()->set_icon(icon);
  1632. }
  1633. OS::get_singleton()->set_main_loop(main_loop);
  1634. return true;
  1635. }
  1636. /* Main iteration
  1637. *
  1638. * This is the iteration of the engine's game loop, advancing the state of physics,
  1639. * rendering and audio.
  1640. * It's called directly by the platform's OS::run method, where the loop is created
  1641. * and monitored.
  1642. *
  1643. * The OS implementation can impact its draw step with the Main::force_redraw() method.
  1644. */
  1645. uint64_t Main::last_ticks = 0;
  1646. uint32_t Main::frames = 0;
  1647. uint32_t Main::frame = 0;
  1648. bool Main::force_redraw_requested = false;
  1649. int Main::iterating = 0;
  1650. bool Main::is_iterating() {
  1651. return iterating > 0;
  1652. }
  1653. // For performance metrics.
  1654. static uint64_t physics_process_max = 0;
  1655. static uint64_t idle_process_max = 0;
  1656. bool Main::iteration() {
  1657. //for now do not error on this
  1658. //ERR_FAIL_COND_V(iterating, false);
  1659. iterating++;
  1660. uint64_t ticks = OS::get_singleton()->get_ticks_usec();
  1661. Engine::get_singleton()->_frame_ticks = ticks;
  1662. main_timer_sync.set_cpu_ticks_usec(ticks);
  1663. main_timer_sync.set_fixed_fps(fixed_fps);
  1664. uint64_t ticks_elapsed = ticks - last_ticks;
  1665. int physics_fps = Engine::get_singleton()->get_iterations_per_second();
  1666. float frame_slice = 1.0 / physics_fps;
  1667. float time_scale = Engine::get_singleton()->get_time_scale();
  1668. MainFrameTime advance = main_timer_sync.advance(frame_slice, physics_fps);
  1669. double step = advance.idle_step;
  1670. double scaled_step = step * time_scale;
  1671. Engine::get_singleton()->_frame_step = step;
  1672. Engine::get_singleton()->_physics_interpolation_fraction = advance.interpolation_fraction;
  1673. uint64_t physics_process_ticks = 0;
  1674. uint64_t idle_process_ticks = 0;
  1675. frame += ticks_elapsed;
  1676. last_ticks = ticks;
  1677. static const int max_physics_steps = 8;
  1678. if (fixed_fps == -1 && advance.physics_steps > max_physics_steps) {
  1679. step -= (advance.physics_steps - max_physics_steps) * frame_slice;
  1680. advance.physics_steps = max_physics_steps;
  1681. }
  1682. bool exit = false;
  1683. Engine::get_singleton()->_in_physics = true;
  1684. for (int iters = 0; iters < advance.physics_steps; ++iters) {
  1685. uint64_t physics_begin = OS::get_singleton()->get_ticks_usec();
  1686. PhysicsServer::get_singleton()->flush_queries();
  1687. Physics2DServer::get_singleton()->sync();
  1688. Physics2DServer::get_singleton()->flush_queries();
  1689. if (OS::get_singleton()->get_main_loop()->iteration(frame_slice * time_scale)) {
  1690. exit = true;
  1691. break;
  1692. }
  1693. message_queue->flush();
  1694. PhysicsServer::get_singleton()->step(frame_slice * time_scale);
  1695. Physics2DServer::get_singleton()->end_sync();
  1696. Physics2DServer::get_singleton()->step(frame_slice * time_scale);
  1697. message_queue->flush();
  1698. physics_process_ticks = MAX(physics_process_ticks, OS::get_singleton()->get_ticks_usec() - physics_begin); // keep the largest one for reference
  1699. physics_process_max = MAX(OS::get_singleton()->get_ticks_usec() - physics_begin, physics_process_max);
  1700. Engine::get_singleton()->_physics_frames++;
  1701. }
  1702. Engine::get_singleton()->_in_physics = false;
  1703. uint64_t idle_begin = OS::get_singleton()->get_ticks_usec();
  1704. if (OS::get_singleton()->get_main_loop()->idle(step * time_scale)) {
  1705. exit = true;
  1706. }
  1707. message_queue->flush();
  1708. VisualServer::get_singleton()->sync(); //sync if still drawing from previous frames.
  1709. if (OS::get_singleton()->can_draw() && VisualServer::get_singleton()->is_render_loop_enabled()) {
  1710. if ((!force_redraw_requested) && OS::get_singleton()->is_in_low_processor_usage_mode()) {
  1711. if (VisualServer::get_singleton()->has_changed()) {
  1712. VisualServer::get_singleton()->draw(true, scaled_step); // flush visual commands
  1713. Engine::get_singleton()->frames_drawn++;
  1714. }
  1715. } else {
  1716. VisualServer::get_singleton()->draw(true, scaled_step); // flush visual commands
  1717. Engine::get_singleton()->frames_drawn++;
  1718. force_redraw_requested = false;
  1719. }
  1720. }
  1721. idle_process_ticks = OS::get_singleton()->get_ticks_usec() - idle_begin;
  1722. idle_process_max = MAX(idle_process_ticks, idle_process_max);
  1723. uint64_t frame_time = OS::get_singleton()->get_ticks_usec() - ticks;
  1724. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  1725. ScriptServer::get_language(i)->frame();
  1726. }
  1727. AudioServer::get_singleton()->update();
  1728. if (script_debugger) {
  1729. if (script_debugger->is_profiling()) {
  1730. script_debugger->profiling_set_frame_times(USEC_TO_SEC(frame_time), USEC_TO_SEC(idle_process_ticks), USEC_TO_SEC(physics_process_ticks), frame_slice);
  1731. }
  1732. script_debugger->idle_poll();
  1733. }
  1734. frames++;
  1735. Engine::get_singleton()->_idle_frames++;
  1736. if (frame > 1000000) {
  1737. if (editor || project_manager) {
  1738. if (print_fps) {
  1739. print_line(vformat("Editor FPS: %d (%s mspf)", frames, rtos(1000.0 / frames).pad_decimals(1)));
  1740. }
  1741. } else if (GLOBAL_GET("debug/settings/stdout/print_fps") || print_fps) {
  1742. print_line(vformat("Project FPS: %d (%s mspf)", frames, rtos(1000.0 / frames).pad_decimals(1)));
  1743. }
  1744. Engine::get_singleton()->_fps = frames;
  1745. performance->set_process_time(USEC_TO_SEC(idle_process_max));
  1746. performance->set_physics_process_time(USEC_TO_SEC(physics_process_max));
  1747. idle_process_max = 0;
  1748. physics_process_max = 0;
  1749. frame %= 1000000;
  1750. frames = 0;
  1751. }
  1752. iterating--;
  1753. if (fixed_fps != -1)
  1754. return exit;
  1755. OS::get_singleton()->add_frame_delay(OS::get_singleton()->can_draw());
  1756. #ifdef TOOLS_ENABLED
  1757. if (auto_build_solutions) {
  1758. auto_build_solutions = false;
  1759. // Only relevant when running the editor.
  1760. if (!editor) {
  1761. ERR_FAIL_V_MSG(true, "Command line option --build-solutions was passed, but no project is being edited. Aborting.");
  1762. }
  1763. if (!EditorNode::get_singleton()->call_build()) {
  1764. ERR_FAIL_V_MSG(true, "Command line option --build-solutions was passed, but the build callback failed. Aborting.");
  1765. }
  1766. }
  1767. #endif
  1768. return exit || auto_quit;
  1769. }
  1770. void Main::force_redraw() {
  1771. force_redraw_requested = true;
  1772. }
  1773. /* Engine deinitialization
  1774. *
  1775. * Responsible for freeing all the memory allocated by previous setup steps,
  1776. * so that the engine closes cleanly without leaking memory or crashing.
  1777. * The order matters as some of those steps are linked with each other.
  1778. */
  1779. void Main::cleanup(bool p_force) {
  1780. if (!p_force) {
  1781. ERR_FAIL_COND(!_start_success);
  1782. }
  1783. if (script_debugger) {
  1784. // Flush any remaining messages
  1785. script_debugger->idle_poll();
  1786. }
  1787. ResourceLoader::remove_custom_loaders();
  1788. ResourceSaver::remove_custom_savers();
  1789. // Flush before uninitializing the scene, but delete the MessageQueue as late as possible.
  1790. message_queue->flush();
  1791. if (script_debugger) {
  1792. if (use_debug_profiler) {
  1793. script_debugger->profiling_end();
  1794. }
  1795. memdelete(script_debugger);
  1796. }
  1797. OS::get_singleton()->delete_main_loop();
  1798. OS::get_singleton()->_cmdline.clear();
  1799. OS::get_singleton()->_execpath = "";
  1800. OS::get_singleton()->_local_clipboard = "";
  1801. ResourceLoader::clear_translation_remaps();
  1802. ResourceLoader::clear_path_remaps();
  1803. ScriptServer::finish_languages();
  1804. // Sync pending commands that may have been queued from a different thread during ScriptServer finalization
  1805. VisualServer::get_singleton()->sync();
  1806. #ifdef TOOLS_ENABLED
  1807. EditorNode::unregister_editor_types();
  1808. #endif
  1809. if (arvr_server) {
  1810. // cleanup now before we pull the rug from underneath...
  1811. memdelete(arvr_server);
  1812. }
  1813. ImageLoader::cleanup();
  1814. unregister_driver_types();
  1815. unregister_module_types();
  1816. unregister_platform_apis();
  1817. unregister_scene_types();
  1818. unregister_server_types();
  1819. if (audio_server) {
  1820. audio_server->finish();
  1821. memdelete(audio_server);
  1822. }
  1823. if (camera_server) {
  1824. memdelete(camera_server);
  1825. }
  1826. OS::get_singleton()->finalize();
  1827. finalize_physics();
  1828. if (packed_data)
  1829. memdelete(packed_data);
  1830. if (file_access_network_client)
  1831. memdelete(file_access_network_client);
  1832. if (performance)
  1833. memdelete(performance);
  1834. if (input_map)
  1835. memdelete(input_map);
  1836. if (translation_server)
  1837. memdelete(translation_server);
  1838. if (globals)
  1839. memdelete(globals);
  1840. if (engine)
  1841. memdelete(engine);
  1842. if (OS::get_singleton()->is_restart_on_exit_set()) {
  1843. //attempt to restart with arguments
  1844. String exec = OS::get_singleton()->get_executable_path();
  1845. List<String> args = OS::get_singleton()->get_restart_on_exit_arguments();
  1846. OS::ProcessID pid = 0;
  1847. OS::get_singleton()->execute(exec, args, false, &pid);
  1848. OS::get_singleton()->set_restart_on_exit(false, List<String>()); //clear list (uses memory)
  1849. }
  1850. // Now should be safe to delete MessageQueue (famous last words).
  1851. message_queue->flush();
  1852. memdelete(message_queue);
  1853. unregister_core_driver_types();
  1854. unregister_core_types();
  1855. OS::get_singleton()->finalize_core();
  1856. }