main.cpp 96 KB

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