main.cpp 97 KB

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