main.cpp 81 KB

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