main.cpp 69 KB

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