main.cpp 74 KB

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