2022-03-15 13:29:32 +01:00
/*************************************************************************/
/* main.cpp */
/*************************************************************************/
/* This file is part of: */
2022-03-23 20:46:05 +01:00
/* PANDEMONIUM ENGINE */
2022-03-15 13:29:32 +01:00
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
# include "main.h"
2022-11-30 18:12:43 +01:00
# include "core/config/project_settings.h"
2022-03-15 13:29:32 +01:00
# include "core/crypto/crypto.h"
2022-08-17 17:02:24 +02:00
# include "core/input/input_map.h"
2022-03-15 13:29:32 +01:00
# include "core/io/file_access_network.h"
# include "core/io/file_access_pack.h"
# include "core/io/file_access_zip.h"
# include "core/io/image_loader.h"
# include "core/io/ip.h"
# include "core/io/resource_loader.h"
2022-08-17 13:45:14 +02:00
# include "core/object/message_queue.h"
2022-11-30 18:12:43 +01:00
# include "core/object/script_debugger_local.h"
# include "core/object/script_language.h"
2022-03-15 13:29:32 +01:00
# include "core/os/dir_access.h"
# include "core/os/os.h"
# include "core/os/time.h"
# include "core/register_core_types.h"
2022-08-17 14:19:55 +02:00
# include "core/string/translation.h"
2022-03-15 13:29:32 +01:00
# include "core/version.h"
# include "drivers/register_driver_types.h"
# include "main/app_icon.gen.h"
# include "main/input_default.h"
# include "main/main_timer_sync.h"
# include "main/performance.h"
# include "main/splash.gen.h"
# include "main/tests/test_main.h"
# include "modules/register_module_types.h"
# include "platform/register_platform_apis.h"
# include "scene/debugger/script_debugger_remote.h"
# include "scene/main/scene_tree.h"
# include "scene/main/viewport.h"
# include "scene/register_scene_types.h"
# include "scene/resources/packed_scene.h"
# include "servers/audio_server.h"
2023-06-03 20:00:42 +02:00
# include "servers/navigation/navigation_mesh_generator.h"
# include "servers/navigation/navigation_mesh_generator_dummy.h"
2022-03-15 13:29:32 +01:00
# include "servers/navigation_2d_server.h"
# include "servers/navigation_server.h"
# include "servers/physics_2d_server.h"
# include "servers/physics_server.h"
# include "servers/register_server_types.h"
2022-08-19 21:24:36 +02:00
# include "servers/rendering_server_callbacks.h"
2022-03-15 13:29:32 +01:00
# ifdef TOOLS_ENABLED
# include "editor/doc/doc_data.h"
# include "editor/doc/doc_data_class_path.gen.h"
# include "editor/editor_node.h"
# include "editor/editor_settings.h"
# include "editor/editor_translation.h"
# include "editor/progress_dialog.h"
# include "editor/project_manager.h"
2022-07-27 15:07:09 +02:00
# include "editor/script_editor_debugger.h"
2022-03-15 13:29:32 +01:00
# ifndef NO_EDITOR_SPLASH
# include "main/splash_editor.gen.h"
# endif
# endif
2023-02-18 13:22:43 +01:00
# include "modules/modules_enabled.gen.h"
2023-10-02 19:30:35 +02:00
2023-02-18 15:31:58 +01:00
# ifdef MODULE_EDITOR_CODE_EDITOR_ENABLED
2023-02-18 16:22:44 +01:00
# include "editor_code_editor/editor_script_editor.h"
2023-02-18 13:22:43 +01:00
# endif
2023-10-02 19:30:35 +02:00
# ifdef MODULE_GDSCRIPT_ENABLED
# if defined(TOOLS_ENABLED) && !defined(GDSCRIPT_NO_LSP)
# include "modules/gdscript/language_server/gdscript_language_server.h"
# endif // TOOLS_ENABLED && !GDSCRIPT_NO_LSP
# endif // MODULE_GDSCRIPT_ENABLED
2022-03-15 13:29:32 +01:00
/* Static members */
// Singletons
// Initialized in setup()
static Engine * engine = nullptr ;
static ProjectSettings * globals = nullptr ;
static InputMap * input_map = nullptr ;
static TranslationServer * translation_server = nullptr ;
static Performance * performance = nullptr ;
static PackedData * packed_data = nullptr ;
static Time * time_singleton = nullptr ;
# ifdef MINIZIP_ENABLED
static ZipArchive * zip_packed_data = nullptr ;
# endif
static FileAccessNetworkClient * file_access_network_client = nullptr ;
static ScriptDebugger * script_debugger = nullptr ;
static MessageQueue * message_queue = nullptr ;
// Initialized in setup2()
static AudioServer * audio_server = nullptr ;
static PhysicsServer * physics_server = nullptr ;
static Physics2DServer * physics_2d_server = nullptr ;
2022-08-19 21:24:36 +02:00
static RenderingServerCallbacks * rendering_server_callbacks = nullptr ;
2023-06-03 20:00:42 +02:00
static NavigationMeshGeneratorManager * navigation_mesh_generator_manager = nullptr ;
static NavigationMeshGenerator * navigation_mesh_generator = nullptr ;
2022-03-15 13:29:32 +01:00
static NavigationServer * navigation_server = nullptr ;
static Navigation2DServer * navigation_2d_server = nullptr ;
// We error out if setup2() doesn't turn this true
static bool _start_success = false ;
// Drivers
static int video_driver_idx = - 1 ;
static int audio_driver_idx = - 1 ;
// Engine config/tools
static bool editor = false ;
static bool project_manager = false ;
static String locale ;
static bool show_help = false ;
static bool auto_quit = false ;
static OS : : ProcessID allow_focus_steal_pid = 0 ;
static bool delta_sync_after_draw = false ;
2022-07-27 15:07:09 +02:00
# ifdef TOOLS_ENABLED
static String debug_server_uri ;
# endif
2022-03-15 13:29:32 +01:00
// Display
static OS : : VideoMode video_mode ;
static int init_screen = - 1 ;
static bool init_fullscreen = false ;
static bool init_maximized = false ;
static bool init_windowed = false ;
static bool init_always_on_top = false ;
static bool init_use_custom_pos = false ;
static Vector2 init_custom_pos ;
static bool force_lowdpi = false ;
// Debug
static bool use_debug_profiler = false ;
# ifdef DEBUG_ENABLED
static bool debug_collisions = false ;
static bool debug_navigation = false ;
2023-06-10 20:58:49 +02:00
static bool debug_avoidance = false ;
2023-09-02 11:38:01 +02:00
static bool debug_paths = false ;
2022-03-15 13:29:32 +01:00
static bool debug_shader_fallbacks = false ;
# endif
static int frame_delay = 0 ;
static bool disable_render_loop = false ;
static int fixed_fps = - 1 ;
static bool print_fps = false ;
/* Helper methods */
// Used by Mono module, should likely be registered in Engine singleton instead
// FIXME: This is also not 100% accurate, `project_manager` is only true when it was requested,
// but not if e.g. we fail to load and project and fallback to the manager.
bool Main : : is_project_manager ( ) {
return project_manager ;
}
static String unescape_cmdline ( const String & p_str ) {
return p_str . replace ( " %20 " , " " ) ;
}
static String get_full_version_string ( ) {
String hash = String ( VERSION_HASH ) ;
if ( ! hash . empty ( ) ) {
hash = " . " + hash . left ( 9 ) ;
}
return String ( VERSION_FULL_BUILD ) + hash ;
}
// FIXME: Could maybe be moved to PhysicsServerManager and Physics2DServerManager directly
// to have less code in main.cpp.
void initialize_physics ( ) {
// This must be defined BEFORE the 3d physics server is created,
// otherwise it won't always show up in the project settings page.
2022-03-23 20:46:05 +01:00
GLOBAL_DEF ( " physics/3d/pandemonium_physics/use_bvh " , true ) ;
GLOBAL_DEF ( " physics/3d/pandemonium_physics/bvh_collision_margin " , 0.1 ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " physics/3d/pandemonium_physics/bvh_collision_margin " , PropertyInfo ( Variant : : REAL , " physics/3d/pandemonium_physics/bvh_collision_margin " , PROPERTY_HINT_RANGE , " 0.0,2.0,0.01 " ) ) ;
2022-03-15 13:29:32 +01:00
/// 3D Physics Server
physics_server = PhysicsServerManager : : new_server ( ProjectSettings : : get_singleton ( ) - > get ( PhysicsServerManager : : setting_property_name ) ) ;
if ( ! physics_server ) {
// Physics server not found, Use the default physics
physics_server = PhysicsServerManager : : new_default_server ( ) ;
}
ERR_FAIL_COND ( ! physics_server ) ;
physics_server - > init ( ) ;
/// 2D Physics server
physics_2d_server = Physics2DServerManager : : new_server ( ProjectSettings : : get_singleton ( ) - > get ( Physics2DServerManager : : setting_property_name ) ) ;
if ( ! physics_2d_server ) {
// Physics server not found, Use the default physics
physics_2d_server = Physics2DServerManager : : new_default_server ( ) ;
}
ERR_FAIL_COND ( ! physics_2d_server ) ;
physics_2d_server - > init ( ) ;
}
void finalize_physics ( ) {
physics_server - > finish ( ) ;
memdelete ( physics_server ) ;
physics_2d_server - > finish ( ) ;
memdelete ( physics_2d_server ) ;
}
2023-06-03 20:00:42 +02:00
void initialize_navigation_mesh_generator ( ) {
2023-09-03 11:51:09 +02:00
ERR_FAIL_COND ( navigation_mesh_generator ! = NULL ) ;
2023-06-03 20:00:42 +02:00
// Init chosen NavigationMeshGenerator
const String & server_name = GLOBAL_GET ( NavigationMeshGeneratorManager : : setting_property_name ) ;
navigation_mesh_generator = NavigationMeshGeneratorManager : : get_singleton ( ) - > new_server ( server_name ) ;
// Fall back to default if not found
if ( ! navigation_mesh_generator ) {
// Navigation server not found, so use the default.
navigation_mesh_generator = NavigationMeshGeneratorManager : : get_singleton ( ) - > new_default_server ( ) ;
}
// Fall back to dummy if no default server has been registered.
if ( ! navigation_mesh_generator ) {
ERR_PRINT ( " No NavigationMeshGenerator implementation has been registered! Falling back to a dummy implementation: navigation mesh baking features will be unavailable. " ) ;
navigation_mesh_generator = memnew ( NavigationMeshGeneratorDummy ) ;
}
if ( navigation_mesh_generator ) {
2023-09-03 11:51:09 +02:00
navigation_mesh_generator - > init ( ) ;
2023-06-03 20:00:42 +02:00
// need to register singleton earlier so modules / extensions / addons can use it on SCENE / SERVER init level
Engine : : get_singleton ( ) - > add_singleton ( Engine : : Singleton ( " NavigationMeshGenerator " , NavigationMeshGenerator : : get_singleton ( ) ) ) ;
}
ERR_FAIL_NULL_MSG ( navigation_mesh_generator , " Failed to initialize NavigationMeshGenerator. " ) ;
}
void finalize_navigation_mesh_generator ( ) {
2023-09-03 11:51:09 +02:00
ERR_FAIL_COND ( ! navigation_mesh_generator ) ;
navigation_mesh_generator - > finish ( ) ;
2023-06-03 20:00:42 +02:00
memdelete ( navigation_mesh_generator ) ;
navigation_mesh_generator = nullptr ;
}
2022-03-15 13:29:32 +01:00
void initialize_navigation_server ( ) {
ERR_FAIL_COND ( navigation_server ! = nullptr ) ;
2023-04-16 18:20:15 +02:00
ERR_FAIL_COND ( navigation_2d_server ! = nullptr ) ;
/// 3D Navigation Server
navigation_server = NavigationServerManager : : new_server ( ProjectSettings : : get_singleton ( ) - > get ( NavigationServerManager : : setting_property_name ) ) ;
if ( ! navigation_server ) {
// Navigation server not found, Use the default physics
navigation_server = NavigationServerManager : : new_default_server ( ) ;
}
ERR_FAIL_COND ( ! navigation_server ) ;
2023-04-16 18:23:56 +02:00
navigation_server - > init ( ) ;
2023-04-16 18:20:15 +02:00
/// 2D Navigation server
navigation_2d_server = Navigation2DServerManager : : new_server ( ProjectSettings : : get_singleton ( ) - > get ( Navigation2DServerManager : : setting_property_name ) ) ;
if ( ! navigation_2d_server ) {
// Navigation server not found, Use the default physics
navigation_2d_server = Navigation2DServerManager : : new_default_server ( ) ;
}
ERR_FAIL_COND ( ! navigation_2d_server ) ;
2023-04-16 18:23:56 +02:00
navigation_2d_server - > init ( ) ;
2022-03-15 13:29:32 +01:00
}
void finalize_navigation_server ( ) {
2023-09-03 11:46:46 +02:00
navigation_2d_server - > finish ( ) ;
navigation_server - > finish ( ) ;
2023-04-16 18:20:15 +02:00
2022-03-15 13:29:32 +01:00
memdelete ( navigation_2d_server ) ;
navigation_2d_server = nullptr ;
2023-09-03 11:46:46 +02:00
memdelete ( navigation_server ) ;
navigation_server = nullptr ;
2022-03-15 13:29:32 +01:00
}
//#define DEBUG_INIT
# ifdef DEBUG_INIT
# define MAIN_PRINT(m_txt) print_line(m_txt)
# else
# define MAIN_PRINT(m_txt)
# endif
void Main : : print_help ( const char * p_binary ) {
print_line ( String ( VERSION_NAME ) + " v " + get_full_version_string ( ) + " - " + String ( VERSION_WEBSITE ) ) ;
OS : : get_singleton ( ) - > print ( " Free and open source software under the terms of the MIT license. \n " ) ;
OS : : get_singleton ( ) - > print ( " (c) 2007-2022 Juan Linietsky, Ariel Manzur. \n " ) ;
2022-03-23 20:46:05 +01:00
OS : : get_singleton ( ) - > print ( " (c) 2014-2022 Pandemonium Engine contributors. \n " ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > print ( " \n " ) ;
2022-03-23 20:46:05 +01:00
OS : : get_singleton ( ) - > print ( " Usage: %s [options] [path to scene or 'project.pandemonium' file] \n " , p_binary ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > print ( " \n " ) ;
OS : : get_singleton ( ) - > print ( " General options: \n " ) ;
OS : : get_singleton ( ) - > print ( " -h, --help Display this help message. \n " ) ;
OS : : get_singleton ( ) - > print ( " --version Display the version string. \n " ) ;
2022-10-11 12:31:56 +02:00
# ifdef TOOLS_ENABLED
OS : : get_singleton ( ) - > print ( " --version-full-config Display the full config version string (used by the export templates manager). \n " ) ;
# endif
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > print ( " -v, --verbose Use verbose stdout mode. \n " ) ;
OS : : get_singleton ( ) - > print ( " --quiet Quiet mode, silences stdout messages. Errors are still displayed. \n " ) ;
OS : : get_singleton ( ) - > print ( " \n " ) ;
OS : : get_singleton ( ) - > print ( " Run options: \n " ) ;
# ifdef TOOLS_ENABLED
OS : : get_singleton ( ) - > print ( " -e, --editor Start the editor instead of running the scene. \n " ) ;
OS : : get_singleton ( ) - > print ( " -p, --project-manager Start the project manager, even if a project is auto-detected. \n " ) ;
2022-07-27 15:07:09 +02:00
OS : : get_singleton ( ) - > print ( " --debug-server <address> Start the editor debug server (<IP>:<port>, e.g. 127.0.0.1:6007) \n " ) ;
2023-10-02 19:30:35 +02:00
# if defined(MODULE_GDSCRIPT_ENABLED) && !defined(GDSCRIPT_NO_LSP)
OS : : get_singleton ( ) - > print ( " --lsp-port <port> Use the specified port for the language server protocol. The port must be between 0 to 65535. \n " ) ;
# endif // MODULE_GDSCRIPT_ENABLED && !GDSCRIPT_NO_LSP
2022-03-15 13:29:32 +01:00
# endif
OS : : get_singleton ( ) - > print ( " -q, --quit Quit after the first iteration. \n " ) ;
OS : : get_singleton ( ) - > print ( " -l, --language <locale> Use a specific locale (<locale> being a two-letter code). \n " ) ;
2022-03-23 20:46:05 +01:00
OS : : get_singleton ( ) - > print ( " --path <directory> Path to a project (<directory> must contain a 'project.pandemonium' file). \n " ) ;
OS : : get_singleton ( ) - > print ( " -u, --upwards Scan folders upwards for project.pandemonium file. \n " ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > print ( " --main-pack <file> Path to a pack (.pck) file to load. \n " ) ;
OS : : get_singleton ( ) - > print ( " --render-thread <mode> Render thread mode ('unsafe', 'safe', 'separate'). \n " ) ;
OS : : get_singleton ( ) - > print ( " --remote-fs <address> Remote filesystem (<host/IP>[:<port>] address). \n " ) ;
OS : : get_singleton ( ) - > print ( " --remote-fs-password <password> Password for remote filesystem. \n " ) ;
OS : : get_singleton ( ) - > print ( " --audio-driver <driver> Audio driver ( " ) ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_audio_driver_count ( ) ; i + + ) {
if ( i ! = 0 ) {
OS : : get_singleton ( ) - > print ( " , " ) ;
}
OS : : get_singleton ( ) - > print ( " '%s' " , OS : : get_singleton ( ) - > get_audio_driver_name ( i ) ) ;
}
OS : : get_singleton ( ) - > print ( " ). \n " ) ;
OS : : get_singleton ( ) - > print ( " --video-driver <driver> Video driver ( " ) ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_video_driver_count ( ) ; i + + ) {
if ( i ! = 0 ) {
OS : : get_singleton ( ) - > print ( " , " ) ;
}
OS : : get_singleton ( ) - > print ( " '%s' " , OS : : get_singleton ( ) - > get_video_driver_name ( i ) ) ;
}
OS : : get_singleton ( ) - > print ( " ). \n " ) ;
OS : : get_singleton ( ) - > print ( " \n " ) ;
# ifndef SERVER_ENABLED
OS : : get_singleton ( ) - > print ( " Display options: \n " ) ;
OS : : get_singleton ( ) - > print ( " -f, --fullscreen Request fullscreen mode. \n " ) ;
OS : : get_singleton ( ) - > print ( " -m, --maximized Request a maximized window. \n " ) ;
OS : : get_singleton ( ) - > print ( " -w, --windowed Request windowed mode. \n " ) ;
OS : : get_singleton ( ) - > print ( " -t, --always-on-top Request an always-on-top window. \n " ) ;
OS : : get_singleton ( ) - > print ( " --resolution <W>x<H> Request window resolution. \n " ) ;
OS : : get_singleton ( ) - > print ( " --position <X>,<Y> Request window position. \n " ) ;
OS : : get_singleton ( ) - > print ( " --low-dpi Force low-DPI mode (macOS and Windows only). \n " ) ;
OS : : get_singleton ( ) - > print ( " --no-window Run with invisible window. Useful together with --script. \n " ) ;
OS : : get_singleton ( ) - > print ( " --enable-vsync-via-compositor When vsync is enabled, vsync via the OS' window compositor (Windows only). \n " ) ;
OS : : get_singleton ( ) - > print ( " --disable-vsync-via-compositor Disable vsync via the OS' window compositor (Windows only). \n " ) ;
OS : : get_singleton ( ) - > print ( " --enable-delta-smoothing When vsync is enabled, enabled frame delta smoothing. \n " ) ;
OS : : get_singleton ( ) - > print ( " --disable-delta-smoothing Disable frame delta smoothing. \n " ) ;
OS : : get_singleton ( ) - > print ( " --tablet-driver Tablet input driver ( " ) ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_tablet_driver_count ( ) ; i + + ) {
if ( i ! = 0 ) {
OS : : get_singleton ( ) - > print ( " , " ) ;
}
OS : : get_singleton ( ) - > print ( " '%s' " , OS : : get_singleton ( ) - > get_tablet_driver_name ( i ) . utf8 ( ) . get_data ( ) ) ;
}
OS : : get_singleton ( ) - > print ( " ) (Windows only). \n " ) ;
OS : : get_singleton ( ) - > print ( " \n " ) ;
# endif
OS : : get_singleton ( ) - > print ( " Debug options: \n " ) ;
OS : : get_singleton ( ) - > print ( " -d, --debug Debug (local stdout debugger). \n " ) ;
OS : : get_singleton ( ) - > print ( " -b, --breakpoints Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead). \n " ) ;
OS : : get_singleton ( ) - > print ( " --profiling Enable profiling in the script debugger. \n " ) ;
OS : : get_singleton ( ) - > print ( " --remote-debug <address> Remote debug (<host/IP>:<port> address). \n " ) ;
# if defined(DEBUG_ENABLED) && !defined(SERVER_ENABLED)
OS : : get_singleton ( ) - > print ( " --debug-collisions Show collision shapes when running the scene. \n " ) ;
OS : : get_singleton ( ) - > print ( " --debug-navigation Show navigation polygons when running the scene. \n " ) ;
2023-09-02 13:03:30 +02:00
OS : : get_singleton ( ) - > print ( " --debug-avoidance Show navigation avoidance debug visuals when running the scene. \n " ) ;
2023-09-02 11:38:01 +02:00
OS : : get_singleton ( ) - > print ( " --debug-paths Show path lines when running the scene. \n " ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > print ( " --debug-shader-fallbacks Use the fallbacks of the shaders which have one when running the scene (GL ES 3 only). \n " ) ;
# endif
OS : : get_singleton ( ) - > print ( " --frame-delay <ms> Simulate high CPU load (delay each frame by <ms> milliseconds). \n " ) ;
OS : : get_singleton ( ) - > print ( " --time-scale <scale> Force time scale (higher values are faster, 1.0 is normal speed). \n " ) ;
OS : : get_singleton ( ) - > print ( " --disable-render-loop Disable render loop so rendering only occurs when called explicitly from script. \n " ) ;
OS : : get_singleton ( ) - > print ( " --disable-crash-handler Disable crash handler when supported by the platform code. \n " ) ;
OS : : get_singleton ( ) - > print ( " --fixed-fps <fps> Force a fixed number of frames per second. This setting disables real-time synchronization. \n " ) ;
OS : : get_singleton ( ) - > print ( " --print-fps Print the frames per second to the stdout. \n " ) ;
OS : : get_singleton ( ) - > print ( " \n " ) ;
OS : : get_singleton ( ) - > print ( " Standalone tools: \n " ) ;
OS : : get_singleton ( ) - > print ( " -s, --script <script> Run a script. \n " ) ;
OS : : get_singleton ( ) - > print ( " --check-only Only parse for errors and quit (use with --script). \n " ) ;
# ifdef TOOLS_ENABLED
OS : : get_singleton ( ) - > print ( " --export <preset> <path> Export the project using the given preset and matching release template. The preset name should match one defined in export_presets.cfg. \n " ) ;
OS : : get_singleton ( ) - > print ( " <path> should be absolute or relative to the project directory, and include the filename for the binary (e.g. 'builds/game.exe'). The target directory should exist. \n " ) ;
OS : : get_singleton ( ) - > print ( " --export-debug <preset> <path> Same as --export, but using the debug template. \n " ) ;
OS : : get_singleton ( ) - > print ( " --export-pack <preset> <path> Same as --export, but only export the game pack for the given preset. The <path> extension determines whether it will be in PCK or ZIP format. \n " ) ;
OS : : get_singleton ( ) - > print ( " --doctool [<path>] Dump the engine API reference to the given <path> (defaults to current dir) in XML format, merging if existing files are found. \n " ) ;
OS : : get_singleton ( ) - > print ( " --no-docbase Disallow dumping the base types (used with --doctool). \n " ) ;
2023-05-01 15:32:01 +02:00
OS : : get_singleton ( ) - > print ( " --benchmark Benchmark the run time and print it to console. \n " ) ;
OS : : get_singleton ( ) - > print ( " --benchmark-file <path> Benchmark the run time and save it to a given file in JSON format. The path should be absolute. \n " ) ;
2022-03-15 13:29:32 +01:00
# ifdef DEBUG_METHODS_ENABLED
2022-03-23 20:46:05 +01:00
OS : : get_singleton ( ) - > print ( " --gdnative-generate-json-api Generate JSON dump of the Pandemonium API for GDNative bindings. \n " ) ;
2022-03-15 13:29:32 +01:00
# endif
OS : : get_singleton ( ) - > print ( " --test <test> Run a unit test ( " ) ;
const char * * test_names = tests_get_names ( ) ;
const char * comma = " " ;
while ( * test_names ) {
OS : : get_singleton ( ) - > print ( " %s'%s' " , comma , * test_names ) ;
test_names + + ;
comma = " , " ;
}
OS : : get_singleton ( ) - > print ( " ). \n " ) ;
# endif
}
/* Engine initialization
*
* Consists of several methods that are called by each platform ' s specific main ( argc , argv ) .
* To fully understand engine init , one should therefore start from the platform ' s main and
* see how it calls into the Main class ' methods .
*
* The initialization is typically done in 3 steps ( with the setup2 step triggered either
* automatically by setup , or manually in the platform ' s main ) .
*
* - setup ( execpath , argc , argv , p_second_phase ) is the main entry point for all platforms ,
* responsible for the initialization of all low level singletons and core types , and parsing
* command line arguments to configure things accordingly .
* If p_second_phase is true , it will chain into setup2 ( ) ( default behaviour ) . This is
* disabled on some platforms ( Android , iOS , UWP ) which trigger the second step in their
* own time .
*
* - setup2 ( p_main_tid_override ) registers high level servers and singletons , displays the
* boot splash , then registers higher level types ( scene , editor , etc . ) .
*
* - start ( ) is the last step and that ' s where command line tools can run , or the main loop
* can be created eventually and the project settings put into action . That ' s also where
* the editor node is created , if relevant .
* start ( ) does it own argument parsing for a subset of the command line arguments described
* in help , it ' s a bit messy and should be globalized with the setup ( ) parsing somehow .
*/
Error Main : : setup ( const char * execpath , int argc , char * argv [ ] , bool p_second_phase ) {
# if defined(DEBUG_ENABLED) && !defined(NO_THREADS)
check_lockless_atomics ( ) ;
# endif
RID_OwnerBase : : init_rid ( ) ;
OS : : get_singleton ( ) - > initialize_core ( ) ;
2023-05-01 15:32:01 +02:00
// Benchmark tracking must be done after `OS::get_singleton()->initialize_core()` as on some
// platforms, it's used to set up the time utilities.
OS : : get_singleton ( ) - > benchmark_begin_measure ( " startup_begin " ) ;
2022-03-15 13:29:32 +01:00
engine = memnew ( Engine ) ;
MAIN_PRINT ( " Main: Initialize CORE " ) ;
2023-05-01 15:32:01 +02:00
OS : : get_singleton ( ) - > benchmark_begin_measure ( " core " ) ;
2022-03-15 13:29:32 +01:00
register_core_types ( ) ;
register_core_driver_types ( ) ;
MAIN_PRINT ( " Main: Initialize Globals " ) ;
globals = memnew ( ProjectSettings ) ;
input_map = memnew ( InputMap ) ;
time_singleton = memnew ( Time ) ;
register_core_settings ( ) ; //here globals is present
translation_server = memnew ( TranslationServer ) ;
2023-06-03 20:00:42 +02:00
navigation_mesh_generator_manager = memnew ( NavigationMeshGeneratorManager ) ;
2022-03-15 13:29:32 +01:00
performance = memnew ( Performance ) ;
ClassDB : : register_class < Performance > ( ) ;
engine - > add_singleton ( Engine : : Singleton ( " Performance " , performance ) ) ;
2022-07-29 10:17:20 +02:00
GLOBAL_DEF ( " debug/settings/crash_handler/message " , String ( " Please include this when reporting the bug to the project developer. " ) ) ;
GLOBAL_DEF ( " debug/settings/crash_handler/message.editor " , String ( " Please include this when reporting the bug on: https://github.com/Relintai/pandemonium_engine/issues " ) ) ;
2022-03-15 13:29:32 +01:00
MAIN_PRINT ( " Main: Parse CMDLine " ) ;
/* argument parsing and main creation */
List < String > args ;
List < String > main_args ;
for ( int i = 0 ; i < argc ; i + + ) {
args . push_back ( String : : utf8 ( argv [ i ] ) ) ;
}
List < String > : : Element * I = args . front ( ) ;
I = args . front ( ) ;
while ( I ) {
I - > get ( ) = unescape_cmdline ( I - > get ( ) . strip_edges ( ) ) ;
I = I - > next ( ) ;
}
I = args . front ( ) ;
String video_driver = " " ;
String audio_driver = " " ;
String tablet_driver = " " ;
String project_path = " . " ;
bool upwards = false ;
String debug_mode ;
String debug_host ;
bool skip_breakpoints = false ;
String main_pack ;
bool quiet_stdout = false ;
int rtm = - 1 ;
String remotefs ;
String remotefs_pass ;
Vector < String > breakpoints ;
bool use_custom_res = true ;
bool force_res = false ;
bool saw_vsync_via_compositor_override = false ;
bool delta_smoothing_override = false ;
# ifdef TOOLS_ENABLED
bool found_project = false ;
# endif
packed_data = PackedData : : get_singleton ( ) ;
if ( ! packed_data ) {
packed_data = memnew ( PackedData ) ;
}
# ifdef MINIZIP_ENABLED
//XXX: always get_singleton() == 0x0
zip_packed_data = ZipArchive : : get_singleton ( ) ;
//TODO: remove this temporary fix
if ( ! zip_packed_data ) {
zip_packed_data = memnew ( ZipArchive ) ;
}
packed_data - > add_pack_source ( zip_packed_data ) ;
# endif
2022-07-29 21:35:41 +02:00
// Default exit code, can be modified for certain errors.
Error exit_code = ERR_INVALID_PARAMETER ;
2022-03-15 13:29:32 +01:00
I = args . front ( ) ;
while ( I ) {
# ifdef OSX_ENABLED
// Ignore the process serial number argument passed by macOS Gatekeeper.
2022-03-23 20:46:05 +01:00
// Otherwise, Pandemonium would try to open a non-existent project on the first start and abort.
2022-03-15 13:29:32 +01:00
if ( I - > get ( ) . begins_with ( " -psn_ " ) ) {
I = I - > next ( ) ;
continue ;
}
# endif
List < String > : : Element * N = I - > next ( ) ;
if ( I - > get ( ) = = " -h " | | I - > get ( ) = = " --help " | | I - > get ( ) = = " /? " ) { // display help
show_help = true ;
2022-07-29 21:45:04 +02:00
exit_code = ERR_HELP ; // Hack to force an early exit in `main()` with a success code.
2022-03-15 13:29:32 +01:00
goto error ;
} else if ( I - > get ( ) = = " --version " ) {
print_line ( get_full_version_string ( ) ) ;
2022-07-29 21:45:04 +02:00
exit_code = ERR_HELP ; // Hack to force an early exit in `main()` with a success code.
2022-03-15 13:29:32 +01:00
goto error ;
2022-10-11 12:31:56 +02:00
# ifdef TOOLS_ENABLED
} else if ( I - > get ( ) = = " --version-full-config " ) {
print_line ( String ( VERSION_FULL_CONFIG ) ) ;
exit_code = ERR_HELP ; // Hack to force an early exit in `main()` with a success code.
goto error ;
# endif
2022-03-15 13:29:32 +01:00
} else if ( I - > get ( ) = = " -v " | | I - > get ( ) = = " --verbose " ) { // verbose output
OS : : get_singleton ( ) - > _verbose_stdout = true ;
} else if ( I - > get ( ) = = " --quiet " ) { // quieter output
quiet_stdout = true ;
} else if ( I - > get ( ) = = " --audio-driver " ) { // audio driver
if ( I - > next ( ) ) {
audio_driver = I - > next ( ) - > get ( ) ;
bool found = false ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_audio_driver_count ( ) ; i + + ) {
if ( audio_driver = = OS : : get_singleton ( ) - > get_audio_driver_name ( i ) ) {
found = true ;
}
}
if ( ! found ) {
OS : : get_singleton ( ) - > print ( " Unknown audio driver '%s', aborting. \n Valid options are " , audio_driver . utf8 ( ) . get_data ( ) ) ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_audio_driver_count ( ) ; i + + ) {
if ( i = = OS : : get_singleton ( ) - > get_audio_driver_count ( ) - 1 ) {
OS : : get_singleton ( ) - > print ( " and " ) ;
} else if ( i ! = 0 ) {
OS : : get_singleton ( ) - > print ( " , " ) ;
}
OS : : get_singleton ( ) - > print ( " '%s' " , OS : : get_singleton ( ) - > get_audio_driver_name ( i ) ) ;
}
OS : : get_singleton ( ) - > print ( " . \n " ) ;
goto error ;
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing audio driver argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --video-driver " ) { // force video driver
if ( I - > next ( ) ) {
video_driver = I - > next ( ) - > get ( ) ;
bool found = false ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_video_driver_count ( ) ; i + + ) {
if ( video_driver = = OS : : get_singleton ( ) - > get_video_driver_name ( i ) ) {
found = true ;
}
}
if ( ! found ) {
OS : : get_singleton ( ) - > print ( " Unknown video driver '%s', aborting. \n Valid options are " , video_driver . utf8 ( ) . get_data ( ) ) ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_video_driver_count ( ) ; i + + ) {
if ( i = = OS : : get_singleton ( ) - > get_video_driver_count ( ) - 1 ) {
OS : : get_singleton ( ) - > print ( " and " ) ;
} else if ( i ! = 0 ) {
OS : : get_singleton ( ) - > print ( " , " ) ;
}
OS : : get_singleton ( ) - > print ( " '%s' " , OS : : get_singleton ( ) - > get_video_driver_name ( i ) ) ;
}
OS : : get_singleton ( ) - > print ( " . \n " ) ;
goto error ;
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing video driver argument, aborting. \n " ) ;
goto error ;
}
# ifndef SERVER_ENABLED
} else if ( I - > get ( ) = = " -f " | | I - > get ( ) = = " --fullscreen " ) { // force fullscreen
init_fullscreen = true ;
} else if ( I - > get ( ) = = " -m " | | I - > get ( ) = = " --maximized " ) { // force maximized window
init_maximized = true ;
video_mode . maximized = true ;
} else if ( I - > get ( ) = = " -w " | | I - > get ( ) = = " --windowed " ) { // force windowed window
init_windowed = true ;
} else if ( I - > get ( ) = = " -t " | | I - > get ( ) = = " --always-on-top " ) { // force always-on-top window
init_always_on_top = true ;
} else if ( I - > get ( ) = = " --resolution " ) { // force resolution
if ( I - > next ( ) ) {
String vm = I - > next ( ) - > get ( ) ;
if ( vm . find ( " x " ) = = - 1 ) { // invalid parameter format
OS : : get_singleton ( ) - > print ( " Invalid resolution '%s', it should be e.g. '1280x720'. \n " , vm . utf8 ( ) . get_data ( ) ) ;
goto error ;
}
int w = vm . get_slice ( " x " , 0 ) . to_int ( ) ;
int h = vm . get_slice ( " x " , 1 ) . to_int ( ) ;
if ( w < = 0 | | h < = 0 ) {
OS : : get_singleton ( ) - > print ( " Invalid resolution '%s', width and height must be above 0. \n " , vm . utf8 ( ) . get_data ( ) ) ;
goto error ;
}
video_mode . width = w ;
video_mode . height = h ;
force_res = true ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing resolution argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --position " ) { // set window position
if ( I - > next ( ) ) {
String vm = I - > next ( ) - > get ( ) ;
if ( vm . find ( " , " ) = = - 1 ) { // invalid parameter format
OS : : get_singleton ( ) - > print ( " Invalid position '%s', it should be e.g. '80,128'. \n " , vm . utf8 ( ) . get_data ( ) ) ;
goto error ;
}
int x = vm . get_slice ( " , " , 0 ) . to_int ( ) ;
int y = vm . get_slice ( " , " , 1 ) . to_int ( ) ;
init_custom_pos = Point2 ( x , y ) ;
init_use_custom_pos = true ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing position argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --low-dpi " ) { // force low DPI (macOS only)
force_lowdpi = true ;
} else if ( I - > get ( ) = = " --no-window " ) { // run with an invisible window
OS : : get_singleton ( ) - > set_no_window_mode ( true ) ;
} else if ( I - > get ( ) = = " --tablet-driver " ) {
if ( I - > next ( ) ) {
tablet_driver = I - > next ( ) - > get ( ) ;
bool found = false ;
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_tablet_driver_count ( ) ; i + + ) {
if ( tablet_driver = = OS : : get_singleton ( ) - > get_tablet_driver_name ( i ) ) {
found = true ;
}
}
if ( ! found ) {
OS : : get_singleton ( ) - > print ( " Unknown tablet driver '%s', aborting. \n " , tablet_driver . utf8 ( ) . get_data ( ) ) ;
goto error ;
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing tablet driver argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --enable-vsync-via-compositor " ) {
video_mode . vsync_via_compositor = true ;
saw_vsync_via_compositor_override = true ;
} else if ( I - > get ( ) = = " --disable-vsync-via-compositor " ) {
video_mode . vsync_via_compositor = false ;
saw_vsync_via_compositor_override = true ;
} else if ( I - > get ( ) = = " --enable-delta-smoothing " ) {
OS : : get_singleton ( ) - > set_delta_smoothing ( true ) ;
delta_smoothing_override = true ;
} else if ( I - > get ( ) = = " --disable-delta-smoothing " ) {
OS : : get_singleton ( ) - > set_delta_smoothing ( false ) ;
delta_smoothing_override = true ;
# endif
} else if ( I - > get ( ) = = " --profiling " ) { // enable profiling
use_debug_profiler = true ;
} else if ( I - > get ( ) = = " -l " | | I - > get ( ) = = " --language " ) { // language
if ( I - > next ( ) ) {
locale = I - > next ( ) - > get ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing language argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --remote-fs " ) { // remote filesystem
if ( I - > next ( ) ) {
remotefs = I - > next ( ) - > get ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing remote filesystem address, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --remote-fs-password " ) { // remote filesystem password
if ( I - > next ( ) ) {
remotefs_pass = I - > next ( ) - > get ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing remote filesystem password, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --render-thread " ) { // render thread mode
if ( I - > next ( ) ) {
if ( I - > next ( ) - > get ( ) = = " safe " ) {
rtm = OS : : RENDER_THREAD_SAFE ;
} else if ( I - > next ( ) - > get ( ) = = " unsafe " ) {
rtm = OS : : RENDER_THREAD_UNSAFE ;
} else if ( I - > next ( ) - > get ( ) = = " separate " ) {
rtm = OS : : RENDER_SEPARATE_THREAD ;
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing render thread mode argument, aborting. \n " ) ;
goto error ;
}
# ifdef TOOLS_ENABLED
} else if ( I - > get ( ) = = " -e " | | I - > get ( ) = = " --editor " ) { // starts editor
editor = true ;
} else if ( I - > get ( ) = = " -p " | | I - > get ( ) = = " --project-manager " ) { // starts project manager
project_manager = true ;
2022-07-27 15:07:09 +02:00
} else if ( I - > get ( ) = = " --debug-server " ) {
if ( I - > next ( ) ) {
debug_server_uri = I - > next ( ) - > get ( ) ;
if ( debug_server_uri . find ( " : " ) = = - 1 ) { // wrong address
OS : : get_singleton ( ) - > print ( " Invalid debug server address. It should be of the form <bind_address>:<port>. \n " ) ;
goto error ;
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing remote debug server server, aborting. \n " ) ;
goto error ;
}
2022-03-15 13:29:32 +01:00
} else if ( I - > get ( ) = = " --export " | | I - > get ( ) = = " --export-debug " | | I - > get ( ) = = " --export-pack " ) { // Export project
editor = true ;
main_args . push_back ( I - > get ( ) ) ;
# endif
} else if ( I - > get ( ) = = " --path " ) { // set path of project to start or edit
if ( I - > next ( ) ) {
String p = I - > next ( ) - > get ( ) ;
if ( OS : : get_singleton ( ) - > set_cwd ( p ) = = OK ) {
//nothing
} else {
project_path = I - > next ( ) - > get ( ) ; //use project_path instead
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing relative or absolute path, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " -u " | | I - > get ( ) = = " --upwards " ) { // scan folders upwards
upwards = true ;
} else if ( I - > get ( ) = = " -q " | | I - > get ( ) = = " --quit " ) { // Auto quit at the end of the first main loop iteration
auto_quit = true ;
2022-03-23 20:46:05 +01:00
} else if ( I - > get ( ) . ends_with ( " project.pandemonium " ) ) {
2022-03-15 13:29:32 +01:00
String path ;
String file = I - > get ( ) ;
int sep = MAX ( file . rfind ( " / " ) , file . rfind ( " \\ " ) ) ;
if ( sep = = - 1 ) {
path = " . " ;
} else {
path = file . substr ( 0 , sep ) ;
}
if ( OS : : get_singleton ( ) - > set_cwd ( path ) = = OK ) {
// path already specified, don't override
} else {
project_path = path ;
}
# ifdef TOOLS_ENABLED
editor = true ;
# endif
} else if ( I - > get ( ) = = " -b " | | I - > get ( ) = = " --breakpoints " ) { // add breakpoints
if ( I - > next ( ) ) {
String bplist = I - > next ( ) - > get ( ) ;
breakpoints = bplist . split ( " , " ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing list of breakpoints, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --frame-delay " ) { // force frame delay
if ( I - > next ( ) ) {
frame_delay = I - > next ( ) - > get ( ) . to_int ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing frame delay argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --time-scale " ) { // force time scale
if ( I - > next ( ) ) {
Engine : : get_singleton ( ) - > set_time_scale ( I - > next ( ) - > get ( ) . to_double ( ) ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing time scale argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --main-pack " ) {
if ( I - > next ( ) ) {
main_pack = I - > next ( ) - > get ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing path to main pack file, aborting. \n " ) ;
goto error ;
} ;
} else if ( I - > get ( ) = = " -d " | | I - > get ( ) = = " --debug " ) {
debug_mode = " local " ;
OS : : get_singleton ( ) - > _debug_stdout = true ;
# if defined(DEBUG_ENABLED) && !defined(SERVER_ENABLED)
} else if ( I - > get ( ) = = " --debug-collisions " ) {
debug_collisions = true ;
} else if ( I - > get ( ) = = " --debug-navigation " ) {
debug_navigation = true ;
2023-06-10 20:58:49 +02:00
} else if ( I - > get ( ) = = " --debug-avoidance " ) {
debug_avoidance = true ;
2023-09-02 11:38:01 +02:00
} else if ( I - > get ( ) = = " --debug-paths " ) {
debug_paths = true ;
2022-03-15 13:29:32 +01:00
} else if ( I - > get ( ) = = " --debug-shader-fallbacks " ) {
debug_shader_fallbacks = true ;
# endif
} else if ( I - > get ( ) = = " --remote-debug " ) {
if ( I - > next ( ) ) {
debug_mode = " remote " ;
debug_host = I - > next ( ) - > get ( ) ;
if ( debug_host . find ( " : " ) = = - 1 ) { // wrong address
OS : : get_singleton ( ) - > print ( " Invalid debug host address, it should be of the form <host/IP>:<port>. \n " ) ;
goto error ;
}
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing remote debug host address, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --allow_focus_steal_pid " ) { // not exposed to user
if ( I - > next ( ) ) {
allow_focus_steal_pid = I - > next ( ) - > get ( ) . to_int64 ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing editor PID argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --disable-render-loop " ) {
disable_render_loop = true ;
} else if ( I - > get ( ) = = " --fixed-fps " ) {
if ( I - > next ( ) ) {
fixed_fps = I - > next ( ) - > get ( ) . to_int ( ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing fixed-fps argument, aborting. \n " ) ;
goto error ;
}
} else if ( I - > get ( ) = = " --print-fps " ) {
print_fps = true ;
} else if ( I - > get ( ) = = " --disable-crash-handler " ) {
OS : : get_singleton ( ) - > disable_crash_handler ( ) ;
} else if ( I - > get ( ) = = " --skip-breakpoints " ) {
skip_breakpoints = true ;
2023-05-01 15:32:01 +02:00
} else if ( I - > get ( ) = = " --benchmark " ) {
OS : : get_singleton ( ) - > set_use_benchmark ( true ) ;
} else if ( I - > get ( ) = = " --benchmark-file " ) {
if ( I - > next ( ) ) {
OS : : get_singleton ( ) - > set_use_benchmark ( true ) ;
String benchmark_file = I - > next ( ) - > get ( ) ;
OS : : get_singleton ( ) - > set_benchmark_file ( benchmark_file ) ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing <path> argument for --startup-benchmark-file <path>. \n " ) ;
OS : : get_singleton ( ) - > print ( " Missing <path> argument for --benchmark-file <path>. \n " ) ;
goto error ;
}
2023-10-02 19:30:35 +02:00
# if defined(TOOLS_ENABLED) && !defined(GDSCRIPT_NO_LSP)
} else if ( I - > get ( ) = = " --lsp-port " ) {
if ( I - > next ( ) ) {
int port_override = I - > next ( ) - > get ( ) . to_int ( ) ;
if ( port_override < 0 | | port_override > 65535 ) {
OS : : get_singleton ( ) - > print ( " <port> argument for --lsp-port <port> must be between 0 and 65535. \n " ) ;
goto error ;
}
GDScriptLanguageServer : : port_override = port_override ;
N = I - > next ( ) - > next ( ) ;
} else {
OS : : get_singleton ( ) - > print ( " Missing <port> argument for --lsp-port <port>. \n " ) ;
goto error ;
}
# endif // TOOLS_ENABLED && !GDSCRIPT_NO_LSP
2022-03-15 13:29:32 +01:00
} else {
main_args . push_back ( I - > get ( ) ) ;
}
I = N ;
}
# ifdef TOOLS_ENABLED
if ( editor & & project_manager ) {
OS : : get_singleton ( ) - > print ( " Error: Command line arguments implied opening both editor and project manager, which is not possible. Aborting. \n " ) ;
goto error ;
}
# endif
// Network file system needs to be configured before globals, since globals are based on the
2022-03-23 20:46:05 +01:00
// 'project.pandemonium' file which will only be available through the network if this is enabled
2022-03-15 13:29:32 +01:00
FileAccessNetwork : : configure ( ) ;
if ( remotefs ! = " " ) {
file_access_network_client = memnew ( FileAccessNetworkClient ) ;
int port ;
if ( remotefs . find ( " : " ) ! = - 1 ) {
port = remotefs . get_slicec ( ' : ' , 1 ) . to_int ( ) ;
remotefs = remotefs . get_slicec ( ' : ' , 0 ) ;
} else {
port = 6010 ;
}
Error err = file_access_network_client - > connect ( remotefs , port , remotefs_pass ) ;
if ( err ) {
OS : : get_singleton ( ) - > printerr ( " Could not connect to remotefs: %s:%i. \n " , remotefs . utf8 ( ) . get_data ( ) , port ) ;
goto error ;
}
FileAccess : : make_default < FileAccessNetwork > ( FileAccess : : ACCESS_RESOURCES ) ;
}
if ( globals - > setup ( project_path , main_pack , upwards , editor ) = = OK ) {
# ifdef TOOLS_ENABLED
found_project = true ;
# endif
} else {
# ifdef TOOLS_ENABLED
editor = false ;
# else
const String error_msg = " Error: Couldn't load project data at path \" " + project_path + " \" . Is the .pck file missing? \n If you've renamed the executable, the associated .pck file should also be renamed to match the executable's name (without the extension). \n " ;
OS : : get_singleton ( ) - > print ( " %s " , error_msg . utf8 ( ) . get_data ( ) ) ;
OS : : get_singleton ( ) - > alert ( error_msg ) ;
goto error ;
# endif
}
// Initialize user data dir.
OS : : get_singleton ( ) - > ensure_user_data_dir ( ) ;
2023-09-16 00:27:49 +02:00
GLOBAL_DEF_RST ( " memory/limits/multithreaded_server/rid_pool_prealloc " , 60 ) ;
2022-03-15 13:29:32 +01:00
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
2023-09-16 00:27:49 +02:00
GLOBAL_DEF_RST ( " network/limits/debugger_stdout/max_chars_per_second " , 2048 ) ;
2022-03-15 13:29:32 +01:00
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 " ) ) ;
2023-09-16 00:27:49 +02:00
GLOBAL_DEF_RST ( " network/limits/debugger_stdout/max_messages_per_frame " , 10 ) ;
2022-03-15 13:29:32 +01:00
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 " ) ) ;
2023-09-16 00:27:49 +02:00
GLOBAL_DEF_RST ( " network/limits/debugger_stdout/max_errors_per_second " , 100 ) ;
2022-03-15 13:29:32 +01:00
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 " ) ) ;
2023-09-16 00:27:49 +02:00
GLOBAL_DEF_RST ( " network/limits/debugger_stdout/max_warnings_per_second " , 100 ) ;
2022-03-15 13:29:32 +01:00
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 " ) ) ;
if ( debug_mode = = " remote " ) {
ScriptDebuggerRemote * sdr = memnew ( ScriptDebuggerRemote ) ;
uint16_t debug_port = 6007 ;
if ( debug_host . find ( " : " ) ! = - 1 ) {
int sep_pos = debug_host . rfind ( " : " ) ;
debug_port = debug_host . substr ( sep_pos + 1 , debug_host . length ( ) ) . to_int ( ) ;
debug_host = debug_host . substr ( 0 , sep_pos ) ;
}
Error derr = sdr - > connect_to_host ( debug_host , debug_port ) ;
sdr - > set_skip_breakpoints ( skip_breakpoints ) ;
if ( derr ! = OK ) {
memdelete ( sdr ) ;
} else {
script_debugger = sdr ;
sdr - > set_allow_focus_steal_pid ( allow_focus_steal_pid ) ;
}
} else if ( debug_mode = = " local " ) {
script_debugger = memnew ( ScriptDebuggerLocal ) ;
OS : : get_singleton ( ) - > initialize_debugging ( ) ;
}
if ( script_debugger ) {
//there is a debugger, parse breakpoints
for ( int i = 0 ; i < breakpoints . size ( ) ; i + + ) {
String bp = breakpoints [ i ] ;
int sp = bp . rfind ( " : " ) ;
ERR_CONTINUE_MSG ( sp = = - 1 , " Invalid breakpoint: ' " + bp + " ', expected file:line format. " ) ;
script_debugger - > insert_breakpoint ( bp . substr ( sp + 1 , bp . length ( ) ) . to_int ( ) , bp . substr ( 0 , sp ) ) ;
}
}
# ifdef TOOLS_ENABLED
if ( editor ) {
packed_data - > set_disabled ( true ) ;
}
# endif
# ifdef TOOLS_ENABLED
if ( editor ) {
Engine : : get_singleton ( ) - > set_editor_hint ( true ) ;
main_args . push_back ( " --editor " ) ;
if ( ! init_windowed ) {
init_maximized = true ;
video_mode . maximized = true ;
}
}
if ( ! project_manager & & ! editor ) {
// Determine if the project manager should be requested
project_manager = main_args . size ( ) = = 0 & & ! found_project ;
}
# endif
// Only flush stdout in debug builds by default, as spamming `print()` will
// decrease performance if this is enabled.
GLOBAL_DEF_RST ( " application/run/flush_stdout_on_print " , false ) ;
GLOBAL_DEF_RST ( " application/run/flush_stdout_on_print.debug " , true ) ;
GLOBAL_DEF ( " logging/file_logging/enable_file_logging " , false ) ;
// Only file logging by default on desktop platforms as logs can't be
// accessed easily on mobile/Web platforms (if at all).
// This also prevents logs from being created for the editor instance, as feature tags
// are disabled while in the editor (even if they should logically apply).
GLOBAL_DEF ( " logging/file_logging/enable_file_logging.pc " , true ) ;
2022-03-23 20:46:05 +01:00
GLOBAL_DEF ( " logging/file_logging/log_path " , " user://logs/pandemonium.log " ) ;
2022-03-15 13:29:32 +01:00
GLOBAL_DEF ( " logging/file_logging/max_log_files " , 5 ) ;
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
if ( ! project_manager & & ! editor & & FileAccess : : get_create_func ( FileAccess : : ACCESS_USERDATA ) & & GLOBAL_GET ( " logging/file_logging/enable_file_logging " ) ) {
// Don't create logs for the project manager as they would be written to
// the current working directory, which is inconvenient.
String base_path = GLOBAL_GET ( " logging/file_logging/log_path " ) ;
int max_files = GLOBAL_GET ( " logging/file_logging/max_log_files " ) ;
OS : : get_singleton ( ) - > add_logger ( memnew ( RotatedFileLogger ( base_path , max_files ) ) ) ;
}
if ( main_args . size ( ) = = 0 & & String ( GLOBAL_DEF ( " application/run/main_scene " , " " ) ) = = " " ) {
# ifdef TOOLS_ENABLED
if ( ! editor & & ! project_manager ) {
# endif
const String error_msg = " Error: Can't run project: no main scene defined in the project. \n " ;
OS : : get_singleton ( ) - > print ( " %s " , error_msg . utf8 ( ) . get_data ( ) ) ;
OS : : get_singleton ( ) - > alert ( error_msg ) ;
goto error ;
# ifdef TOOLS_ENABLED
}
# endif
}
if ( editor | | project_manager ) {
Engine : : get_singleton ( ) - > set_editor_hint ( true ) ;
use_custom_res = false ;
input_map - > load_default ( ) ; //keys for editor
} else {
input_map - > load_from_globals ( ) ; //keys for game
}
if ( bool ( ProjectSettings : : get_singleton ( ) - > get ( " application/run/disable_stdout " ) ) ) {
quiet_stdout = true ;
}
if ( bool ( ProjectSettings : : get_singleton ( ) - > get ( " application/run/disable_stderr " ) ) ) {
_print_error_enabled = false ;
} ;
if ( quiet_stdout ) {
_print_line_enabled = false ;
}
Logger : : set_flush_stdout_on_print ( ProjectSettings : : get_singleton ( ) - > get ( " application/run/flush_stdout_on_print " ) ) ;
OS : : get_singleton ( ) - > set_cmdline ( execpath , main_args ) ;
2022-12-21 18:59:01 +01:00
GLOBAL_DEF_RST ( " rendering/quality/driver/driver_name " , " GLES2 " ) ;
2022-03-15 17:01:21 +01:00
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " rendering/quality/driver/driver_name " , PropertyInfo ( Variant : : STRING , " rendering/quality/driver/driver_name " , PROPERTY_HINT_ENUM , " GLES2 " ) ) ;
2022-03-15 13:29:32 +01:00
if ( video_driver = = " " ) {
video_driver = GLOBAL_GET ( " rendering/quality/driver/driver_name " ) ;
}
GLOBAL_DEF ( " rendering/quality/driver/fallback_to_gles2 " , false ) ;
// Assigning here, to be sure that it appears in docs
GLOBAL_DEF ( " rendering/2d/options/use_nvidia_rect_flicker_workaround " , false ) ;
if ( use_custom_res ) {
if ( ! force_res ) {
video_mode . width = GLOBAL_GET ( " display/window/size/width " ) ;
video_mode . height = GLOBAL_GET ( " display/window/size/height " ) ;
if ( globals - > has_setting ( " display/window/size/test_width " ) & & globals - > has_setting ( " display/window/size/test_height " ) ) {
int tw = globals - > get ( " display/window/size/test_width " ) ;
if ( tw > 0 ) {
video_mode . width = tw ;
}
int th = globals - > get ( " display/window/size/test_height " ) ;
if ( th > 0 ) {
video_mode . height = th ;
}
}
}
video_mode . resizable = GLOBAL_GET ( " display/window/size/resizable " ) ;
video_mode . borderless_window = GLOBAL_GET ( " display/window/size/borderless " ) ;
video_mode . fullscreen = GLOBAL_GET ( " display/window/size/fullscreen " ) ;
video_mode . always_on_top = GLOBAL_GET ( " display/window/size/always_on_top " ) ;
}
if ( ! force_lowdpi ) {
OS : : get_singleton ( ) - > _allow_hidpi = GLOBAL_DEF ( " display/window/dpi/allow_hidpi " , false ) ;
}
video_mode . use_vsync = GLOBAL_DEF_RST ( " display/window/vsync/use_vsync " , true ) ;
OS : : get_singleton ( ) - > _use_vsync = video_mode . use_vsync ;
if ( ! saw_vsync_via_compositor_override ) {
// If one of the command line options to enable/disable vsync via the
// window compositor ("--enable-vsync-via-compositor" or
// "--disable-vsync-via-compositor") was present then it overrides the
// project setting.
video_mode . vsync_via_compositor = GLOBAL_DEF ( " display/window/vsync/vsync_via_compositor " , false ) ;
}
OS : : get_singleton ( ) - > _vsync_via_compositor = video_mode . vsync_via_compositor ;
2022-03-23 20:46:05 +01:00
if ( tablet_driver = = " " ) { // specified in project.pandemonium
2022-03-15 13:29:32 +01:00
tablet_driver = GLOBAL_DEF_RST_NOVAL ( " display/window/tablet_driver " , OS : : get_singleton ( ) - > get_tablet_driver_name ( 0 ) ) ;
}
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_tablet_driver_count ( ) ; i + + ) {
if ( tablet_driver = = OS : : get_singleton ( ) - > get_tablet_driver_name ( i ) ) {
OS : : get_singleton ( ) - > set_current_tablet_driver ( OS : : get_singleton ( ) - > get_tablet_driver_name ( i ) ) ;
break ;
}
}
if ( tablet_driver = = " " ) {
OS : : get_singleton ( ) - > set_current_tablet_driver ( OS : : get_singleton ( ) - > get_tablet_driver_name ( 0 ) ) ;
}
OS : : get_singleton ( ) - > _allow_layered = GLOBAL_DEF ( " display/window/per_pixel_transparency/allowed " , false ) ;
video_mode . layered = GLOBAL_DEF ( " display/window/per_pixel_transparency/enabled " , false ) ;
GLOBAL_DEF ( " rendering/quality/intended_usage/framebuffer_allocation " , 2 ) ;
GLOBAL_DEF ( " rendering/quality/intended_usage/framebuffer_allocation.mobile " , 3 ) ;
if ( editor | | project_manager ) {
// The editor and project manager always detect and use hiDPI if needed
OS : : get_singleton ( ) - > _allow_hidpi = true ;
OS : : get_singleton ( ) - > _allow_layered = false ;
}
Engine : : get_singleton ( ) - > _gpu_pixel_snap = GLOBAL_DEF_ALIAS ( " rendering/2d/snapping/use_gpu_pixel_snap " , " rendering/quality/2d/use_pixel_snap " , false ) ;
OS : : get_singleton ( ) - > _keep_screen_on = GLOBAL_DEF ( " display/window/energy_saving/keep_screen_on " , true ) ;
if ( rtm = = - 1 ) {
rtm = GLOBAL_DEF ( " rendering/threads/thread_model " , OS : : RENDER_THREAD_SAFE ) ;
}
GLOBAL_DEF ( " rendering/threads/thread_safe_bvh " , false ) ;
if ( rtm > = 0 & & rtm < 3 ) {
# ifdef NO_THREADS
rtm = OS : : RENDER_THREAD_UNSAFE ; // No threads available on this platform.
# else
if ( editor ) {
rtm = OS : : RENDER_THREAD_SAFE ;
}
# endif
OS : : get_singleton ( ) - > _render_thread_mode = OS : : RenderThreadMode ( rtm ) ;
}
/* Determine audio and video drivers */
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_video_driver_count ( ) ; i + + ) {
if ( video_driver = = OS : : get_singleton ( ) - > get_video_driver_name ( i ) ) {
video_driver_idx = i ;
break ;
}
}
if ( video_driver_idx < 0 ) {
video_driver_idx = 0 ;
}
2022-03-23 20:46:05 +01:00
if ( audio_driver = = " " ) { // specified in project.pandemonium
2022-03-15 13:29:32 +01:00
audio_driver = GLOBAL_DEF_RST_NOVAL ( " audio/driver " , OS : : get_singleton ( ) - > get_audio_driver_name ( 0 ) ) ;
}
for ( int i = 0 ; i < OS : : get_singleton ( ) - > get_audio_driver_count ( ) ; i + + ) {
if ( audio_driver = = OS : : get_singleton ( ) - > get_audio_driver_name ( i ) ) {
audio_driver_idx = i ;
break ;
}
}
if ( audio_driver_idx < 0 ) {
audio_driver_idx = 0 ;
}
{
String orientation = GLOBAL_DEF ( " display/window/handheld/orientation " , " landscape " ) ;
if ( orientation = = " portrait " ) {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_PORTRAIT ) ;
} else if ( orientation = = " reverse_landscape " ) {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_REVERSE_LANDSCAPE ) ;
} else if ( orientation = = " reverse_portrait " ) {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_REVERSE_PORTRAIT ) ;
} else if ( orientation = = " sensor_landscape " ) {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_SENSOR_LANDSCAPE ) ;
} else if ( orientation = = " sensor_portrait " ) {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_SENSOR_PORTRAIT ) ;
} else if ( orientation = = " sensor " ) {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_SENSOR ) ;
} else {
OS : : get_singleton ( ) - > set_screen_orientation ( OS : : SCREEN_LANDSCAPE ) ;
}
}
2022-03-24 11:10:56 +01:00
Engine : : get_singleton ( ) - > set_physics_ticks_per_second ( GLOBAL_DEF ( " physics/common/physics_ticks_per_second " , 60 ) ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " physics/common/physics_ticks_per_second " , PropertyInfo ( Variant : : INT , " physics/common/physics_ticks_per_second " , PROPERTY_HINT_RANGE , " 1,1000,1 " ) ) ;
2022-03-15 13:29:32 +01:00
Engine : : get_singleton ( ) - > set_physics_jitter_fix ( GLOBAL_DEF ( " physics/common/physics_jitter_fix " , 0.5 ) ) ;
Engine : : get_singleton ( ) - > set_target_fps ( GLOBAL_DEF ( " debug/settings/fps/force_fps " , 0 ) ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " debug/settings/fps/force_fps " , PropertyInfo ( Variant : : INT , " debug/settings/fps/force_fps " , PROPERTY_HINT_RANGE , " 0,1000,1 " ) ) ;
GLOBAL_DEF ( " physics/common/enable_pause_aware_picking " , false ) ;
GLOBAL_DEF ( " debug/settings/stdout/print_fps " , false ) ;
GLOBAL_DEF ( " debug/settings/stdout/verbose_stdout " , false ) ;
if ( ! OS : : get_singleton ( ) - > _verbose_stdout ) { // Not manually overridden.
OS : : get_singleton ( ) - > _verbose_stdout = GLOBAL_GET ( " debug/settings/stdout/verbose_stdout " ) ;
}
if ( frame_delay = = 0 ) {
frame_delay = GLOBAL_DEF ( " application/run/frame_delay_msec " , 0 ) ;
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
}
OS : : get_singleton ( ) - > set_low_processor_usage_mode ( GLOBAL_DEF ( " application/run/low_processor_mode " , false ) ) ;
OS : : get_singleton ( ) - > set_low_processor_usage_mode_sleep_usec ( GLOBAL_DEF ( " application/run/low_processor_mode_sleep_usec " , 6900 ) ) ; // Roughly 144 FPS
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
delta_sync_after_draw = GLOBAL_DEF ( " application/run/delta_sync_after_draw " , false ) ;
GLOBAL_DEF ( " application/run/delta_smoothing " , true ) ;
if ( ! delta_smoothing_override ) {
OS : : get_singleton ( ) - > set_delta_smoothing ( GLOBAL_GET ( " application/run/delta_smoothing " ) ) ;
}
2022-11-02 02:37:01 +01:00
GLOBAL_DEF ( " display/window/ios/allow_high_refresh_rate " , true ) ;
2022-03-15 13:29:32 +01:00
GLOBAL_DEF ( " display/window/ios/hide_home_indicator " , true ) ;
2022-11-02 02:08:13 +01:00
GLOBAL_DEF ( " display/window/ios/hide_status_bar " , true ) ;
GLOBAL_DEF ( " display/window/ios/suppress_ui_gesture " , true ) ;
2022-03-15 13:29:32 +01:00
Engine : : get_singleton ( ) - > set_frame_delay ( frame_delay ) ;
# ifdef DEBUG_ENABLED
if ( ! Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
GLOBAL_DEF ( " rendering/gles3/shaders/debug_shader_fallbacks " , debug_shader_fallbacks ) ;
ProjectSettings : : get_singleton ( ) - > set_hide_from_editor ( " rendering/gles3/shaders/debug_shader_fallbacks " , true ) ;
}
# endif
message_queue = memnew ( MessageQueue ) ;
if ( p_second_phase ) {
return setup2 ( ) ;
}
2023-05-01 15:32:01 +02:00
OS : : get_singleton ( ) - > benchmark_end_measure ( " core " ) ;
2022-03-15 13:29:32 +01:00
return OK ;
error :
video_driver = " " ;
audio_driver = " " ;
tablet_driver = " " ;
project_path = " " ;
args . clear ( ) ;
main_args . clear ( ) ;
if ( show_help ) {
print_help ( execpath ) ;
}
if ( performance ) {
memdelete ( performance ) ;
}
if ( input_map ) {
memdelete ( input_map ) ;
}
if ( time_singleton ) {
memdelete ( time_singleton ) ;
}
if ( translation_server ) {
memdelete ( translation_server ) ;
}
2023-06-03 20:00:42 +02:00
if ( navigation_mesh_generator_manager ) {
memdelete ( navigation_mesh_generator_manager ) ;
}
2022-03-15 13:29:32 +01:00
if ( globals ) {
memdelete ( globals ) ;
}
if ( engine ) {
memdelete ( engine ) ;
}
if ( script_debugger ) {
memdelete ( script_debugger ) ;
}
if ( packed_data ) {
memdelete ( packed_data ) ;
}
if ( file_access_network_client ) {
memdelete ( file_access_network_client ) ;
}
unregister_core_driver_types ( ) ;
unregister_core_types ( ) ;
OS : : get_singleton ( ) - > _cmdline . clear ( ) ;
if ( message_queue ) {
memdelete ( message_queue ) ;
}
OS : : get_singleton ( ) - > finalize_core ( ) ;
locale = String ( ) ;
2022-07-29 21:35:41 +02:00
return exit_code ;
2022-03-15 13:29:32 +01:00
}
Error Main : : setup2 ( Thread : : ID p_main_tid_override ) {
// Print engine name and version
print_line ( String ( VERSION_NAME ) + " v " + get_full_version_string ( ) + " - " + String ( VERSION_WEBSITE ) ) ;
# if !defined(NO_THREADS)
if ( p_main_tid_override ) {
Thread : : main_thread_id = p_main_tid_override ;
}
# endif
if ( GLOBAL_GET ( " debug/settings/stdout/print_fps " ) | | print_fps ) {
// Print requested V-Sync mode at startup to diagnose the printed FPS not going above the monitor refresh rate.
if ( OS : : get_singleton ( ) - > _use_vsync & & OS : : get_singleton ( ) - > _vsync_via_compositor ) {
# ifdef WINDOWS_ENABLED
// V-Sync via compositor is only supported on Windows.
print_line ( " Requested V-Sync mode: Enabled (via compositor) - FPS will likely be capped to the monitor refresh rate. " ) ;
# else
print_line ( " Requested V-Sync mode: Enabled - FPS will likely be capped to the monitor refresh rate. " ) ;
# endif
} else if ( OS : : get_singleton ( ) - > _use_vsync ) {
print_line ( " Requested V-Sync mode: Enabled - FPS will likely be capped to the monitor refresh rate. " ) ;
} else {
print_line ( " Requested V-Sync mode: Disabled " ) ;
}
}
# ifdef UNIX_ENABLED
// Print warning before initializing audio.
2022-03-23 20:46:05 +01:00
if ( OS : : get_singleton ( ) - > get_environment ( " USER " ) = = " root " & & ! OS : : get_singleton ( ) - > has_environment ( " PANDEMONIUM_SILENCE_ROOT_WARNING " ) ) {
WARN_PRINT ( " Started the engine as `root`/superuser. This is a security risk, and subsystems like audio may not work correctly. \n Set the environment variable `PANDEMONIUM_SILENCE_ROOT_WARNING` to 1 to silence this warning. " ) ;
2022-03-15 13:29:32 +01:00
}
# endif
Error err = OS : : get_singleton ( ) - > initialize ( video_mode , video_driver_idx , audio_driver_idx ) ;
if ( err ! = OK ) {
return err ;
}
print_line ( " " ) ; //add a blank line for readability
if ( init_use_custom_pos ) {
OS : : get_singleton ( ) - > set_window_position ( init_custom_pos ) ;
}
// right moment to create and initialize the audio server
audio_server = memnew ( AudioServer ) ;
audio_server - > init ( ) ;
2022-08-19 21:24:36 +02:00
// and finally setup this property under rendering_server
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > set_render_loop_enabled ( ! disable_render_loop ) ;
2022-03-15 13:29:32 +01:00
register_core_singletons ( ) ;
MAIN_PRINT ( " Main: Setup Logo " ) ;
# if defined(JAVASCRIPT_ENABLED) || defined(ANDROID_ENABLED)
bool show_logo = false ;
# else
bool show_logo = true ;
# endif
if ( init_screen ! = - 1 ) {
OS : : get_singleton ( ) - > set_current_screen ( init_screen ) ;
}
if ( init_windowed ) {
//do none..
} else if ( init_maximized ) {
OS : : get_singleton ( ) - > set_window_maximized ( true ) ;
} else if ( init_fullscreen ) {
OS : : get_singleton ( ) - > set_window_fullscreen ( true ) ;
}
if ( init_always_on_top ) {
OS : : get_singleton ( ) - > set_window_always_on_top ( true ) ;
}
register_server_types ( ) ;
MAIN_PRINT ( " Main: Load Boot Image " ) ;
Color clear = GLOBAL_DEF ( " rendering/environment/default_clear_color " , Color ( 0.3 , 0.3 , 0.3 ) ) ;
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > set_default_clear_color ( clear ) ;
2022-03-15 13:29:32 +01:00
if ( show_logo ) { //boot logo!
const bool boot_logo_image = GLOBAL_DEF ( " application/boot_splash/show_image " , true ) ;
const String boot_logo_path = String ( GLOBAL_DEF ( " application/boot_splash/image " , String ( ) ) ) . strip_edges ( ) ;
const bool boot_logo_scale = GLOBAL_DEF ( " application/boot_splash/fullsize " , true ) ;
const bool boot_logo_filter = GLOBAL_DEF ( " application/boot_splash/use_filter " , true ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " application/boot_splash/image " , PropertyInfo ( Variant : : STRING , " application/boot_splash/image " , PROPERTY_HINT_FILE , " *.png " ) ) ;
Ref < Image > boot_logo ;
if ( boot_logo_image ) {
if ( boot_logo_path ! = String ( ) ) {
boot_logo . instance ( ) ;
Error load_err = ImageLoader : : load_image ( boot_logo_path , boot_logo ) ;
if ( load_err )
ERR_PRINT ( " Non-existing or invalid boot splash at ' " + boot_logo_path + " '. Loading default splash. " ) ;
}
} else {
// Create a 1× 1 transparent image. This will effectively hide the splash image.
boot_logo . instance ( ) ;
boot_logo - > create ( 1 , 1 , false , Image : : FORMAT_RGBA8 ) ;
boot_logo - > lock ( ) ;
boot_logo - > set_pixel ( 0 , 0 , Color ( 0 , 0 , 0 , 0 ) ) ;
boot_logo - > unlock ( ) ;
}
# if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
const Color boot_bg_color =
GLOBAL_DEF ( " application/boot_splash/bg_color " ,
( editor | | project_manager ) ? boot_splash_editor_bg_color : boot_splash_bg_color ) ;
# else
const Color boot_bg_color = GLOBAL_DEF ( " application/boot_splash/bg_color " , boot_splash_bg_color ) ;
# endif
if ( boot_logo . is_valid ( ) ) {
OS : : get_singleton ( ) - > _msec_splash = OS : : get_singleton ( ) - > get_ticks_msec ( ) ;
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > set_boot_image ( boot_logo , boot_bg_color , boot_logo_scale , boot_logo_filter ) ;
2022-03-15 13:29:32 +01:00
} else {
# ifndef NO_DEFAULT_BOOT_LOGO
MAIN_PRINT ( " Main: Create bootsplash " ) ;
# if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
Ref < Image > splash = ( editor | | project_manager ) ? memnew ( Image ( boot_splash_editor_png ) ) : memnew ( Image ( boot_splash_png ) ) ;
# else
Ref < Image > splash = memnew ( Image ( boot_splash_png ) ) ;
# endif
MAIN_PRINT ( " Main: ClearColor " ) ;
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > set_default_clear_color ( boot_bg_color ) ;
2022-03-15 13:29:32 +01:00
MAIN_PRINT ( " Main: Image " ) ;
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > set_boot_image ( splash , boot_bg_color , false ) ;
2022-03-15 13:29:32 +01:00
# endif
}
# ifdef TOOLS_ENABLED
if ( OS : : get_singleton ( ) - > get_bundle_icon_path ( ) . empty ( ) ) {
Ref < Image > icon = memnew ( Image ( app_icon_png ) ) ;
OS : : get_singleton ( ) - > set_icon ( icon ) ;
}
# endif
}
MAIN_PRINT ( " Main: DCC " ) ;
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > set_default_clear_color ( GLOBAL_DEF ( " rendering/environment/default_clear_color " , Color ( 0.3 , 0.3 , 0.3 ) ) ) ;
2022-03-15 13:29:32 +01:00
GLOBAL_DEF ( " application/config/icon " , String ( ) ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " application/config/icon " ,
PropertyInfo ( Variant : : STRING , " application/config/icon " ,
PROPERTY_HINT_FILE , " *.png,*.webp,*.svg " ) ) ;
GLOBAL_DEF ( " application/config/macos_native_icon " , String ( ) ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " application/config/macos_native_icon " , PropertyInfo ( Variant : : STRING , " application/config/macos_native_icon " , PROPERTY_HINT_FILE , " *.icns " ) ) ;
GLOBAL_DEF ( " application/config/windows_native_icon " , String ( ) ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " application/config/windows_native_icon " , PropertyInfo ( Variant : : STRING , " application/config/windows_native_icon " , PROPERTY_HINT_FILE , " *.ico " ) ) ;
InputDefault * id = Object : : cast_to < InputDefault > ( Input : : get_singleton ( ) ) ;
if ( id ) {
agile_input_event_flushing = GLOBAL_DEF ( " input_devices/buffering/agile_event_flushing " , false ) ;
if ( bool ( GLOBAL_DEF ( " input_devices/pointing/emulate_touch_from_mouse " , false ) ) & & ! ( editor | | project_manager ) ) {
if ( ! OS : : get_singleton ( ) - > has_touchscreen_ui_hint ( ) ) {
//only if no touchscreen ui hint, set emulation
id - > set_emulate_touch_from_mouse ( true ) ;
}
}
id - > set_emulate_mouse_from_touch ( bool ( GLOBAL_DEF ( " input_devices/pointing/emulate_mouse_from_touch " , true ) ) ) ;
}
MAIN_PRINT ( " Main: Load Translations and Remaps " ) ;
translation_server - > setup ( ) ; //register translations, load them, etc.
if ( locale ! = " " ) {
translation_server - > set_locale ( locale ) ;
}
translation_server - > load_translations ( ) ;
ResourceLoader : : load_translation_remaps ( ) ; //load remaps for resources
ResourceLoader : : load_path_remaps ( ) ;
MAIN_PRINT ( " Main: Load Scene Types " ) ;
register_scene_types ( ) ;
# ifdef TOOLS_ENABLED
ClassDB : : set_current_api ( ClassDB : : API_EDITOR ) ;
EditorNode : : register_editor_types ( ) ;
ClassDB : : set_current_api ( ClassDB : : API_CORE ) ;
# endif
MAIN_PRINT ( " Main: Load Modules, Physics, Drivers, Scripts " ) ;
register_platform_apis ( ) ;
2023-01-15 17:09:46 +01:00
2023-01-15 17:04:00 +01:00
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_START ) ;
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_SINGLETON ) ;
2023-01-15 11:46:13 +01:00
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_CORE ) ;
2023-01-15 17:04:00 +01:00
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_DRIVER ) ;
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_PLATFORM ) ;
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_SERVER ) ;
2023-06-06 07:47:05 +02:00
initialize_physics ( ) ;
initialize_navigation_mesh_generator ( ) ;
initialize_navigation_server ( ) ;
register_server_singletons ( ) ;
2023-01-15 17:04:00 +01:00
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_SCENE ) ;
2023-01-15 17:09:46 +01:00
if ( Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_EDITOR ) ;
}
2023-01-15 17:04:00 +01:00
//register_module_types(ModuleRegistrationLevel::MODULE_REGISTRATION_LEVEL_TEST);
register_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_FINALIZE ) ;
2022-03-15 13:29:32 +01:00
// Theme needs modules to be initialized so that sub-resources can be loaded.
initialize_theme ( ) ;
GLOBAL_DEF ( " display/mouse_cursor/custom_image " , String ( ) ) ;
GLOBAL_DEF ( " display/mouse_cursor/custom_image_hotspot " , Vector2 ( ) ) ;
GLOBAL_DEF ( " display/mouse_cursor/tooltip_position_offset " , Point2 ( 10 , 10 ) ) ;
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 " ) ) ;
if ( String ( ProjectSettings : : get_singleton ( ) - > get ( " display/mouse_cursor/custom_image " ) ) ! = String ( ) ) {
Ref < Texture > cursor = ResourceLoader : : load ( ProjectSettings : : get_singleton ( ) - > get ( " display/mouse_cursor/custom_image " ) ) ;
if ( cursor . is_valid ( ) ) {
Vector2 hotspot = ProjectSettings : : get_singleton ( ) - > get ( " display/mouse_cursor/custom_image_hotspot " ) ;
Input : : get_singleton ( ) - > set_custom_mouse_cursor ( cursor , Input : : CURSOR_ARROW , hotspot ) ;
}
}
register_driver_types ( ) ;
// This loads global classes, so it must happen before custom loaders and savers are registered
ScriptServer : : init_languages ( ) ;
audio_server - > load_default_bus_layout ( ) ;
if ( use_debug_profiler & & script_debugger ) {
script_debugger - > profiling_start ( ) ;
}
2022-08-19 21:24:36 +02:00
rendering_server_callbacks = memnew ( RenderingServerCallbacks ) ;
RenderingServer : : get_singleton ( ) - > callbacks_register ( rendering_server_callbacks ) ;
2022-03-15 13:29:32 +01:00
_start_success = true ;
ClassDB : : set_current_api ( ClassDB : : API_NONE ) ; //no more api is registered at this point
print_verbose ( " CORE API HASH: " + uitos ( ClassDB : : get_api_hash ( ClassDB : : API_CORE ) ) ) ;
print_verbose ( " EDITOR API HASH: " + uitos ( ClassDB : : get_api_hash ( ClassDB : : API_EDITOR ) ) ) ;
MAIN_PRINT ( " Main: Done " ) ;
return OK ;
}
// everything the main loop needs to know about frame timings
static MainTimerSync main_timer_sync ;
bool Main : : start ( ) {
ERR_FAIL_COND_V ( ! _start_success , false ) ;
bool hasicon = false ;
String doc_tool_path ;
String positional_arg ;
String game_path ;
String script ;
String test ;
bool check_only = false ;
# ifdef TOOLS_ENABLED
bool doc_base = true ;
String _export_preset ;
bool export_debug = false ;
bool export_pack_only = false ;
# endif
main_timer_sync . init ( OS : : get_singleton ( ) - > get_ticks_usec ( ) ) ;
List < String > args = OS : : get_singleton ( ) - > get_cmdline_args ( ) ;
for ( int i = 0 ; i < args . size ( ) ; i + + ) {
//parameters that do not have an argument to the right
if ( args [ i ] = = " --check-only " ) {
check_only = true ;
# ifdef TOOLS_ENABLED
} else if ( args [ i ] = = " --no-docbase " ) {
doc_base = false ;
} else if ( args [ i ] = = " -e " | | args [ i ] = = " --editor " ) {
editor = true ;
} else if ( args [ i ] = = " -p " | | args [ i ] = = " --project-manager " ) {
project_manager = true ;
# endif
} else if ( args [ i ] . length ( ) & & args [ i ] [ 0 ] ! = ' - ' & & positional_arg = = " " ) {
positional_arg = args [ i ] ;
if ( args [ i ] . ends_with ( " .scn " ) | |
args [ i ] . ends_with ( " .tscn " ) | |
args [ i ] . ends_with ( " .escn " ) | |
args [ i ] . ends_with ( " .res " ) | |
args [ i ] . ends_with ( " .tres " ) ) {
// Only consider the positional argument to be a scene path if it ends with
2022-03-23 20:46:05 +01:00
// a file extension associated with Pandemonium scenes. This makes it possible
2022-03-15 13:29:32 +01:00
// for projects to parse command-line arguments for custom CLI arguments
// or other file extensions without trouble. This can be used to implement
// "drag-and-drop onto executable" logic, which can prove helpful
// for non-game applications.
game_path = args [ i ] ;
}
}
//parameters that have an argument to the right
else if ( i < ( args . size ( ) - 1 ) ) {
bool parsed_pair = true ;
if ( args [ i ] = = " -s " | | args [ i ] = = " --script " ) {
script = args [ i + 1 ] ;
} else if ( args [ i ] = = " --test " ) {
test = args [ i + 1 ] ;
# ifdef TOOLS_ENABLED
} else if ( args [ i ] = = " --doctool " ) {
doc_tool_path = args [ i + 1 ] ;
if ( doc_tool_path . begins_with ( " - " ) ) {
// Assuming other command line arg, so default to cwd.
doc_tool_path = " . " ;
parsed_pair = false ;
}
} else if ( args [ i ] = = " --export " ) {
editor = true ; //needs editor
_export_preset = args [ i + 1 ] ;
} else if ( args [ i ] = = " --export-debug " ) {
editor = true ; //needs editor
_export_preset = args [ i + 1 ] ;
export_debug = true ;
} else if ( args [ i ] = = " --export-pack " ) {
editor = true ;
_export_preset = args [ i + 1 ] ;
export_pack_only = true ;
# endif
} else {
// The parameter does not match anything known, don't skip the next argument
parsed_pair = false ;
}
if ( parsed_pair ) {
i + + ;
}
} else if ( args [ i ] = = " --doctool " ) {
// Handle case where no path is given to --doctool.
doc_tool_path = " . " ;
}
}
2022-06-28 17:13:00 +02:00
uint64_t minimum_time_msec = GLOBAL_DEF ( " application/boot_splash/minimum_display_time " , 0 ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " application/boot_splash/minimum_display_time " ,
PropertyInfo ( Variant : : INT ,
" application/boot_splash/minimum_display_time " ,
PROPERTY_HINT_RANGE ,
" 0,100,1,or_greater " ) ) ; // No negative numbers.
2022-03-15 13:29:32 +01:00
# ifdef TOOLS_ENABLED
if ( doc_tool_path ! = " " ) {
Engine : : get_singleton ( ) - > set_editor_hint ( true ) ; // Needed to instance editor-only classes for their default values
// Translate the class reference only when `-l LOCALE` parameter is given.
if ( ! locale . empty ( ) & & locale ! = " en " ) {
load_doc_translations ( locale ) ;
}
{
DirAccessRef da = DirAccess : : open ( doc_tool_path ) ;
ERR_FAIL_COND_V_MSG ( ! da , false , " Argument supplied to --doctool must be a valid directory path. " ) ;
}
DocData doc ;
doc . generate ( doc_base ) ;
DocData docsrc ;
2023-01-15 19:12:50 +01:00
RBMap < String , String > doc_data_classes ;
2023-01-15 19:42:08 +01:00
RBSet < String > checked_paths ;
2022-03-15 13:29:32 +01:00
print_line ( " Loading docs... " ) ;
for ( int i = 0 ; i < _doc_data_class_path_count ; i + + ) {
// Custom modules are always located by absolute path.
String path = _doc_data_class_paths [ i ] . path ;
if ( path . is_rel_path ( ) ) {
path = doc_tool_path . plus_file ( path ) ;
}
String name = _doc_data_class_paths [ i ] . name ;
doc_data_classes [ name ] = path ;
if ( ! checked_paths . has ( path ) ) {
checked_paths . insert ( path ) ;
// Create the module documentation directory if it doesn't exist
DirAccess * da = DirAccess : : create_for_path ( path ) ;
da - > make_dir_recursive ( path ) ;
memdelete ( da ) ;
docsrc . load_classes ( path ) ;
print_line ( " Loading docs from: " + path ) ;
}
}
String index_path = doc_tool_path . plus_file ( " doc/classes " ) ;
// Create the main documentation directory if it doesn't exist
DirAccess * da = DirAccess : : create_for_path ( index_path ) ;
da - > make_dir_recursive ( index_path ) ;
memdelete ( da ) ;
docsrc . load_classes ( index_path ) ;
checked_paths . insert ( index_path ) ;
print_line ( " Loading docs from: " + index_path ) ;
print_line ( " Merging docs... " ) ;
doc . merge_from ( docsrc ) ;
2023-01-15 19:42:08 +01:00
for ( RBSet < String > : : Element * E = checked_paths . front ( ) ; E ; E = E - > next ( ) ) {
2022-03-15 13:29:32 +01:00
print_line ( " Erasing old docs at: " + E - > get ( ) ) ;
DocData : : erase_classes ( E - > get ( ) ) ;
}
print_line ( " Generating new docs... " ) ;
doc . save_classes ( index_path , doc_data_classes ) ;
return false ;
}
# endif
if ( script = = " " & & game_path = = " " & & String ( GLOBAL_DEF ( " application/run/main_scene " , " " ) ) ! = " " ) {
game_path = GLOBAL_DEF ( " application/run/main_scene " , " " ) ;
}
MainLoop * main_loop = nullptr ;
if ( editor ) {
main_loop = memnew ( SceneTree ) ;
} ;
String main_loop_type = GLOBAL_DEF ( " application/run/main_loop_type " , " SceneTree " ) ;
if ( test ! = " " ) {
# ifdef TOOLS_ENABLED
main_loop = test_main ( test , args ) ;
if ( ! main_loop ) {
return false ;
}
# endif
} else if ( script ! = " " ) {
Ref < Script > script_res = ResourceLoader : : load ( script ) ;
ERR_FAIL_COND_V_MSG ( script_res . is_null ( ) , false , " Can't load script: " + script ) ;
if ( check_only ) {
if ( ! script_res - > is_valid ( ) ) {
OS : : get_singleton ( ) - > set_exit_code ( EXIT_FAILURE ) ;
} else {
OS : : get_singleton ( ) - > set_exit_code ( EXIT_SUCCESS ) ;
}
return false ;
}
if ( script_res - > can_instance ( ) ) {
StringName instance_type = script_res - > get_instance_base_type ( ) ;
Object * obj = ClassDB : : instance ( instance_type ) ;
MainLoop * script_loop = Object : : cast_to < MainLoop > ( obj ) ;
if ( ! script_loop ) {
if ( obj ) {
memdelete ( obj ) ;
}
ERR_FAIL_V_MSG ( false , vformat ( " Can't load the script \" %s \" as it doesn't inherit from SceneTree or MainLoop. " , script ) ) ;
}
script_loop - > set_init_script ( script_res ) ;
main_loop = script_loop ;
} else {
return false ;
}
} else { // Not based on script path.
if ( ! editor & & ! ClassDB : : class_exists ( main_loop_type ) & & ScriptServer : : is_global_class ( main_loop_type ) ) {
String script_path = ScriptServer : : get_global_class_path ( main_loop_type ) ;
Ref < Script > script_res = ResourceLoader : : load ( script_path , " Script " , true ) ;
StringName script_base = ScriptServer : : get_global_class_native_base ( main_loop_type ) ;
Object * obj = ClassDB : : instance ( script_base ) ;
MainLoop * script_loop = Object : : cast_to < MainLoop > ( obj ) ;
if ( ! script_loop ) {
if ( obj ) {
memdelete ( obj ) ;
}
OS : : get_singleton ( ) - > alert ( " Error: Invalid MainLoop script base type: " + script_base ) ;
ERR_FAIL_V_MSG ( false , vformat ( " The global class %s does not inherit from SceneTree or MainLoop. " , main_loop_type ) ) ;
}
script_loop - > set_init_script ( script_res ) ;
main_loop = script_loop ;
}
}
if ( ! main_loop & & main_loop_type = = " " ) {
main_loop_type = " SceneTree " ;
}
if ( ! main_loop ) {
if ( ! ClassDB : : class_exists ( main_loop_type ) ) {
OS : : get_singleton ( ) - > alert ( " Error: MainLoop type doesn't exist: " + main_loop_type ) ;
return false ;
} else {
Object * ml = ClassDB : : instance ( main_loop_type ) ;
ERR_FAIL_COND_V_MSG ( ! ml , false , " Can't instance MainLoop type. " ) ;
main_loop = Object : : cast_to < MainLoop > ( ml ) ;
if ( ! main_loop ) {
memdelete ( ml ) ;
ERR_FAIL_V_MSG ( false , " Invalid MainLoop type. " ) ;
}
}
}
if ( main_loop - > is_class ( " SceneTree " ) ) {
SceneTree * sml = Object : : cast_to < SceneTree > ( main_loop ) ;
# ifdef DEBUG_ENABLED
if ( debug_collisions ) {
sml - > set_debug_collisions_hint ( true ) ;
}
if ( debug_navigation ) {
sml - > set_debug_navigation_hint ( true ) ;
2023-09-04 21:43:06 +02:00
NavigationServer : : get_singleton ( ) - > set_debug_navigation_enabled ( true ) ;
2023-06-10 20:58:49 +02:00
}
if ( debug_avoidance ) {
2023-09-04 21:43:06 +02:00
NavigationServer : : get_singleton ( ) - > set_debug_avoidance_enabled ( true ) ;
2023-06-10 20:58:49 +02:00
}
2023-09-02 11:38:01 +02:00
if ( debug_paths ) {
sml - > set_debug_paths_hint ( true ) ;
}
2023-06-10 20:58:49 +02:00
if ( debug_navigation | | debug_avoidance ) {
2023-06-05 18:05:15 +02:00
NavigationServer : : get_singleton ( ) - > set_active ( true ) ;
2023-06-09 22:03:42 +02:00
NavigationServer : : get_singleton ( ) - > set_debug_enabled ( true ) ;
2022-03-15 13:29:32 +01:00
}
# endif
ResourceLoader : : add_custom_loaders ( ) ;
ResourceSaver : : add_custom_savers ( ) ;
if ( ! project_manager & & ! editor ) { // game
if ( game_path ! = " " | | script ! = " " ) {
if ( script_debugger & & script_debugger - > is_remote ( ) ) {
ScriptDebuggerRemote * remote_debugger = static_cast < ScriptDebuggerRemote * > ( script_debugger ) ;
remote_debugger - > set_scene_tree ( sml ) ;
}
//autoload
List < PropertyInfo > props ;
ProjectSettings : : get_singleton ( ) - > get_property_list ( & props ) ;
//first pass, add the constants so they exist before any script is loaded
for ( List < PropertyInfo > : : Element * E = props . front ( ) ; E ; E = E - > next ( ) ) {
String s = E - > get ( ) . name ;
if ( ! s . begins_with ( " autoload/ " ) ) {
continue ;
}
String name = s . get_slicec ( ' / ' , 1 ) ;
String path = ProjectSettings : : get_singleton ( ) - > get ( s ) ;
bool global_var = false ;
if ( path . begins_with ( " * " ) ) {
global_var = true ;
}
if ( global_var ) {
for ( int i = 0 ; i < ScriptServer : : get_language_count ( ) ; i + + ) {
ScriptServer : : get_language ( i ) - > add_global_constant ( name , Variant ( ) ) ;
}
}
}
//second pass, load into global constants
List < Node * > to_add ;
for ( List < PropertyInfo > : : Element * E = props . front ( ) ; E ; E = E - > next ( ) ) {
String s = E - > get ( ) . name ;
if ( ! s . begins_with ( " autoload/ " ) ) {
continue ;
}
String name = s . get_slicec ( ' / ' , 1 ) ;
String path = ProjectSettings : : get_singleton ( ) - > get ( s ) ;
bool global_var = false ;
if ( path . begins_with ( " * " ) ) {
global_var = true ;
path = path . substr ( 1 , path . length ( ) - 1 ) ;
}
RES res = ResourceLoader : : load ( path ) ;
ERR_CONTINUE_MSG ( res . is_null ( ) , " Can't autoload: " + path ) ;
Node * n = nullptr ;
if ( res - > is_class ( " PackedScene " ) ) {
Ref < PackedScene > ps = res ;
n = ps - > instance ( ) ;
} else if ( res - > is_class ( " Script " ) ) {
Ref < Script > script_res = res ;
StringName ibt = script_res - > get_instance_base_type ( ) ;
bool valid_type = ClassDB : : is_parent_class ( ibt , " Node " ) ;
2022-04-04 19:55:41 +02:00
ERR_CONTINUE_MSG ( ! valid_type , " Script does not inherit from Node: " + path ) ;
2022-03-15 13:29:32 +01:00
Object * obj = ClassDB : : instance ( ibt ) ;
ERR_CONTINUE_MSG ( obj = = nullptr , " Cannot instance script for autoload, expected 'Node' inheritance, got: " + String ( ibt ) ) ;
n = Object : : cast_to < Node > ( obj ) ;
n - > set_script ( script_res . get_ref_ptr ( ) ) ;
}
ERR_CONTINUE_MSG ( ! n , " Path in autoload not a node or script: " + path ) ;
n - > set_name ( name ) ;
//defer so references are all valid on _ready()
to_add . push_back ( n ) ;
if ( global_var ) {
for ( int i = 0 ; i < ScriptServer : : get_language_count ( ) ; i + + ) {
ScriptServer : : get_language ( i ) - > add_global_constant ( name , n ) ;
}
}
}
for ( List < Node * > : : Element * E = to_add . front ( ) ; E ; E = E - > next ( ) ) {
sml - > get_root ( ) - > add_child ( E - > get ( ) ) ;
}
}
}
# ifdef TOOLS_ENABLED
EditorNode * editor_node = nullptr ;
if ( editor ) {
editor_node = memnew ( EditorNode ) ;
sml - > get_root ( ) - > add_child ( editor_node ) ;
if ( _export_preset ! = " " ) {
editor_node - > export_preset ( _export_preset , positional_arg , export_debug , export_pack_only ) ;
game_path = " " ; // Do not load anything.
}
}
# endif
if ( ! editor & & ! project_manager ) {
//standard helpers that can be changed from main config
String stretch_mode = GLOBAL_DEF ( " display/window/stretch/mode " , " disabled " ) ;
String stretch_aspect = GLOBAL_DEF ( " display/window/stretch/aspect " , " ignore " ) ;
Size2i stretch_size = Size2 ( GLOBAL_DEF ( " display/window/size/width " , 0 ) , GLOBAL_DEF ( " display/window/size/height " , 0 ) ) ;
// out of compatibility reasons stretch_scale is called shrink when exposed to the user.
real_t stretch_scale = GLOBAL_DEF ( " display/window/stretch/shrink " , 1.0 ) ;
SceneTree : : StretchMode sml_sm = SceneTree : : STRETCH_MODE_DISABLED ;
if ( stretch_mode = = " 2d " ) {
sml_sm = SceneTree : : STRETCH_MODE_2D ;
} else if ( stretch_mode = = " viewport " ) {
sml_sm = SceneTree : : STRETCH_MODE_VIEWPORT ;
}
SceneTree : : StretchAspect sml_aspect = SceneTree : : STRETCH_ASPECT_IGNORE ;
if ( stretch_aspect = = " keep " ) {
sml_aspect = SceneTree : : STRETCH_ASPECT_KEEP ;
} else if ( stretch_aspect = = " keep_width " ) {
sml_aspect = SceneTree : : STRETCH_ASPECT_KEEP_WIDTH ;
} else if ( stretch_aspect = = " keep_height " ) {
sml_aspect = SceneTree : : STRETCH_ASPECT_KEEP_HEIGHT ;
} else if ( stretch_aspect = = " expand " ) {
sml_aspect = SceneTree : : STRETCH_ASPECT_EXPAND ;
}
sml - > set_screen_stretch ( sml_sm , sml_aspect , stretch_size , stretch_scale ) ;
sml - > set_auto_accept_quit ( GLOBAL_DEF ( " application/config/auto_accept_quit " , true ) ) ;
sml - > set_quit_on_go_back ( GLOBAL_DEF ( " application/config/quit_on_go_back " , true ) ) ;
String appname = ProjectSettings : : get_singleton ( ) - > get ( " application/config/name " ) ;
appname = TranslationServer : : get_singleton ( ) - > translate ( appname ) ;
# ifdef DEBUG_ENABLED
// Append a suffix to the window title to denote that the project is running
// from a debug build (including the editor). Since this results in lower performance,
// this should be clearly presented to the user.
OS : : get_singleton ( ) - > set_window_title ( vformat ( " %s (DEBUG) " , appname ) ) ;
# else
OS : : get_singleton ( ) - > set_window_title ( appname ) ;
# endif
// Define a very small minimum window size to prevent bugs such as GH-37242.
// It can still be overridden by the user in a script.
OS : : get_singleton ( ) - > set_min_window_size ( Size2 ( 64 , 64 ) ) ;
int shadow_atlas_size = GLOBAL_GET ( " rendering/quality/shadow_atlas/size " ) ;
int shadow_atlas_q0_subdiv = GLOBAL_GET ( " rendering/quality/shadow_atlas/quadrant_0_subdiv " ) ;
int shadow_atlas_q1_subdiv = GLOBAL_GET ( " rendering/quality/shadow_atlas/quadrant_1_subdiv " ) ;
int shadow_atlas_q2_subdiv = GLOBAL_GET ( " rendering/quality/shadow_atlas/quadrant_2_subdiv " ) ;
int shadow_atlas_q3_subdiv = GLOBAL_GET ( " rendering/quality/shadow_atlas/quadrant_3_subdiv " ) ;
sml - > get_root ( ) - > set_shadow_atlas_size ( shadow_atlas_size ) ;
sml - > get_root ( ) - > set_shadow_atlas_quadrant_subdiv ( 0 , Viewport : : ShadowAtlasQuadrantSubdiv ( shadow_atlas_q0_subdiv ) ) ;
sml - > get_root ( ) - > set_shadow_atlas_quadrant_subdiv ( 1 , Viewport : : ShadowAtlasQuadrantSubdiv ( shadow_atlas_q1_subdiv ) ) ;
sml - > get_root ( ) - > set_shadow_atlas_quadrant_subdiv ( 2 , Viewport : : ShadowAtlasQuadrantSubdiv ( shadow_atlas_q2_subdiv ) ) ;
sml - > get_root ( ) - > set_shadow_atlas_quadrant_subdiv ( 3 , Viewport : : ShadowAtlasQuadrantSubdiv ( shadow_atlas_q3_subdiv ) ) ;
Viewport : : Usage usage = Viewport : : Usage ( int ( GLOBAL_GET ( " rendering/quality/intended_usage/framebuffer_allocation " ) ) ) ;
sml - > get_root ( ) - > set_usage ( usage ) ;
bool snap_controls = GLOBAL_DEF ( " gui/common/snap_controls_to_pixels " , true ) ;
sml - > get_root ( ) - > set_snap_controls_to_pixels ( snap_controls ) ;
bool font_oversampling = GLOBAL_DEF ( " rendering/quality/dynamic_fonts/use_oversampling " , true ) ;
sml - > set_use_font_oversampling ( font_oversampling ) ;
} else {
GLOBAL_DEF ( " display/window/stretch/mode " , " disabled " ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " display/window/stretch/mode " , PropertyInfo ( Variant : : STRING , " display/window/stretch/mode " , PROPERTY_HINT_ENUM , " disabled,2d,viewport " ) ) ;
GLOBAL_DEF ( " display/window/stretch/aspect " , " ignore " ) ;
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 " ) ) ;
GLOBAL_DEF ( " display/window/stretch/shrink " , 1.0 ) ;
ProjectSettings : : get_singleton ( ) - > set_custom_property_info ( " display/window/stretch/shrink " , PropertyInfo ( Variant : : REAL , " display/window/stretch/shrink " , PROPERTY_HINT_RANGE , " 0.1,8,0.01,or_greater " ) ) ;
sml - > set_auto_accept_quit ( GLOBAL_DEF ( " application/config/auto_accept_quit " , true ) ) ;
sml - > set_quit_on_go_back ( GLOBAL_DEF ( " application/config/quit_on_go_back " , true ) ) ;
GLOBAL_DEF ( " gui/common/snap_controls_to_pixels " , true ) ;
GLOBAL_DEF ( " rendering/quality/dynamic_fonts/use_oversampling " , true ) ;
}
String local_game_path ;
if ( game_path ! = " " & & ! project_manager ) {
local_game_path = game_path . replace ( " \\ " , " / " ) ;
if ( ! local_game_path . begins_with ( " res:// " ) ) {
bool absolute = ( local_game_path . size ( ) > 1 ) & & ( local_game_path [ 0 ] = = ' / ' | | local_game_path [ 1 ] = = ' : ' ) ;
if ( ! absolute ) {
if ( ProjectSettings : : get_singleton ( ) - > is_using_datapack ( ) ) {
local_game_path = " res:// " + local_game_path ;
} else {
int sep = local_game_path . rfind ( " / " ) ;
if ( sep = = - 1 ) {
DirAccess * da = DirAccess : : create ( DirAccess : : ACCESS_FILESYSTEM ) ;
local_game_path = da - > get_current_dir ( ) . plus_file ( local_game_path ) ;
memdelete ( da ) ;
} else {
DirAccess * da = DirAccess : : open ( local_game_path . substr ( 0 , sep ) ) ;
if ( da ) {
local_game_path = da - > get_current_dir ( ) . plus_file ( local_game_path . substr ( sep + 1 , local_game_path . length ( ) ) ) ;
memdelete ( da ) ;
}
}
}
}
}
local_game_path = ProjectSettings : : get_singleton ( ) - > localize_path ( local_game_path ) ;
# ifdef TOOLS_ENABLED
if ( editor ) {
if ( game_path ! = GLOBAL_GET ( " application/run/main_scene " ) | | ! editor_node - > has_scenes_in_session ( ) ) {
Error serr = editor_node - > load_scene ( local_game_path ) ;
if ( serr ! = OK )
ERR_PRINT ( " Failed to load scene " ) ;
}
2023-02-17 23:20:10 +01:00
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > set_context ( OS : : CONTEXT_EDITOR ) ;
2023-02-17 23:20:10 +01:00
2023-02-18 15:31:58 +01:00
# ifdef MODULE_EDITOR_CODE_EDITOR_ENABLED
2022-07-27 15:07:09 +02:00
// Start debug server.
if ( ! debug_server_uri . empty ( ) ) {
int idx = debug_server_uri . rfind ( " : " ) ;
IP_Address addr = debug_server_uri . substr ( 0 , idx ) ;
int port = debug_server_uri . substr ( idx + 1 ) . to_int ( ) ;
2023-02-18 16:52:26 +01:00
EditorScriptEditor : : get_singleton ( ) - > get_debugger ( ) - > start ( port , addr ) ;
2022-07-27 15:07:09 +02:00
}
2023-02-17 23:20:10 +01:00
# endif
2022-03-15 13:29:32 +01:00
}
# endif
if ( ! editor ) {
OS : : get_singleton ( ) - > set_context ( OS : : CONTEXT_ENGINE ) ;
}
}
if ( ! project_manager & & ! editor ) { // game
// Load SSL Certificates from Project Settings (or builtin).
Crypto : : load_default_certificates ( GLOBAL_DEF ( " network/ssl/certificates " , " " ) ) ;
if ( game_path ! = " " ) {
Node * scene = nullptr ;
Ref < PackedScene > scenedata = ResourceLoader : : load ( local_game_path ) ;
if ( scenedata . is_valid ( ) ) {
scene = scenedata - > instance ( ) ;
}
ERR_FAIL_COND_V_MSG ( ! scene , false , " Failed loading scene: " + local_game_path ) ;
sml - > add_current_scene ( scene ) ;
# ifdef OSX_ENABLED
String mac_iconpath = GLOBAL_DEF ( " application/config/macos_native_icon " , " Variant() " ) ;
if ( mac_iconpath ! = " " ) {
OS : : get_singleton ( ) - > set_native_icon ( mac_iconpath ) ;
hasicon = true ;
}
# endif
# ifdef WINDOWS_ENABLED
String win_iconpath = GLOBAL_DEF ( " application/config/windows_native_icon " , " Variant() " ) ;
if ( win_iconpath ! = " " ) {
OS : : get_singleton ( ) - > set_native_icon ( win_iconpath ) ;
hasicon = true ;
}
# endif
String iconpath = GLOBAL_DEF ( " application/config/icon " , " Variant() " ) ;
if ( ( iconpath ! = " " ) & & ( ! hasicon ) ) {
Ref < Image > icon ;
icon . instance ( ) ;
if ( ImageLoader : : load_image ( iconpath , icon ) = = OK ) {
OS : : get_singleton ( ) - > set_icon ( icon ) ;
hasicon = true ;
}
}
}
}
# ifdef TOOLS_ENABLED
if ( project_manager | | ( script = = " " & & test = = " " & & game_path = = " " & & ! editor ) ) {
Engine : : get_singleton ( ) - > set_editor_hint ( true ) ;
ProjectManager * pmanager = memnew ( ProjectManager ) ;
ProgressDialog * progress_dialog = memnew ( ProgressDialog ) ;
pmanager - > add_child ( progress_dialog ) ;
sml - > get_root ( ) - > add_child ( pmanager ) ;
OS : : get_singleton ( ) - > set_context ( OS : : CONTEXT_PROJECTMAN ) ;
project_manager = true ;
}
if ( project_manager | | editor ) {
// Load SSL Certificates from Editor Settings (or builtin)
Crypto : : load_default_certificates ( EditorSettings : : get_singleton ( ) - > get_setting ( " network/ssl/editor_ssl_certificates " ) . operator String ( ) ) ;
}
# endif
}
if ( ! hasicon & & OS : : get_singleton ( ) - > get_bundle_icon_path ( ) . empty ( ) ) {
Ref < Image > icon = memnew ( Image ( app_icon_png ) ) ;
OS : : get_singleton ( ) - > set_icon ( icon ) ;
}
OS : : get_singleton ( ) - > set_main_loop ( main_loop ) ;
2022-06-28 17:13:00 +02:00
if ( minimum_time_msec ) {
uint64_t minimum_time = 1000 * minimum_time_msec ;
uint64_t elapsed_time = OS : : get_singleton ( ) - > get_ticks_usec ( ) ;
if ( elapsed_time < minimum_time ) {
OS : : get_singleton ( ) - > delay_usec ( minimum_time - elapsed_time ) ;
}
}
2023-05-01 15:32:01 +02:00
OS : : get_singleton ( ) - > benchmark_end_measure ( " startup_begin " ) ;
OS : : get_singleton ( ) - > benchmark_dump ( ) ;
2022-03-15 13:29:32 +01:00
return true ;
}
/* Main iteration
*
* This is the iteration of the engine ' s game loop , advancing the state of physics ,
* rendering and audio .
* It ' s called directly by the platform ' s OS : : run method , where the loop is created
* and monitored .
*
* The OS implementation can impact its draw step with the Main : : force_redraw ( ) method .
*/
uint64_t Main : : last_ticks = 0 ;
uint32_t Main : : frames = 0 ;
2022-04-12 00:23:22 +02:00
uint32_t Main : : hide_print_fps_attempts = 3 ;
2022-03-15 13:29:32 +01:00
uint32_t Main : : frame = 0 ;
bool Main : : force_redraw_requested = false ;
int Main : : iterating = 0 ;
bool Main : : agile_input_event_flushing = false ;
bool Main : : is_iterating ( ) {
return iterating > 0 ;
}
// For performance metrics.
static uint64_t physics_process_max = 0 ;
static uint64_t idle_process_max = 0 ;
2023-09-03 10:50:35 +02:00
static uint64_t navigation_process_max = 0 ;
2022-03-15 13:29:32 +01:00
# ifndef TOOLS_ENABLED
static uint64_t frame_delta_sync_time = 0 ;
# endif
bool Main : : iteration ( ) {
//for now do not error on this
//ERR_FAIL_COND_V(iterating, false);
iterating + + ;
// ticks may become modified later on, and we want to store the raw measured
// value for profiling.
uint64_t raw_ticks_at_start = OS : : get_singleton ( ) - > get_ticks_usec ( ) ;
# ifdef TOOLS_ENABLED
uint64_t ticks = raw_ticks_at_start ;
# else
// we can either sync the delta from here, or later in the iteration
uint64_t ticks_difference = raw_ticks_at_start - frame_delta_sync_time ;
// if we are syncing at start or if frame_delta_sync_time is being initialized
// or a large gap has happened between the last delta_sync_time and now
if ( ! delta_sync_after_draw | | ( ticks_difference > 100000 ) ) {
frame_delta_sync_time = raw_ticks_at_start ;
}
uint64_t ticks = frame_delta_sync_time ;
# endif
Engine : : get_singleton ( ) - > _frame_ticks = ticks ;
main_timer_sync . set_cpu_ticks_usec ( ticks ) ;
main_timer_sync . set_fixed_fps ( fixed_fps ) ;
uint64_t ticks_elapsed = ticks - last_ticks ;
2022-03-24 11:10:56 +01:00
int physics_ticks_per_second = Engine : : get_singleton ( ) - > get_physics_ticks_per_second ( ) ;
float frame_slice = 1.0 / physics_ticks_per_second ;
2022-03-15 13:29:32 +01:00
float time_scale = Engine : : get_singleton ( ) - > get_time_scale ( ) ;
2022-03-24 11:10:56 +01:00
MainFrameTime advance = main_timer_sync . advance ( frame_slice , physics_ticks_per_second ) ;
2022-03-15 13:29:32 +01:00
double step = advance . idle_step ;
double scaled_step = step * time_scale ;
Engine : : get_singleton ( ) - > _frame_step = step ;
Engine : : get_singleton ( ) - > _physics_interpolation_fraction = advance . interpolation_fraction ;
uint64_t physics_process_ticks = 0 ;
uint64_t idle_process_ticks = 0 ;
2023-09-03 10:50:35 +02:00
uint64_t navigation_process_ticks = 0 ;
2022-03-15 13:29:32 +01:00
frame + = ticks_elapsed ;
last_ticks = ticks ;
static const int max_physics_steps = 8 ;
if ( fixed_fps = = - 1 & & advance . physics_steps > max_physics_steps ) {
step - = ( advance . physics_steps - max_physics_steps ) * frame_slice ;
advance . physics_steps = max_physics_steps ;
}
bool exit = false ;
for ( int iters = 0 ; iters < advance . physics_steps ; + + iters ) {
if ( InputDefault : : get_singleton ( ) - > is_using_input_buffering ( ) & & agile_input_event_flushing ) {
InputDefault : : get_singleton ( ) - > flush_buffered_events ( ) ;
}
Engine : : get_singleton ( ) - > _in_physics = true ;
uint64_t physics_begin = OS : : get_singleton ( ) - > get_ticks_usec ( ) ;
PhysicsServer : : get_singleton ( ) - > flush_queries ( ) ;
2023-08-27 18:48:25 +02:00
// Prepare the fixed timestep interpolated nodes
// BEFORE they are updated by the physics 2D,
// otherwise the current and previous transforms
// may be the same, and no interpolation takes place.
OS : : get_singleton ( ) - > get_main_loop ( ) - > iteration_prepare ( ) ;
2022-03-15 13:29:32 +01:00
Physics2DServer : : get_singleton ( ) - > sync ( ) ;
Physics2DServer : : get_singleton ( ) - > flush_queries ( ) ;
if ( OS : : get_singleton ( ) - > get_main_loop ( ) - > iteration ( frame_slice * time_scale ) ) {
exit = true ;
Engine : : get_singleton ( ) - > _in_physics = false ;
break ;
}
2023-09-03 10:50:35 +02:00
uint64_t navigation_begin = OS : : get_singleton ( ) - > get_ticks_usec ( ) ;
2023-06-09 22:03:42 +02:00
NavigationServer : : get_singleton ( ) - > process ( frame_slice * time_scale ) ;
2023-09-03 10:50:35 +02:00
navigation_process_ticks = MAX ( navigation_process_ticks , OS : : get_singleton ( ) - > get_ticks_usec ( ) - navigation_begin ) ; // keep the largest one for reference
navigation_process_max = MAX ( OS : : get_singleton ( ) - > get_ticks_usec ( ) - navigation_begin , navigation_process_max ) ;
2022-03-15 13:29:32 +01:00
message_queue - > flush ( ) ;
PhysicsServer : : get_singleton ( ) - > step ( frame_slice * time_scale ) ;
Physics2DServer : : get_singleton ( ) - > end_sync ( ) ;
Physics2DServer : : get_singleton ( ) - > step ( frame_slice * time_scale ) ;
message_queue - > flush ( ) ;
2022-05-04 20:56:06 +02:00
OS : : get_singleton ( ) - > get_main_loop ( ) - > iteration_end ( ) ;
2022-03-15 13:29:32 +01:00
physics_process_ticks = MAX ( physics_process_ticks , OS : : get_singleton ( ) - > get_ticks_usec ( ) - physics_begin ) ; // keep the largest one for reference
physics_process_max = MAX ( OS : : get_singleton ( ) - > get_ticks_usec ( ) - physics_begin , physics_process_max ) ;
Engine : : get_singleton ( ) - > _physics_frames + + ;
Engine : : get_singleton ( ) - > _in_physics = false ;
}
if ( InputDefault : : get_singleton ( ) - > is_using_input_buffering ( ) & & agile_input_event_flushing ) {
InputDefault : : get_singleton ( ) - > flush_buffered_events ( ) ;
}
uint64_t idle_begin = OS : : get_singleton ( ) - > get_ticks_usec ( ) ;
if ( OS : : get_singleton ( ) - > get_main_loop ( ) - > idle ( step * time_scale ) ) {
exit = true ;
}
2022-08-19 21:24:36 +02:00
rendering_server_callbacks - > flush ( ) ;
2022-03-15 13:29:32 +01:00
message_queue - > flush ( ) ;
2023-06-03 20:00:42 +02:00
NavigationMeshGenerator : : get_singleton ( ) - > process ( ) ;
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > sync ( ) ; //sync if still drawing from previous frames.
2022-03-15 13:29:32 +01:00
2022-08-19 20:50:20 +02:00
if ( OS : : get_singleton ( ) - > can_draw ( ) & & RenderingServer : : get_singleton ( ) - > is_render_loop_enabled ( ) ) {
2022-03-15 13:29:32 +01:00
if ( ( ! force_redraw_requested ) & & OS : : get_singleton ( ) - > is_in_low_processor_usage_mode ( ) ) {
// We can choose whether to redraw as a result of any redraw request, or redraw only for vital requests.
2022-08-19 20:50:20 +02:00
RenderingServer : : ChangedPriority priority = ( OS : : get_singleton ( ) - > is_update_pending ( ) ? RenderingServer : : CHANGED_PRIORITY_ANY : RenderingServer : : CHANGED_PRIORITY_HIGH ) ;
2022-03-15 13:29:32 +01:00
// Determine whether the scene has changed, to know whether to draw.
// If it has changed, inform the update pending system so it can keep
// particle systems etc updating when running in vital updates only mode.
2022-08-19 20:50:20 +02:00
bool has_changed = RenderingServer : : get_singleton ( ) - > has_changed ( priority ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > set_update_pending ( has_changed ) ;
if ( has_changed ) {
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > draw ( true , scaled_step ) ; // flush visual commands
2022-03-15 13:29:32 +01:00
Engine : : get_singleton ( ) - > frames_drawn + + ;
}
} else {
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > draw ( true , scaled_step ) ; // flush visual commands
2022-03-15 13:29:32 +01:00
Engine : : get_singleton ( ) - > frames_drawn + + ;
force_redraw_requested = false ;
}
}
# ifndef TOOLS_ENABLED
// we can choose to sync delta from here, just after the draw
if ( delta_sync_after_draw ) {
frame_delta_sync_time = OS : : get_singleton ( ) - > get_ticks_usec ( ) ;
}
# endif
// profiler timing information
idle_process_ticks = OS : : get_singleton ( ) - > get_ticks_usec ( ) - idle_begin ;
idle_process_max = MAX ( idle_process_ticks , idle_process_max ) ;
uint64_t frame_time = OS : : get_singleton ( ) - > get_ticks_usec ( ) - raw_ticks_at_start ;
for ( int i = 0 ; i < ScriptServer : : get_language_count ( ) ; i + + ) {
ScriptServer : : get_language ( i ) - > frame ( ) ;
}
AudioServer : : get_singleton ( ) - > update ( ) ;
if ( script_debugger ) {
if ( script_debugger - > is_profiling ( ) ) {
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 ) ;
}
script_debugger - > idle_poll ( ) ;
}
frames + + ;
Engine : : get_singleton ( ) - > _idle_frames + + ;
if ( frame > 1000000 ) {
2022-04-12 00:23:22 +02:00
// Wait a few seconds before printing FPS, as FPS reporting just after the engine has started is inaccurate.
if ( hide_print_fps_attempts = = 0 ) {
if ( editor | | project_manager ) {
if ( print_fps ) {
print_line ( vformat ( " Editor FPS: %d (%s mspf) " , frames , rtos ( 1000.0 / frames ) . pad_decimals ( 2 ) ) ) ;
}
} else if ( print_fps | | GLOBAL_GET ( " debug/settings/stdout/print_fps " ) ) {
print_line ( vformat ( " Project FPS: %d (%s mspf) " , frames , rtos ( 1000.0 / frames ) . pad_decimals ( 2 ) ) ) ;
2022-03-15 13:29:32 +01:00
}
2022-04-12 00:23:22 +02:00
} else {
hide_print_fps_attempts - - ;
2022-03-15 13:29:32 +01:00
}
Engine : : get_singleton ( ) - > _fps = frames ;
performance - > set_process_time ( USEC_TO_SEC ( idle_process_max ) ) ;
performance - > set_physics_process_time ( USEC_TO_SEC ( physics_process_max ) ) ;
2023-09-03 10:50:35 +02:00
performance - > set_navigation_process_time ( USEC_TO_SEC ( navigation_process_max ) ) ;
2022-03-15 13:29:32 +01:00
idle_process_max = 0 ;
physics_process_max = 0 ;
2023-09-03 10:50:35 +02:00
navigation_process_max = 0 ;
2022-03-15 13:29:32 +01:00
frame % = 1000000 ;
frames = 0 ;
}
iterating - - ;
// Needed for OSs using input buffering regardless accumulation (like Android)
if ( InputDefault : : get_singleton ( ) - > is_using_input_buffering ( ) & & ! agile_input_event_flushing ) {
InputDefault : : get_singleton ( ) - > flush_buffered_events ( ) ;
}
if ( fixed_fps ! = - 1 ) {
return exit ;
}
OS : : get_singleton ( ) - > add_frame_delay ( OS : : get_singleton ( ) - > can_draw ( ) ) ;
return exit | | auto_quit ;
}
void Main : : force_redraw ( ) {
force_redraw_requested = true ;
}
/* Engine deinitialization
*
* Responsible for freeing all the memory allocated by previous setup steps ,
* so that the engine closes cleanly without leaking memory or crashing .
* The order matters as some of those steps are linked with each other .
*/
void Main : : cleanup ( bool p_force ) {
2023-05-01 15:32:01 +02:00
OS : : get_singleton ( ) - > benchmark_begin_measure ( " Main::cleanup " ) ;
2022-03-15 13:29:32 +01:00
if ( ! p_force ) {
ERR_FAIL_COND ( ! _start_success ) ;
}
# ifdef RID_HANDLES_ENABLED
g_rid_database . preshutdown ( ) ;
# endif
if ( script_debugger ) {
// Flush any remaining messages
script_debugger - > idle_poll ( ) ;
}
ResourceLoader : : remove_custom_loaders ( ) ;
ResourceSaver : : remove_custom_savers ( ) ;
// Flush before uninitializing the scene, but delete the MessageQueue as late as possible.
message_queue - > flush ( ) ;
if ( script_debugger ) {
if ( use_debug_profiler ) {
script_debugger - > profiling_end ( ) ;
}
memdelete ( script_debugger ) ;
}
OS : : get_singleton ( ) - > delete_main_loop ( ) ;
2022-11-30 18:12:43 +01:00
// Storing it for use when restarting as it's being cleared right below.
const String execpath = OS : : get_singleton ( ) - > get_executable_path ( ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > _cmdline . clear ( ) ;
OS : : get_singleton ( ) - > _execpath = " " ;
OS : : get_singleton ( ) - > _local_clipboard = " " ;
ResourceLoader : : clear_translation_remaps ( ) ;
ResourceLoader : : clear_path_remaps ( ) ;
ScriptServer : : finish_languages ( ) ;
// Sync pending commands that may have been queued from a different thread during ScriptServer finalization
2022-08-19 20:50:20 +02:00
RenderingServer : : get_singleton ( ) - > sync ( ) ;
2022-03-15 13:29:32 +01:00
# ifdef TOOLS_ENABLED
EditorNode : : unregister_editor_types ( ) ;
# endif
ImageLoader : : cleanup ( ) ;
unregister_driver_types ( ) ;
2023-01-15 17:04:00 +01:00
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_START ) ;
//unregister_module_types(ModuleRegistrationLevel::MODULE_REGISTRATION_LEVEL_TEST);
2023-01-15 17:09:46 +01:00
if ( Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_EDITOR ) ;
}
2023-01-15 17:04:00 +01:00
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_SCENE ) ;
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_SERVER ) ;
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_PLATFORM ) ;
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_DRIVER ) ;
2023-01-15 11:46:13 +01:00
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_CORE ) ;
2023-01-15 17:04:00 +01:00
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_SINGLETON ) ;
unregister_module_types ( ModuleRegistrationLevel : : MODULE_REGISTRATION_LEVEL_FINALIZE ) ;
2022-03-15 13:29:32 +01:00
unregister_platform_apis ( ) ;
unregister_scene_types ( ) ;
unregister_server_types ( ) ;
if ( audio_server ) {
audio_server - > finish ( ) ;
memdelete ( audio_server ) ;
}
2022-12-20 11:16:47 +01:00
finalize_navigation_server ( ) ;
2023-06-03 20:00:42 +02:00
finalize_navigation_mesh_generator ( ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > finalize ( ) ;
finalize_physics ( ) ;
if ( packed_data ) {
memdelete ( packed_data ) ;
}
if ( file_access_network_client ) {
memdelete ( file_access_network_client ) ;
}
if ( performance ) {
memdelete ( performance ) ;
}
if ( input_map ) {
memdelete ( input_map ) ;
}
if ( time_singleton ) {
memdelete ( time_singleton ) ;
}
if ( translation_server ) {
memdelete ( translation_server ) ;
}
2023-06-03 20:00:42 +02:00
if ( navigation_mesh_generator_manager ) {
memdelete ( navigation_mesh_generator_manager ) ;
}
2022-03-15 13:29:32 +01:00
if ( globals ) {
memdelete ( globals ) ;
}
if ( engine ) {
memdelete ( engine ) ;
}
if ( OS : : get_singleton ( ) - > is_restart_on_exit_set ( ) ) {
//attempt to restart with arguments
List < String > args = OS : : get_singleton ( ) - > get_restart_on_exit_arguments ( ) ;
OS : : ProcessID pid = 0 ;
2022-11-30 18:12:43 +01:00
OS : : get_singleton ( ) - > execute ( execpath , args , false , & pid ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > set_restart_on_exit ( false , List < String > ( ) ) ; //clear list (uses memory)
}
// Now should be safe to delete MessageQueue (famous last words).
message_queue - > flush ( ) ;
memdelete ( message_queue ) ;
2022-08-19 21:24:36 +02:00
if ( rendering_server_callbacks ) {
memdelete ( rendering_server_callbacks ) ;
2022-03-15 13:29:32 +01:00
}
unregister_core_driver_types ( ) ;
unregister_core_types ( ) ;
2023-05-01 15:32:01 +02:00
OS : : get_singleton ( ) - > benchmark_end_measure ( " Main::cleanup " ) ;
OS : : get_singleton ( ) - > benchmark_dump ( ) ;
2022-03-15 13:29:32 +01:00
OS : : get_singleton ( ) - > finalize_core ( ) ;
# ifdef RID_HANDLES_ENABLED
g_rid_database . shutdown ( ) ;
# endif
}