godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/main/main.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

3367 lines
122 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* main.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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. */
/**************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "main.h"
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/config/project_settings.h"
Variant memory pools Memory pools via PagedAllocator for Transform2D, Transform3D, Basis and AABB.
2022-05-20 12:28:44 +00:00
#include "core/core_globals.h"
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
#include "core/core_string_names.h"
Rewrite StreamPeerSSL with SSLContext helper class connect_to_stream now accepts optional parameter to specify which certificates to trust. Implement accept_stream (SSL server) with key/cert parameters to specify the RSA key and X509 certificate resources.
2019-07-19 13:29:57 +00:00
#include "core/crypto/crypto.h"
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
#include "core/debugger/engine_debugger.h"
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
#include "core/extension/extension_api_dump.h"
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
#include "core/extension/gdextension_interface_dump.gen.h"
#include "core/extension/gdextension_manager.h"
Rename InputFilter back to Input It changed name as part of the DisplayServer and input refactoring in #37317, with the rationale that input no longer goes through the main loop, so the previous Input singleton now only does filtering. But the gains in consistency are quite limited in the renaming, and it breaks compatibility for all scripts and tutorials that access the Input singleton via the scripting language. A temporary option was suggested to keep the scripting singleton named `Input` even if its type is `InputFilter`, but that adds inconsistency and breaks C#. Fixes godotengine/godot-proposals#639. Fixes #37319. Fixes #37690.
2020-04-28 13:19:37 +00:00
#include "core/input/input.h"
Refactored Input, create DisplayServer and DisplayServerX11
2020-03-01 22:14:37 +00:00
#include "core/input/input_map.h"
Core: Move DirAccess and FileAccess to `core/io` File handling APIs are typically considered part of I/O, and we did have most `FileAccess` implementations in `core/io` already.
2021-06-11 12:51:48 +00:00
#include "core/io/dir_access.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/io/file_access_network.h"
#include "core/io/file_access_pack.h"
#include "core/io/file_access_zip.h"
Main: Use ImageLoader directly instead of Image::load Image::load is now issuing warnings (since ef50957) to prevent users from using it to load images at runtime which would be included in their exported game. So we now use ImageLoader explicitly instead for the custom-handled cases in Main. Fixes #21072, supersedes #22321.
2018-09-30 15:21:07 +00:00
#include "core/io/image_loader.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/io/ip.h"
#include "core/io/resource_loader.h"
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/object/message_queue.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/os/os.h"
Add Time singleton
2021-05-24 11:54:05 +00:00
#include "core/os/time.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "core/register_core_types.h"
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/string/translation.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/version.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "drivers/register_driver_types.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "main/app_icon.gen.h"
Drivers, main, servers: Ensure classes match their header filename Renamed: - `drivers/alsamidi/alsa_midi.h` -> `midi_driver_alsamidi.h` (same for `coremidi` and `winmidi`) - `main/timer_sync.h` -> `main_timer_sync.h` - `servers/visual/visual_server_global.h` -> `visual_server_globals.h`
2019-02-12 13:23:35 +00:00
#include "main/main_timer_sync.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "main/performance.h"
#include "main/splash.gen.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "modules/register_module_types.h"
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton.
2017-11-16 00:33:48 +00:00
#include "platform/register_platform_apis.h"
-Fixed SCREEN_TEXTURE and other related 2D shader parameters. -Fixded BackBuffercopy object
2017-06-27 01:58:03 +00:00
#include "scene/main/scene_tree.h"
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
#include "scene/main/window.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "scene/register_scene_types.h"
#include "scene/resources/packed_scene.h"
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
#include "scene/theme/theme_db.h"
Oops! Audio engine has vanished :D
2017-01-15 19:06:14 +00:00
#include "servers/audio_server.h"
iOS modular build and export implementation.
2019-11-29 06:54:39 +00:00
#include "servers/camera_server.h"
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
#include "servers/display_server.h"
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
#include "servers/movie_writer/movie_writer.h"
#include "servers/movie_writer/movie_writer_mjpeg.h"
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
#include "servers/navigation_server_2d.h"
#include "servers/navigation_server_3d.h"
#include "servers/physics_server_2d.h"
#include "servers/physics_server_3d.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "servers/register_server_types.h"
Reorganize rendering server. -Made RenderingServerScene abstract, allowing reimplementation -RenderingServerRaster -> RenderingServerDefault, but this class is going away soon.
2020-12-03 21:09:47 +00:00
#include "servers/rendering/rendering_server_default.h"
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
#include "servers/text/text_server_dummy.h"
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
#include "servers/text_server.h"
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
#include "servers/xr_server.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
SCons: Add `tests` option to enable or disable unit tests
2020-07-25 13:59:30 +00:00
#ifdef TESTS_ENABLED
Move `tests` to the top-level directory
2020-07-25 21:06:07 +00:00
#include "tests/test_main.h"
SCons: Add `tests` option to enable or disable unit tests
2020-07-25 13:59:30 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
Use forward-declarations in EditorPlugin where possible
2022-11-11 19:12:48 +00:00
#include "editor/debugger/editor_debugger_node.h"
Move DocData and Collada out of their subfolders Now that the unused DocDump was removed, the `editor/doc` subfolder is redundant. Similarly, there's no reason for Collada to have a subfolder for itself when glTF or OBJ don't.
2020-03-24 08:54:49 +00:00
#include "editor/doc_data_class_path.gen.h"
Refactor DocData into core and editor (DocTools) parts
2020-11-29 03:42:06 +00:00
#include "editor/doc_tools.h"
Refactoring: rename tools/editor/ to editor/ The other subfolders of tools/ had already been moved to either editor/, misc/ or thirdparty/, so the hiding the editor code that deep was no longer meaningful.
2017-03-05 13:21:25 +00:00
#include "editor/editor_node.h"
Editor: Cleanup some includes dependencies Removes some unnecessary includes from `editor_node.h`, and instead add those where they're used. Removes unnecessary `editor_node.h` includes in various editor classes. Renames `dynamicfont` to `dynamic_font` in a couple files. Misc cleanup while jumping through that rabbit hole.
2022-02-14 13:00:03 +00:00
#include "editor/editor_paths.h"
Allow system certs file to be used by Editor. Note, it will only used by the Editor, not when running the game. This allows package maintainer to compile Godot to use system installed certificates when accessing the AssetLib.
2018-09-15 12:45:54 +00:00
#include "editor/editor_settings.h"
Make `--doctool` locale aware * Adds `indent(str)` to `String`: * Indent the (multiline) string with the given indentation. * This method is added in order to keep the translated XML correctly indented. * Moves the loading of tool/doc translation into `editor/editor_translation.{h,cpp}`. * This will be used from both `EditorSettings` and the doc tool from `main`. * Makes use of doc translation when generating XML class references, and setup the translation locale based on `-l LOCALE` CLI parameter. The XML class reference won't be translated if `-l LOCALE` parameter is not given, or when it's `-l en`.
2021-12-15 15:01:06 +00:00
#include "editor/editor_translation.h"
Cleans up headers included in editor_node.h
2019-12-24 07:17:23 +00:00
#include "editor/progress_dialog.h"
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
#include "editor/project_converter_3_to_4.h"
Refactoring: rename tools/editor/ to editor/ The other subfolders of tools/ had already been moved to either editor/, misc/ or thirdparty/, so the hiding the editor code that deep was no longer meaningful.
2017-03-05 13:21:25 +00:00
#include "editor/project_manager.h"
Move editor class and plugin registrations to a dedicated file
2022-05-01 09:57:36 +00:00
#include "editor/register_editor_types.h"
Remove editor splash screen with sponsors logo The Godot Project Leadership Committe has decided to update the sponsoring tiers so that the Platinum Sponsorship no longer includes a logo on the editor splash screen. This lets us reclaim the editor splash screen space for community-related content instead of sponsors (e.g. a different community-designed splash screen for each stable branch?). Also removes two Platinum Sponsors whose sponsorship has expired earlier this year.
2021-11-30 11:36:56 +00:00
#ifndef NO_EDITOR_SPLASH
#include "main/splash_editor.gen.h"
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Modules: Make sure to include modules_enabled.gen.h where needed
2021-11-12 12:42:58 +00:00
#include "modules/modules_enabled.gen.h" // For mono.
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
/* Static members */
// Singletons
// Initialized in setup()
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
static Engine *engine = nullptr;
static ProjectSettings *globals = nullptr;
Rename InputFilter back to Input It changed name as part of the DisplayServer and input refactoring in #37317, with the rationale that input no longer goes through the main loop, so the previous Input singleton now only does filtering. But the gains in consistency are quite limited in the renaming, and it breaks compatibility for all scripts and tutorials that access the Input singleton via the scripting language. A temporary option was suggested to keep the scripting singleton named `Input` even if its type is `InputFilter`, but that adds inconsistency and breaks C#. Fixes godotengine/godot-proposals#639. Fixes #37319. Fixes #37690.
2020-04-28 13:19:37 +00:00
static Input *input = nullptr;
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
static InputMap *input_map = nullptr;
static TranslationServer *translation_server = nullptr;
static Performance *performance = nullptr;
static PackedData *packed_data = nullptr;
Add Time singleton
2021-05-24 11:54:05 +00:00
static Time *time_singleton = nullptr;
-Changed Godot exit to be clean. -Added more debug information on memory cleanliness on exit (if run with -v) -Fixed several memory leaks, fixes #1731, fixes #755
2015-04-20 22:38:02 +00:00
#ifdef MINIZIP_ENABLED
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
static ZipArchive *zip_packed_data = nullptr;
-Changed Godot exit to be clean. -Added more debug information on memory cleanliness on exit (if run with -v) -Fixed several memory leaks, fixes #1731, fixes #755
2015-04-20 22:38:02 +00:00
#endif
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
static FileAccessNetworkClient *file_access_network_client = nullptr;
static MessageQueue *message_queue = nullptr;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
// Initialized in setup2()
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
static AudioServer *audio_server = nullptr;
static DisplayServer *display_server = nullptr;
static RenderingServer *rendering_server = nullptr;
static CameraServer *camera_server = nullptr;
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
static XRServer *xr_server = nullptr;
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
static TextServerManager *tsman = nullptr;
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
static PhysicsServer3DManager *physics_server_3d_manager = nullptr;
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
static PhysicsServer3D *physics_server_3d = nullptr;
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
static PhysicsServer2DManager *physics_server_2d_manager = nullptr;
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
static PhysicsServer2D *physics_server_2d = nullptr;
static NavigationServer3D *navigation_server_3d = nullptr;
static NavigationServer2D *navigation_server_2d = nullptr;
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
static ThemeDB *theme_db = nullptr;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
// We error out if setup2() doesn't turn this true
static bool _start_success = false;
// Drivers
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
String tablet_driver = "";
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
String text_driver = "";
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
String rendering_driver = "";
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
String rendering_method = "";
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
static int text_driver_idx = -1;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
static int display_driver_idx = -1;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static int audio_driver_idx = -1;
// Engine config/tools
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
static bool single_window = false;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static bool editor = false;
static bool project_manager = false;
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
static bool cmdline_tool = false;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static String locale;
static bool show_help = false;
static bool auto_quit = false;
Fix editor re-focus on debugger break on Windows
2022-07-21 19:41:02 +00:00
static OS::ProcessID editor_pid = 0;
Fix some more warnings reported by CI Fixes the following Clang 7 warnings: ``` core/io/marshalls.cpp:872:10: warning: unused variable 'f' [-Wunused-variable] core/ustring.cpp:1831:2: warning: 'register' storage class specifier is deprecated and incompatible with C++17 [-Wdeprecated-register] core/ustring.cpp:1832:2: warning: 'register' storage class specifier is deprecated and incompatible with C++17 [-Wdeprecated-register] drivers/gles3/rasterizer_gles3.cpp:82:24: warning: unused function '_gl_debug_print' [-Wunused-function,34] main/main.cpp:118:13: warning: unused variable 'auto_build_solutions' [-Wunused-variable] modules/csg/csg_gizmos.cpp:225:46: warning: 'current' may be used uninitialized in this function [-Wmaybe-uninitialized] ```
2018-10-03 12:05:17 +00:00
#ifdef TOOLS_ENABLED
Fix project manager not working in self-contained mode
2022-09-24 16:49:53 +00:00
static bool found_project = false;
Fix some more warnings reported by CI Fixes the following Clang 7 warnings: ``` core/io/marshalls.cpp:872:10: warning: unused variable 'f' [-Wunused-variable] core/ustring.cpp:1831:2: warning: 'register' storage class specifier is deprecated and incompatible with C++17 [-Wdeprecated-register] core/ustring.cpp:1832:2: warning: 'register' storage class specifier is deprecated and incompatible with C++17 [-Wdeprecated-register] drivers/gles3/rasterizer_gles3.cpp:82:24: warning: unused function '_gl_debug_print' [-Wunused-function,34] main/main.cpp:118:13: warning: unused variable 'auto_build_solutions' [-Wunused-variable] modules/csg/csg_gizmos.cpp:225:46: warning: 'current' may be used uninitialized in this function [-Wmaybe-uninitialized] ```
2018-10-03 12:05:17 +00:00
static bool auto_build_solutions = false;
[Editor] Add "--debug-server <uri>" option. Allow starting the editor debugger server for the given protocol (and optionally bound to the given ip/port combination: godot -e --debug-server tcp://*:8080
2021-08-28 23:58:15 +00:00
static String debug_server_uri;
Speedup conversion and add option to set maximum line length to prevent freezes
2022-08-13 20:17:35 +00:00
static int converter_max_kb_file = 4 * 1024; // 4MB
static int converter_max_line_length = 100000;
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
HashMap<Main::CLIScope, Vector<String>> forwardable_cli_arguments;
Fix some more warnings reported by CI Fixes the following Clang 7 warnings: ``` core/io/marshalls.cpp:872:10: warning: unused variable 'f' [-Wunused-variable] core/ustring.cpp:1831:2: warning: 'register' storage class specifier is deprecated and incompatible with C++17 [-Wdeprecated-register] core/ustring.cpp:1832:2: warning: 'register' storage class specifier is deprecated and incompatible with C++17 [-Wdeprecated-register] drivers/gles3/rasterizer_gles3.cpp:82:24: warning: unused function '_gl_debug_print' [-Wunused-function,34] main/main.cpp:118:13: warning: unused variable 'auto_build_solutions' [-Wunused-variable] modules/csg/csg_gizmos.cpp:225:46: warning: 'current' may be used uninitialized in this function [-Wmaybe-uninitialized] ```
2018-10-03 12:05:17 +00:00
#endif
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
bool use_startup_benchmark = false;
String startup_benchmark_file;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
// Display
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
static DisplayServer::WindowMode window_mode = DisplayServer::WINDOW_MODE_WINDOWED;
static DisplayServer::ScreenOrientation window_orientation = DisplayServer::SCREEN_LANDSCAPE;
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
static DisplayServer::VSyncMode window_vsync_mode = DisplayServer::VSYNC_ENABLED;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
static uint32_t window_flags = 0;
Increase the default project window size for better usability The new default window size is tuned to: - Have a 16:9 aspect ratio, - Have both dimensions divisible by 8 to better play along with video recording, - Be displayable correctly in windowed mode on a 1366×768 display (tested on Windows 10 with default settings). This breaks compatibility with projects that didn't change the window size from the default value (or that kept one of the values to its default).
2021-11-16 18:53:27 +00:00
static Size2i window_size = Size2i(1152, 648);
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
static int init_screen = DisplayServer::SCREEN_PRIMARY;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static bool init_fullscreen = false;
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
static bool init_maximized = false;
-added windowed mode with -w, fixes #3020 -changed default windowed resolution to 1280x720
2015-12-12 15:06:53 +00:00
static bool init_windowed = false;
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
static bool init_always_on_top = false;
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
static bool init_use_custom_pos = false;
Reorganize main and sub-window initial position properties.
2023-01-19 08:28:53 +00:00
static bool init_use_custom_screen = false;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static Vector2 init_custom_pos;
// Debug
static bool use_debug_profiler = false;
Optimize-out some debug and/or non-tools methods Collisions and nav debug are conditionally compiled depending on DEBUG_ENABLED is_editor_hint() and is_node_being_edited() are compiled only with TOOLS_ENABLED Every affected method is implemented in the header in case its macro is not present (the getters just returning false and the setters having an empty body) so the compiler can inline and finally no-op-out them as likely as possible. is_node_being_edited() already showed a similar optimization effort and has been adapted to this change. Furthermore, and as a consequence, -debugcol and -debugnav will not work on non-debug (strict release) builds. This can bring a little bit of runtime performance on release and non-tooled builds (less code, so less cycles to spend and maybe more cache friendly).
2017-04-07 14:17:16 +00:00
#ifdef DEBUG_ENABLED
begin work on debugging collisions....
2015-09-19 02:10:58 +00:00
static bool debug_collisions = false;
Add Path2D/3D debug options Add Path2D/3D debug options.
2022-06-15 21:24:06 +00:00
static bool debug_paths = false;
Ability to visually debug geometry visually: -Visible 2D and 3D Shapes, Polygons, Tile collisions, etc. -Visible Navmesh and Navpoly -Visible collision contacts for 2D and 3D as a red point -Customizable colors in project settings
2015-09-20 16:03:46 +00:00
static bool debug_navigation = false;
Optimize-out some debug and/or non-tools methods Collisions and nav debug are conditionally compiled depending on DEBUG_ENABLED is_editor_hint() and is_node_being_edited() are compiled only with TOOLS_ENABLED Every affected method is implemented in the header in case its macro is not present (the getters just returning false and the setters having an empty body) so the compiler can inline and finally no-op-out them as likely as possible. is_node_being_edited() already showed a similar optimization effort and has been adapted to this change. Furthermore, and as a consequence, -debugcol and -debugnav will not work on non-debug (strict release) builds. This can bring a little bit of runtime performance on release and non-tooled builds (less code, so less cycles to spend and maybe more cache friendly).
2017-04-07 14:17:16 +00:00
#endif
removed target_fps option, moved it to debug (it makes no sense for games). Added a frame_delay option for games that don't want to use the CPU fully.
2016-07-09 15:34:30 +00:00
static int frame_delay = 0;
Renderer/Simulator flags Now hopefully with correct code style
2017-08-30 10:40:35 +00:00
static bool disable_render_loop = false;
static int fixed_fps = -1;
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
static MovieWriter *movie_writer = nullptr;
static bool disable_vsync = false;
Add --print-fps option to output FPS to stdout Works both for the editor and games. Projects can still use "debug/settings/stdout/print_fps" to enable it permanently. The --print-fps option takes precedence (so works even if the project setting is disabled). That setting is also no longer redefined on the fly based on the verbose flag, that was a mess.
2018-03-21 07:46:05 +00:00
static bool print_fps = false;
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
#ifdef TOOLS_ENABLED
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
static bool dump_gdextension_interface = false;
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
static bool dump_extension_api = false;
#endif
Several GI related optimizations and fixes -SDFGI direct light is done over many frames -SDFGI Changed settings for rays/frame -SDFGI Misc optimizations -SDFGI Bug fix on probe scroll -GIProbe was not working, got it to work again -GIProbe dynamic objects were not working, fixed -Added a half size GI option.
2021-01-22 23:50:24 +00:00
bool profile_gpu = false;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
/* Helper methods */
Makes project manager never initialize mono debug. The heuristic whether we're in the project manager inside GDMono didn't work if the project manager was launched by not having any path to run. This is fixed now by making a Main::is_project_manager().
2018-02-16 15:00:54 +00:00
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
bool Main::is_cmdline_tool() {
return cmdline_tool;
}
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
#ifdef TOOLS_ENABLED
const Vector<String> &Main::get_forwardable_cli_arguments(Main::CLIScope p_scope) {
return forwardable_cli_arguments[p_scope];
}
#endif
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static String unescape_cmdline(const String &p_str) {
return p_str.replace("%20", " ");
}
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
static String get_full_version_string() {
String hash = String(VERSION_HASH);
Core: Move generated `VERSION_HASH` to a `.cpp` file This lets us have its definition in `core/version.h` and avoid rebuilding a handful of files every time the commit hash changes.
2022-02-08 19:50:37 +00:00
if (!hash.is_empty()) {
Display longer Git hashes in engine version dialogs Due to the high number of commits in the Godot repository, 7-character hashes were starting to become occasionally ambiguous. In contrast, 9-character hashes are currently unambiguous for all commits.
2019-06-01 11:51:10 +00:00
hash = "." + hash.left(9);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
return String(VERSION_FULL_BUILD) + hash;
}
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
// FIXME: Could maybe be moved to have less code in main.cpp.
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
void initialize_physics() {
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
/// 3D Physics Server
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
physics_server_3d = PhysicsServer3DManager::get_singleton()->new_server(
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
GLOBAL_GET(PhysicsServer3DManager::setting_property_name));
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
if (!physics_server_3d) {
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
// Physics server not found, Use the default physics
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
physics_server_3d = PhysicsServer3DManager::get_singleton()->new_default_server();
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
}
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
ERR_FAIL_COND(!physics_server_3d);
physics_server_3d->init();
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
// 2D Physics server
physics_server_2d = PhysicsServer2DManager::get_singleton()->new_server(
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
GLOBAL_GET(PhysicsServer2DManager::get_singleton()->setting_property_name));
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
if (!physics_server_2d) {
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
// Physics server not found, Use the default physics
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
physics_server_2d = PhysicsServer2DManager::get_singleton()->new_default_server();
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
}
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
ERR_FAIL_COND(!physics_server_2d);
physics_server_2d->init();
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
}
void finalize_physics() {
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
physics_server_3d->finish();
memdelete(physics_server_3d);
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
physics_server_2d->finish();
memdelete(physics_server_2d);
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
void finalize_display() {
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
rendering_server->finish();
memdelete(rendering_server);
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
memdelete(display_server);
}
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
void initialize_navigation_server() {
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
ERR_FAIL_COND(navigation_server_3d != nullptr);
Flushes commands just before the navigation server is destroyed
2020-02-26 08:42:51 +00:00
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
navigation_server_3d = NavigationServer3DManager::new_default_server();
navigation_server_2d = memnew(NavigationServer2D);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
}
void finalize_navigation_server() {
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
memdelete(navigation_server_3d);
navigation_server_3d = nullptr;
Flushes commands just before the navigation server is destroyed
2020-02-26 08:42:51 +00:00
Rename variable names for some singletons
2022-04-27 03:52:53 +00:00
memdelete(navigation_server_2d);
navigation_server_2d = nullptr;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
}
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
void initialize_theme_db() {
theme_db = memnew(ThemeDB);
theme_db->initialize_theme();
}
void finalize_theme_db() {
memdelete(theme_db);
theme_db = nullptr;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00: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 engine version to stdout when starting Godot Also include website URL and make it configurable via version.py together with the rest of the engine branding. Add mention to MIT license in --help output.
2019-05-28 09:19:21 +00:00
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");
One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
OS::get_singleton()->print("(c) 2014-present Godot Engine contributors.\n");
OS::get_singleton()->print("(c) 2007-2014 Juan Linietsky, Ariel Manzur.\n");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("\n");
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
OS::get_singleton()->print("Usage: %s [options] [path to scene or 'project.godot' file]\n", p_binary);
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("\n");
OS::get_singleton()->print("General options:\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" -h, --help Display this help message.\n");
OS::get_singleton()->print(" --version Display the version string.\n");
OS::get_singleton()->print(" -v, --verbose Use verbose stdout mode.\n");
OS::get_singleton()->print(" -q, --quiet Quiet mode, silences stdout messages. Errors are still displayed.\n");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("\n");
OS::get_singleton()->print("Run options:\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --, ++ Separator for user-provided arguments. Following arguments are not used by the engine, but can be read from `OS.get_cmdline_user_args()`.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
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");
OS::get_singleton()->print(" --debug-server <uri> Start the editor debug server (<protocol>://<host/IP>[:<port>], e.g. tcp://127.0.0.1:6007)\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --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");
OS::get_singleton()->print(" --path <directory> Path to a project (<directory> must contain a 'project.godot' file).\n");
OS::get_singleton()->print(" -u, --upwards Scan folders upwards for project.godot file.\n");
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 [");
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
if (i > 0) {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print(", ");
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
OS::get_singleton()->print("'%s'", AudioDriverManager::get_driver(i)->get_name());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
OS::get_singleton()->print("].\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --display-driver <driver> Display driver (and rendering driver) [");
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
if (i > 0) {
OS::get_singleton()->print(", ");
}
OS::get_singleton()->print("'%s' (", DisplayServer::get_create_function_name(i));
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Vector<String> rd = DisplayServer::get_create_function_rendering_drivers(i);
for (int j = 0; j < rd.size(); j++) {
if (j > 0) {
OS::get_singleton()->print(", ");
}
OS::get_singleton()->print("'%s'", rd[j].utf8().get_data());
}
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
OS::get_singleton()->print(")");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
OS::get_singleton()->print("].\n");
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --rendering-method <renderer> Renderer name. Requires driver support.\n");
OS::get_singleton()->print(" --rendering-driver <driver> Rendering driver (depends on display driver).\n");
OS::get_singleton()->print(" --gpu-index <device_index> Use a specific GPU (run with --verbose to get available device list).\n");
OS::get_singleton()->print(" --text-driver <driver> Text driver (Fonts, BiDi, shaping).\n");
OS::get_singleton()->print(" --tablet-driver <driver> Pen tablet input driver.\n");
OS::get_singleton()->print(" --headless Enable headless mode (--display-driver headless --audio-driver Dummy). Useful for servers and with --script.\n");
OS::get_singleton()->print(" --write-movie <file> Writes a video to the specified path (usually with .avi or .png extension).\n");
OS::get_singleton()->print(" --fixed-fps is forced when enabled, but it can be used to change movie FPS.\n");
OS::get_singleton()->print(" --disable-vsync can speed up movie writing but makes interaction more difficult.\n");
[Headless] Add --headless switch (no rendering, no audio). Also remove now unused "--no-window" option, and relative OS getter and setter.
2021-08-03 14:59:18 +00:00
DisplayServer: Fix registration of GetRenderingDriversFunction Also improve `--help` output.
2020-03-27 09:48:30 +00:00
OS::get_singleton()->print("\n");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Display options:\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
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");
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
OS::get_singleton()->print(" --position <X>,<Y> Request window position (if set, screen argument is ignored).\n");
OS::get_singleton()->print(" --screen <N> Request window screen.\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --single-window Use a single window (no separate subwindows).\n");
OS::get_singleton()->print(" --xr-mode <mode> Select XR (Extended Reality) mode ['default', 'off', 'on'].\n");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("\n");
Revert "Second take at making command-line arguments more UNIX-like + main.cpp and help cleanup"
2017-08-19 20:47:27 +00:00
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Debug options:\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
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(" --gpu-profile Show a GPU profile of the tasks that took the most time during frame rendering.\n");
OS::get_singleton()->print(" --gpu-validation Enable graphics API validation layers for debugging.\n");
Tweak the display order of CLI arguments in `--help` for consistency `--profile-gpu` was renamed to `--gpu-profile` for consistency with `--gpu-abort`. This also updates the shell completion files to the latest `master` branch.
2021-12-07 19:07:47 +00:00
#if DEBUG_ENABLED
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --gpu-abort Abort on graphics API usage errors (usually validation layer errors). May help see the problem if your system freezes.\n");
Vulkan: Make validation layers optional They're now disabled by default, and can be enabled with the command line argument `--vk-layers`. When enabled, the errors about them being missing are now warnings, as users were confused and thought this meant Vulkan is broken for them. Fix crash in `~VulkanContext` when validation layers are disabled (exposed by this PR since before they could not be disabled without source modification). Also moved VulkanContext member initializations to header. Fixes #37102.
2020-10-27 15:00:15 +00:00
#endif
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --remote-debug <uri> Remote debug (<protocol>://<host/IP>[:<port>], e.g. tcp://127.0.0.1:6007).\n");
[Headless] Add --headless switch (no rendering, no audio). Also remove now unused "--no-window" option, and relative OS getter and setter.
2021-08-03 14:59:18 +00:00
#if defined(DEBUG_ENABLED)
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --debug-collisions Show collision shapes when running the scene.\n");
OS::get_singleton()->print(" --debug-paths Show path lines when running the scene.\n");
OS::get_singleton()->print(" --debug-navigation Show navigation polygons when running the scene.\n");
OS::get_singleton()->print(" --debug-stringnames Print all StringName allocations to stdout when the engine quits.\n");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
#endif
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
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-vsync Forces disabling of vertical synchronization, even if enabled in the project settings. Does not override driver-level V-Sync enforcement.\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");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("\n");
OS::get_singleton()->print("Standalone tools:\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
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");
Revert "Second take at making command-line arguments more UNIX-like + main.cpp and help cleanup"
2017-08-19 20:47:27 +00:00
#ifdef TOOLS_ENABLED
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --export-release <preset> <path> Export the project in release mode using the given preset and output path. 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').\n");
OS::get_singleton()->print(" The target directory must exist.\n");
OS::get_singleton()->print(" --export-debug <preset> <path> Export the project in debug mode using the given preset and output path. See --export-release description for other considerations.\n");
OS::get_singleton()->print(" --export-pack <preset> <path> Export the project data only using the given preset and output path. The <path> extension determines whether it will be in PCK or ZIP format.\n");
OS::get_singleton()->print(" --convert-3to4 [<max_file_kb>] [<max_line_size>]\n");
OS::get_singleton()->print(" Converts project from Godot 3.x to Godot 4.x.\n");
OS::get_singleton()->print(" --validate-conversion-3to4 [<max_file_kb>] [<max_line_size>]\n");
OS::get_singleton()->print(" Shows what elements will be renamed when converting project from Godot 3.x to Godot 4.x.\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");
OS::get_singleton()->print(" --build-solutions Build the scripting solutions (e.g. for C# projects). Implies --editor and requires a valid project to edit.\n");
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
OS::get_singleton()->print(" --dump-gdextension-interface Generate GDExtension header file 'gdextension_interface.h' in the current folder. This file is the base file required to implement a GDExtension.\n");
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --dump-extension-api Generate JSON dump of the Godot API for GDExtension bindings named 'extension_api.json' in the current folder.\n");
OS::get_singleton()->print(" --startup-benchmark Benchmark the startup time and print it to console.\n");
OS::get_singleton()->print(" --startup-benchmark-file <path> Benchmark the startup time and save it to a given file in JSON format.\n");
SCons: Add `tests` option to enable or disable unit tests
2020-07-25 13:59:30 +00:00
#ifdef TESTS_ENABLED
Improve command line help to fit on narrower displays - Update shell completions to reference recently added CLI arguments.
2022-11-14 18:31:24 +00:00
OS::get_singleton()->print(" --test [--help] Run unit tests. Use --test --help for more information.\n");
SCons: Add `tests` option to enable or disable unit tests
2020-07-25 13:59:30 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Add option modules_enabled_by_default
2020-08-04 07:22:30 +00:00
OS::get_singleton()->print("\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
#ifdef TESTS_ENABLED
// The order is the same as in `Main::setup()`, only core and some editor types
// are initialized here. This also combines `Main::setup2()` initialization.
Error Main::test_setup() {
OS::get_singleton()->initialize();
engine = memnew(Engine);
register_core_types();
register_core_driver_types();
Set up PackedData when setting up tests Some tests need functions of ProjectSettings that rely on this being available.
2021-04-07 17:23:18 +00:00
packed_data = memnew(PackedData);
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
globals = memnew(ProjectSettings);
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
register_core_settings(); // Here globals are present.
Implement a Worker ThreadPool This PR implements a worked thread pool. It uses a fixed amount of threads in a pool and allows scheduling tasks that can be run on threads (and then waited for). It satisfies the following use cases: * HTML5 thread count is fixed (and similar restrictions are known in consoles) so we need to reuse threads. * Thread spawning is slow in general, so reusing threads is faster anyway. * This implementation supports recursive waiting for tasks, making it less prone to deadlocks if threads from the pool also run tasks. After this is approved and merged, subsequent PRs will be needed to replace the ThreadWorkPool usage by this class.
2022-07-18 10:09:19 +00:00
Initialize `TranslationServer` in the test environment
2021-02-22 13:16:46 +00:00
translation_server = memnew(TranslationServer);
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
tsman = memnew(TextServerManager);
Initialize `TranslationServer` in the test environment
2021-02-22 13:16:46 +00:00
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
if (tsman) {
Ref<TextServerDummy> ts;
ts.instantiate();
tsman->add_interface(ts);
}
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
physics_server_3d_manager = memnew(PhysicsServer3DManager);
physics_server_2d_manager = memnew(PhysicsServer2DManager);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
// From `Main::setup2()`.
initialize_modules(MODULE_INITIALIZATION_LEVEL_CORE);
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
register_core_extensions();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
register_core_singletons();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
/** INITIALIZE SERVERS **/
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
register_server_types();
Tests: Silence some intentional errors Also fix printing messages in ClassDB test.
2022-08-04 13:55:45 +00:00
XRServer::set_xr_mode(XRServer::XRMODE_OFF); // Skip in tests.
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
initialize_modules(MODULE_INITIALIZATION_LEVEL_SERVERS);
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->initialize_extensions(GDExtension::INITIALIZATION_LEVEL_SERVERS);
Initialize `TranslationServer` in the test environment
2021-02-22 13:16:46 +00:00
translation_server->setup(); //register translations, load them, etc.
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!locale.is_empty()) {
Initialize `TranslationServer` in the test environment
2021-02-22 13:16:46 +00:00
translation_server->set_locale(locale);
}
translation_server->load_translations();
ResourceLoader::load_translation_remaps(); //load remaps for resources
ResourceLoader::load_path_remaps();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
register_scene_types();
Reorder native extension types initialization, initializing editor last
2022-02-28 13:50:43 +00:00
register_driver_types();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
initialize_modules(MODULE_INITIALIZATION_LEVEL_SCENE);
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->initialize_extensions(GDExtension::INITIALIZATION_LEVEL_SCENE);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
#ifdef TOOLS_ENABLED
ClassDB::set_current_api(ClassDB::API_EDITOR);
Move editor class and plugin registrations to a dedicated file
2022-05-01 09:57:36 +00:00
register_editor_types();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
initialize_modules(MODULE_INITIALIZATION_LEVEL_EDITOR);
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->initialize_extensions(GDExtension::INITIALIZATION_LEVEL_EDITOR);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
ClassDB::set_current_api(ClassDB::API_CORE);
#endif
register_platform_apis();
Make default/project theme wait for modules before initializing
2021-11-30 16:09:29 +00:00
// Theme needs modules to be initialized so that sub-resources can be loaded.
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
initialize_theme_db();
register_scene_singletons();
Make default/project theme wait for modules before initializing
2021-11-30 16:09:29 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
ERR_FAIL_COND_V(TextServerManager::get_singleton()->get_interface_count() == 0, ERR_CANT_CREATE);
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
/* Use one with the most features available. */
int max_features = 0;
for (int i = 0; i < TextServerManager::get_singleton()->get_interface_count(); i++) {
uint32_t features = TextServerManager::get_singleton()->get_interface(i)->get_features();
int feature_number = 0;
while (features) {
feature_number += features & 1;
features >>= 1;
}
if (feature_number >= max_features) {
max_features = feature_number;
text_driver_idx = i;
}
}
if (text_driver_idx >= 0) {
TextServerManager::get_singleton()->set_primary_interface(TextServerManager::get_singleton()->get_interface(text_driver_idx));
} else {
ERR_FAIL_V_MSG(ERR_CANT_CREATE, "TextServer: Unable to create TextServer interface.");
}
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
ClassDB::set_current_api(ClassDB::API_NONE);
_start_success = true;
return OK;
}
// The order is the same as in `Main::cleanup()`.
void Main::test_cleanup() {
ERR_FAIL_COND(!_start_success);
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
for (int i = 0; i < TextServerManager::get_singleton()->get_interface_count(); i++) {
TextServerManager::get_singleton()->get_interface(i)->cleanup();
}
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
EngineDebugger::deinitialize();
ResourceLoader::remove_custom_loaders();
ResourceSaver::remove_custom_savers();
#ifdef TOOLS_ENABLED
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->deinitialize_extensions(GDExtension::INITIALIZATION_LEVEL_EDITOR);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_EDITOR);
Move editor class and plugin registrations to a dedicated file
2022-05-01 09:57:36 +00:00
unregister_editor_types();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
#endif
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->deinitialize_extensions(GDExtension::INITIALIZATION_LEVEL_SCENE);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_SCENE);
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
unregister_platform_apis();
Reorder native extension types initialization, initializing editor last
2022-02-28 13:50:43 +00:00
unregister_driver_types();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
unregister_scene_types();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
finalize_theme_db();
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->deinitialize_extensions(GDExtension::INITIALIZATION_LEVEL_SERVERS);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_SERVERS);
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
unregister_server_types();
OS::get_singleton()->finalize();
Initialize `TranslationServer` in the test environment
2021-02-22 13:16:46 +00:00
if (translation_server) {
memdelete(translation_server);
}
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
if (tsman) {
memdelete(tsman);
}
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
if (physics_server_3d_manager) {
memdelete(physics_server_3d_manager);
}
if (physics_server_2d_manager) {
memdelete(physics_server_2d_manager);
}
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
if (globals) {
memdelete(globals);
}
Set up PackedData when setting up tests Some tests need functions of ProjectSettings that rely on this being available.
2021-04-07 17:23:18 +00:00
if (packed_data) {
memdelete(packed_data);
}
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
if (engine) {
memdelete(engine);
}
unregister_core_driver_types();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_CORE);
Fix extension registration order.
2022-02-16 17:02:38 +00:00
unregister_core_extensions();
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
unregister_core_types();
OS::get_singleton()->finalize_core();
}
#endif
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
int Main::test_entrypoint(int argc, char *argv[], bool &tests_need_run) {
SCons: Add `tests` option to enable or disable unit tests
2020-07-25 13:59:30 +00:00
#ifdef TESTS_ENABLED
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
for (int x = 0; x < argc; x++) {
Properly detect `--test` command-line argument Do not prematurely parse anything which beings with `--test` to run doctest. This allows other commands to be run, such as `--test-gdscript` or other custom arguments.
2020-08-08 18:53:51 +00:00
if ((strncmp(argv[x], "--test", 6) == 0) && (strlen(argv[x]) == 6)) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
tests_need_run = true;
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
// TODO: need to come up with different test contexts.
// Not every test requires high-level functionality like `ClassDB`.
test_setup();
fix crash on shutdown
2020-07-24 13:38:57 +00:00
int status = test_main(argc, argv);
Port ClassDB tests to use doctest Extracted the most minimal core initialization functionality from `setup()` and `setup2()` so that `ClassDB` could be tested properly (input, audio, rendering, physics etc, are excluded). Display and rendering servers/singletons are not initialized at all. Due to the fact that most subsystems are disabled, fixed various crashes in the process (in order): - `AcceptDialog` OK/cancel swap behavior (used `DisplayServer` while `register_scene_types()`); - `make_default_theme` which depends on `RenderingServer`; - `XRServer` singleton access while calling `register_modules_types()`; - hidden bug in a way joypads are cleaned up (MacOS and Linux only). Removed manual `ClassDB` init/cleanup calls from `test_validate_testing.h`. ClassDB tests: Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2020-08-02 18:30:56 +00:00
test_cleanup();
fix crash on shutdown
2020-07-24 13:38:57 +00:00
return status;
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
}
}
#endif
tests_need_run = false;
return 0;
}
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
/* 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.
Style: Misc docs and comment style and language fixes - Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-01 14:29:38 +00:00
* If p_second_phase is true, it will chain into setup2() (default behavior). This is
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
* 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.
*/
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_phase) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
OS::get_singleton()->initialize();
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
engine = memnew(Engine);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MAIN_PRINT("Main: Initialize CORE");
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
engine->startup_begin();
engine->startup_benchmark_begin_measure("core");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
register_core_types();
register_core_driver_types();
MAIN_PRINT("Main: Initialize Globals");
input_map = memnew(InputMap);
Add Time singleton
2021-05-24 11:54:05 +00:00
time_singleton = memnew(Time);
Added ability to override built-in actions for the editor This adds the ability to add overrides for built-in actions (i.e. ui_*) in the editor. Also added a number of additional built-in actions for various text-related actions, gui-generic actions (like copy and paste) and graph-related actions (duplicate nodes), etc. Moved the definition of input actions to input_map, rather than in project_settings so the editor can make use of these actions as well.
2020-12-07 11:31:51 +00:00
globals = memnew(ProjectSettings);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fixes small typos and grammar correction
2021-03-12 13:35:16 +00:00
register_core_settings(); //here globals are present
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
translation_server = memnew(TranslationServer);
performance = memnew(Performance);
Implement the ability to disable classes * This PR adds the ability to disable classes when building. * For now it's only possible to do this via command like: `scons disable_classes=RayCast2D,Area3D` * Eventually, a proper UI will be implemented to create a build config file to do this at large scale, as well as detect what is used in the project.
2021-07-11 22:30:33 +00:00
GDREGISTER_CLASS(Performance);
Move singleton management from ProjectSettings to Engine
2017-11-13 20:46:57 +00:00
engine->add_singleton(Engine::Singleton("Performance", performance));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fix warning spam when using `--help` or `--version` command line argument When a project setting is not found, a warning message is printed. This moves the default value declaration so it can be found when the `--help` or `--version` command line arguments are used.
2020-12-29 21:20:02 +00:00
// Only flush stdout in debug builds by default, as spamming `print()` will
// decrease performance if this is enabled.
Logger: Cache 'flush_stdout_on_print' to improve performance, and works before ProjectSettings starts. ProjectSetting: Now 'application/run/flush_stdout_on_print' requires a restart of the Editor to take effect
2021-02-28 22:26:14 +00:00
GLOBAL_DEF_RST("application/run/flush_stdout_on_print", false);
GLOBAL_DEF_RST("application/run/flush_stdout_on_print.debug", true);
Fix warning spam when using `--help` or `--version` command line argument When a project setting is not found, a warning message is printed. This moves the default value declaration so it can be found when the `--help` or `--version` command line arguments are used.
2020-12-29 21:20:02 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MAIN_PRINT("Main: Parse CMDLine");
/* argument parsing and main creation */
List<String> args;
List<String> main_args;
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
List<String> user_args;
bool adding_user_args = false;
[macOS] Improve file association handling, and allow URL schema handling.
2022-07-07 07:57:22 +00:00
List<String> platform_args = OS::get_singleton()->get_cmdline_platform_args();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
[macOS] Improve file association handling, and allow URL schema handling.
2022-07-07 07:57:22 +00:00
// Add command line arguments.
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
for (int i = 0; i < argc; i++) {
Fix #19 Can't open project (with non-ASCII path) In `class OS_Unix` the arguments in the `execute` method are converted to UTF-8, but in the `main` program's method they're inserted into a wide-char `Vector` before translating them from UTF-8 and thus the non-ASCII characters are lost. This fix converts the `argv` elements to UTF-8 using `String::utf8` before inserting them in the `Vector`.
2014-02-18 13:37:22 +00:00
args.push_back(String::utf8(argv[i]));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
[macOS] Improve file association handling, and allow URL schema handling.
2022-07-07 07:57:22 +00:00
// Add arguments received from macOS LaunchService (URL schemas, file associations).
for (const String &arg : platform_args) {
args.push_back(arg);
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
List<String>::Element *I = args.front();
while (I) {
Fix and expose String::strip_escapes(), use it in LineEdit paste Supersedes #27736.
2019-05-31 13:27:53 +00:00
I->get() = unescape_cmdline(I->get().strip_edges());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
I = I->next();
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
String display_driver = "";
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String audio_driver = "";
Change reused variable name in command line parsing
2018-05-12 11:21:26 +00:00
String project_path = ".";
Made directory scan optional
2017-10-10 12:45:54 +00:00
bool upwards = false;
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
String debug_uri = "";
Adds skip-breakpoints feature
2019-07-29 18:09:22 +00:00
bool skip_breakpoints = false;
Misc Fixes ========== -NOTIFICATION_WM_QUIT fixed on android (seems tha way this is reported changed in newer sdk) -WIP implementation of APK Expansion APIs for publishing games larger than 50mb in Play Store -Feaures in the new tutorials are all present in the sourcecode -This (hopefully) should get rid of the animation list order getting corrupted -Improved 3D Scene Importer (Skeletons, Animations and other stuff were not being merged). Anything missing? -In code editor, the automatic syntax checker will only use file_exists() to check preload() else it might freeze the editor too much while typing if the preload is a big resource -Fixed bugs in PolygonPathFinder, stil pending to do a node and a demo
2014-06-28 02:21:45 +00:00
String main_pack;
Small Issues & Maintenance -=-=-=-=-=-=-=-=-=-=-=-=-= -Begin work on Navigation Meshes (simple pathfinding for now, will improve soon) -More doc on theme overriding -Upgraded OpenSSL to version without bugs -Misc bugfixes
2014-08-02 01:10:38 +00:00
bool quiet_stdout = false;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int rtm = -1;
String remotefs;
String remotefs_pass;
Vector<String> breakpoints;
bool use_custom_res = true;
bool force_res = false;
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
String default_renderer = "";
Use mobile as the default rendering method on mobile when vulkan is supported
2022-09-30 02:16:13 +00:00
String default_renderer_mobile = "";
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
String renderer_hints = "";
Misc Fixes ========== -NOTIFICATION_WM_QUIT fixed on android (seems tha way this is reported changed in newer sdk) -WIP implementation of APK Expansion APIs for publishing games larger than 50mb in Play Store -Feaures in the new tutorials are all present in the sourcecode -This (hopefully) should get rid of the animation list order getting corrupted -Improved 3D Scene Importer (Skeletons, Animations and other stuff were not being merged). Anything missing? -In code editor, the automatic syntax checker will only use file_exists() to check preload() else it might freeze the editor too much while typing if the preload is a big resource -Fixed bugs in PolygonPathFinder, stil pending to do a node and a demo
2014-06-28 02:21:45 +00:00
packed_data = PackedData::get_singleton();
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (!packed_data) {
Misc Fixes ========== -NOTIFICATION_WM_QUIT fixed on android (seems tha way this is reported changed in newer sdk) -WIP implementation of APK Expansion APIs for publishing games larger than 50mb in Play Store -Feaures in the new tutorials are all present in the sourcecode -This (hopefully) should get rid of the animation list order getting corrupted -Improved 3D Scene Importer (Skeletons, Animations and other stuff were not being merged). Anything missing? -In code editor, the automatic syntax checker will only use file_exists() to check preload() else it might freeze the editor too much while typing if the preload is a big resource -Fixed bugs in PolygonPathFinder, stil pending to do a node and a demo
2014-06-28 02:21:45 +00:00
packed_data = memnew(PackedData);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef MINIZIP_ENABLED
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Fix segment violation MINIZIP_ENABLED
2015-05-06 23:37:25 +00:00
//XXX: always get_singleton() == 0x0
-Changed Godot exit to be clean. -Added more debug information on memory cleanliness on exit (if run with -v) -Fixed several memory leaks, fixes #1731, fixes #755
2015-04-20 22:38:02 +00:00
zip_packed_data = ZipArchive::get_singleton();
Fix segment violation MINIZIP_ENABLED
2015-05-06 23:37:25 +00:00
//TODO: remove this temporary fix
if (!zip_packed_data) {
zip_packed_data = memnew(ZipArchive);
}
-Changed Godot exit to be clean. -Added more debug information on memory cleanliness on exit (if run with -v) -Fixed several memory leaks, fixes #1731, fixes #755
2015-04-20 22:38:02 +00:00
packed_data->add_pack_source(zip_packed_data);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Command line arguments '--version' and '--help' return exit code 0 instead of 255 Allows to detect whether those commands executed successfully, which makes integration with shell scripts/CI/bindings straightforward.
2022-06-30 11:55:15 +00:00
// Default exit code, can be modified for certain errors.
Error exit_code = ERR_INVALID_PARAMETER;
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
I = args.front();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
while (I) {
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
#ifdef MACOS_ENABLED
Ignore process serial number (`-psn_...`) command line argument passed by macOS Gatekeeper.
2020-04-09 17:06:43 +00:00
// Ignore the process serial number argument passed by macOS Gatekeeper.
// Otherwise, Godot would try to open a non-existent project on the first start and abort.
if (I->get().begins_with("-psn_")) {
I = I->next();
continue;
}
#endif
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
List<String>::Element *N = I->next();
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
#ifdef TOOLS_ENABLED
if (I->get() == "--debug" ||
I->get() == "--verbose" ||
I->get() == "--disable-crash-handler") {
forwardable_cli_arguments[CLI_SCOPE_TOOL].push_back(I->get());
forwardable_cli_arguments[CLI_SCOPE_PROJECT].push_back(I->get());
}
Fix forwarding of CLI arguments taking an option
2022-08-25 06:42:34 +00:00
if (I->get() == "--single-window") {
forwardable_cli_arguments[CLI_SCOPE_TOOL].push_back(I->get());
}
if (I->get() == "--audio-driver" ||
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
I->get() == "--display-driver" ||
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
I->get() == "--rendering-method" ||
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
I->get() == "--rendering-driver") {
Fix forwarding of CLI arguments taking an option
2022-08-25 06:42:34 +00:00
if (I->next()) {
forwardable_cli_arguments[CLI_SCOPE_TOOL].push_back(I->get());
forwardable_cli_arguments[CLI_SCOPE_TOOL].push_back(I->next()->get());
}
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
}
#endif
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
if (adding_user_args) {
user_args.push_back(I->get());
} else if (I->get() == "-h" || I->get() == "--help" || I->get() == "/?") { // display help
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
show_help = true;
Fix exit code of --help and --version, and test them in CI Corrects prior regression which caused ERROR output and exit code of 1.
2022-07-01 23:05:20 +00:00
exit_code = ERR_HELP; // Hack to force an early exit in `main()` with a success code.
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
main: Add --version switch and git hash to --help Also fix some help strings.
2017-09-24 09:32:05 +00:00
} else if (I->get() == "--version") {
print_line(get_full_version_string());
Fix exit code of --help and --version, and test them in CI Corrects prior regression which caused ERROR output and exit code of 1.
2022-07-01 23:05:20 +00:00
exit_code = ERR_HELP; // Hack to force an early exit in `main()` with a success code.
main: Add --version switch and git hash to --help Also fix some help strings.
2017-09-24 09:32:05 +00:00
goto error;
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
} else if (I->get() == "-v" || I->get() == "--verbose") { // verbose output
OS::get_singleton()->_verbose_stdout = true;
Make `-q` CLI argument toggle quiet stdout instead of quitting `-q` is a common toggle in a command line applications for quiet mode (see apt or dnf for examples). In contrast, `--quit` isn't needed as often.
2021-12-07 17:06:40 +00:00
} else if (I->get() == "-q" || I->get() == "--quiet") { // quieter output
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
quiet_stdout = true;
} else if (I->get() == "--audio-driver") { // audio driver
if (I->next()) {
audio_driver = I->next()->get();
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
bool found = false;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
if (audio_driver == AudioDriverManager::get_driver(i)->get_name()) {
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
found = true;
}
}
if (!found) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print("Unknown audio driver '%s', aborting.\nValid options are ",
audio_driver.utf8().get_data());
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
if (i == AudioDriverManager::get_driver_count() - 1) {
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
OS::get_singleton()->print(" and ");
} else if (i != 0) {
OS::get_singleton()->print(", ");
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
OS::get_singleton()->print("'%s'", AudioDriverManager::get_driver(i)->get_name());
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
}
OS::get_singleton()->print(".\n");
goto error;
}
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing audio driver argument, aborting.\n");
goto error;
}
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
} else if (I->get() == "--text-driver") {
if (I->next()) {
text_driver = I->next()->get();
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing text driver argument, aborting.\n");
goto error;
}
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
} else if (I->get() == "--display-driver") { // force video driver
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
if (I->next()) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
display_driver = I->next()->get();
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
bool found = false;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
if (display_driver == DisplayServer::get_create_function_name(i)) {
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
found = true;
}
}
if (!found) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print("Unknown display driver '%s', aborting.\nValid options are ",
display_driver.utf8().get_data());
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
if (i == DisplayServer::get_create_function_count() - 1) {
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
OS::get_singleton()->print(" and ");
} else if (i != 0) {
OS::get_singleton()->print(", ");
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
OS::get_singleton()->print("'%s'", DisplayServer::get_create_function_name(i));
Validate audio/video driver command-line arguments This will exit early if the audio/video driver specified doesn't exist.
2019-09-27 13:06:15 +00:00
}
OS::get_singleton()->print(".\n");
goto error;
}
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
N = I->next()->next();
} else {
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
OS::get_singleton()->print("Missing display driver argument, aborting.\n");
goto error;
}
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
} else if (I->get() == "--rendering-method") {
if (I->next()) {
rendering_method = I->next()->get();
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing renderer name argument, aborting.\n");
goto error;
}
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
} else if (I->get() == "--rendering-driver") {
if (I->next()) {
rendering_driver = I->next()->get();
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing rendering driver argument, aborting.\n");
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
goto error;
}
} 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;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
window_mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
} else if (I->get() == "-w" || I->get() == "--windowed") { // force windowed window
init_windowed = true;
[Vulkan] Check each device capabilities before selecting it. Split instance and physical device selection function and move device selection to window creation, to reject devices without present capability. Add device preferred type check in discrete > integrated > virtual > cpu > other order. Add device list printout. Add command line argument to override device selection.
2021-11-15 12:55:41 +00:00
} else if (I->get() == "--gpu-index") {
if (I->next()) {
Engine::singleton->gpu_idx = I->next()->get().to_int();
N = I->next()->next();
} else {
Tweak the display order of CLI arguments in `--help` for consistency `--profile-gpu` was renamed to `--gpu-profile` for consistency with `--gpu-abort`. This also updates the shell completion files to the latest `master` branch.
2021-12-07 19:07:47 +00:00
OS::get_singleton()->print("Missing GPU index argument, aborting.\n");
[Vulkan] Check each device capabilities before selecting it. Split instance and physical device selection function and move device selection to window creation, to reject devices without present capability. Add device preferred type check in discrete > integrated > virtual > cpu > other order. Add device list printout. Add command line argument to override device selection.
2021-11-15 12:55:41 +00:00
goto error;
}
Rename `--vk-layers` command line argument to `--gpu-validation` The new name is independent of the graphics API in use. This prepares Godot for implementations of graphics APIs other than Vulkan.
2022-05-16 19:34:18 +00:00
} else if (I->get() == "--gpu-validation") {
Vulkan: Make validation layers optional They're now disabled by default, and can be enabled with the command line argument `--vk-layers`. When enabled, the errors about them being missing are now warnings, as users were confused and thought this meant Vulkan is broken for them. Fix crash in `~VulkanContext` when validation layers are disabled (exposed by this PR since before they could not be disabled without source modification). Also moved VulkanContext member initializations to header. Fixes #37102.
2020-10-27 15:00:15 +00:00
Engine::singleton->use_validation_layers = true;
allow vulkan validation layers in release builds if explicity asked for
2020-11-18 18:01:41 +00:00
#ifdef DEBUG_ENABLED
Vulkan: Make validation layers optional They're now disabled by default, and can be enabled with the command line argument `--vk-layers`. When enabled, the errors about them being missing are now warnings, as users were confused and thought this meant Vulkan is broken for them. Fix crash in `~VulkanContext` when validation layers are disabled (exposed by this PR since before they could not be disabled without source modification). Also moved VulkanContext member initializations to header. Fixes #37102.
2020-10-27 15:00:15 +00:00
} else if (I->get() == "--gpu-abort") {
More GIProbe work and fixes
2019-10-05 13:27:43 +00:00
Engine::singleton->abort_on_gpu_errors = true;
Vulkan: Make validation layers optional They're now disabled by default, and can be enabled with the command line argument `--vk-layers`. When enabled, the errors about them being missing are now warnings, as users were confused and thought this meant Vulkan is broken for them. Fix crash in `~VulkanContext` when validation layers are disabled (exposed by this PR since before they could not be disabled without source modification). Also moved VulkanContext member initializations to header. Fixes #37102.
2020-10-27 15:00:15 +00:00
#endif
[Windows] Add tablet driver selection.
2020-05-19 20:34:26 +00:00
} else if (I->get() == "--tablet-driver") {
if (I->next()) {
tablet_driver = I->next()->get();
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing tablet driver argument, aborting.\n");
goto error;
}
Open sub-windows as embedded if the OS does not support them
2020-03-14 16:06:39 +00:00
} else if (I->get() == "--single-window") { // force single window
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
single_window = true;
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
} else if (I->get() == "-t" || I->get() == "--always-on-top") { // force always-on-top window
init_always_on_top = true;
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (I->get() == "--resolution") { // force resolution
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
String vm = I->next()->get();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
String: Add contains().
2022-02-03 16:03:38 +00:00
if (!vm.contains("x")) { // invalid parameter format
remove trailing whitespace
2016-03-08 23:00:52 +00:00
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print("Invalid resolution '%s', it should be e.g. '1280x720'.\n",
vm.utf8().get_data());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int w = vm.get_slice("x", 0).to_int();
int h = vm.get_slice("x", 1).to_int();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
if (w <= 0 || h <= 0) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print("Invalid resolution '%s', width and height must be above 0.\n",
vm.utf8().get_data());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
window_size.width = w;
window_size.height = h;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
force_res = true;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing resolution argument, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Hide non-applicable CLI arguments in the server platform This refactors some of the CLI parsing code to follow the CLI help's order, making it easier to toggle using compile-time defines.
2019-05-18 23:33:13 +00:00
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
} else if (I->get() == "--screen") { // set window screen
if (I->next()) {
init_screen = I->next()->get().to_int();
Reorganize main and sub-window initial position properties.
2023-01-19 08:28:53 +00:00
init_use_custom_screen = true;
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing screen argument, aborting.\n");
goto error;
}
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (I->get() == "--position") { // set window position
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
if (I->next()) {
String vm = I->next()->get();
String: Add contains().
2022-02-03 16:03:38 +00:00
if (!vm.contains(",")) { // invalid parameter format
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print("Invalid position '%s', it should be e.g. '80,128'.\n",
vm.utf8().get_data());
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
goto error;
}
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
int x = vm.get_slice(",", 0).to_int();
int y = vm.get_slice(",", 1).to_int();
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
init_custom_pos = Point2(x, y);
init_use_custom_pos = true;
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing position argument, aborting.\n");
new editor settings customization of where to run the game from the editor
2015-08-31 02:36:46 +00:00
goto error;
}
[Headless] Add --headless switch (no rendering, no audio). Also remove now unused "--no-window" option, and relative OS getter and setter.
2021-08-03 14:59:18 +00:00
} else if (I->get() == "--headless") { // enable headless mode (no audio, no rendering).
audio_driver = "Dummy";
display_driver = "headless";
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (I->get() == "--profiling") { // enable profiling
-added windowed mode with -w, fixes #3020 -changed default windowed resolution to 1280x720
2015-12-12 15:06:53 +00:00
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
use_debug_profiler = true;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "-l" || I->get() == "--language") { // language
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
locale = I->next()->get();
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing language argument, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
-Some fixes to OSX retina scaling for window functions -Implemented HiDPI detection and support for Godot Editor!
2016-05-30 03:28:29 +00:00
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--remote-fs") { // remote filesystem
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
remotefs = I->next()->get();
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing remote filesystem address, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--remote-fs-password") { // remote filesystem password
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
remotefs_pass = I->next()->get();
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing remote filesystem password, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (I->get() == "--render-thread") { // render thread mode
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (I->next()->get() == "safe") {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
rtm = OS::RENDER_THREAD_SAFE;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
} else if (I->next()->get() == "unsafe") {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
rtm = OS::RENDER_THREAD_UNSAFE;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
} else if (I->next()->get() == "separate") {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
rtm = OS::RENDER_SEPARATE_THREAD;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing render thread mode argument, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
#ifdef TOOLS_ENABLED
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "-e" || I->get() == "--editor") { // starts editor
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
editor = true;
Always detect and use hiDPI in the project manager if needed This makes its hiDPI behavior consistent with the editor.
2018-02-13 17:56:38 +00:00
} else if (I->get() == "-p" || I->get() == "--project-manager") { // starts project manager
project_manager = true;
[Editor] Add "--debug-server <uri>" option. Allow starting the editor debugger server for the given protocol (and optionally bound to the given ip/port combination: godot -e --debug-server tcp://*:8080
2021-08-28 23:58:15 +00:00
} else if (I->get() == "--debug-server") {
if (I->next()) {
debug_server_uri = I->next()->get();
String: Add contains().
2022-02-03 16:03:38 +00:00
if (!debug_server_uri.contains("://")) { // wrong address
[Editor] Add "--debug-server <uri>" option. Allow starting the editor debugger server for the given protocol (and optionally bound to the given ip/port combination: godot -e --debug-server tcp://*:8080
2021-08-28 23:58:15 +00:00
OS::get_singleton()->print("Invalid debug server uri. It should be of the form <protocol>://<bind_address>:<port>.\n");
goto error;
}
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing remote debug server uri, aborting.\n");
goto error;
}
Added an auto quit and auto build flag to the command line options.
2018-02-14 15:23:04 +00:00
} else if (I->get() == "--build-solutions") { // Build the scripting solution such C#
auto_build_solutions = true;
The build-solutions flag now forces editor mode.
2018-06-15 22:08:59 +00:00
editor = true;
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
cmdline_tool = true;
Implement a way to dump the gdnative_interface.h file from the executable
2022-10-12 14:21:34 +00:00
} else if (I->get() == "--dump-gdextension-interface") {
// Register as an editor instance to use low-end fallback if relevant.
editor = true;
cmdline_tool = true;
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
dump_gdextension_interface = true;
print_line("Dumping GDExtension interface header file");
Implement a way to dump the gdnative_interface.h file from the executable
2022-10-12 14:21:34 +00:00
// Hack. Not needed but otherwise we end up detecting that this should
// run the project instead of a cmdline tool.
// Needs full refactoring to fix properly.
main_args.push_back(I->get());
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
} else if (I->get() == "--dump-extension-api") {
// Register as an editor instance to use low-end fallback if relevant.
editor = true;
cmdline_tool = true;
dump_extension_api = true;
Main: Add documentation for `--dump-extension-api`
2021-10-20 10:04:59 +00:00
print_line("Dumping Extension API");
Main: Fixup --dump-extension-api after #54017 That removal was correct, but triggered a bug in our messy-as-heck main.cpp detection logic for editor/project manager/project/command line tool... Fixing this is for another day.
2021-10-21 07:43:39 +00:00
// Hack. Not needed but otherwise we end up detecting that this should
// run the project instead of a cmdline tool.
// Needs full refactoring to fix properly.
main_args.push_back(I->get());
Rename `--export` command line argument to `--export-release` This makes the action of exporting to release mode more explicit.
2022-04-15 15:11:53 +00:00
} else if (I->get() == "--export-release" || I->get() == "--export-debug" ||
clang-format: Disable alignment of operands, too unreliable Sets `AlignOperands` to `DontAlign`. `clang-format` developers seem to mostly care about space-based indentation and every other version of clang-format breaks the bad mismatch of tabs and spaces that it seems to use for operand alignment. So it's better without, so that it respects our two-tabs `ContinuationIndentWidth`.
2021-10-28 13:19:35 +00:00
I->get() == "--export-pack") { // Export project
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
// Actually handling is done in start().
Ensure --export implies --editor Fixes #30149
2019-06-28 12:34:09 +00:00
editor = true;
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
cmdline_tool = true;
main_args.push_back(I->get());
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
} else if (I->get() == "--convert-3to4") {
// Actually handling is done in start().
cmdline_tool = true;
main_args.push_back(I->get());
Speedup conversion and add option to set maximum line length to prevent freezes
2022-08-13 20:17:35 +00:00
if (I->next() && !I->next()->get().begins_with("-")) {
if (itos(I->next()->get().to_int()) == I->next()->get()) {
converter_max_kb_file = I->next()->get().to_int();
}
if (I->next()->next() && !I->next()->next()->get().begins_with("-")) {
if (itos(I->next()->next()->get().to_int()) == I->next()->next()->get()) {
converter_max_line_length = I->next()->next()->get().to_int();
}
}
}
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
} else if (I->get() == "--validate-conversion-3to4") {
// Actually handling is done in start().
cmdline_tool = true;
main_args.push_back(I->get());
Speedup conversion and add option to set maximum line length to prevent freezes
2022-08-13 20:17:35 +00:00
if (I->next() && !I->next()->get().begins_with("-")) {
if (itos(I->next()->get().to_int()) == I->next()->get()) {
converter_max_kb_file = I->next()->get().to_int();
}
if (I->next()->next() && !I->next()->next()->get().begins_with("-")) {
if (itos(I->next()->next()->get().to_int()) == I->next()->next()->get()) {
converter_max_line_length = I->next()->next()->get().to_int();
}
}
}
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
} else if (I->get() == "--doctool") {
// Actually handling is done in start().
cmdline_tool = true;
Make `--doctool` imply `--headless` to speed up class reference generation This also prevents spawning an unnecessary splash screen window while the class reference is generated.
2022-02-17 21:35:37 +00:00
// `--doctool` implies `--headless` to avoid spawning an unnecessary window
// and speed up class reference generation.
audio_driver = "Dummy";
display_driver = "headless";
Ensure --export implies --editor Fixes #30149
2019-06-28 12:34:09 +00:00
main_args.push_back(I->get());
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
#endif
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--path") { // set path of project to start or edit
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
String p = I->next()->get();
Abort running if --path does not exist
2022-07-18 22:27:05 +00:00
if (OS::get_singleton()->set_cwd(p) != OK) {
OS::get_singleton()->print("Invalid project path specified: \"%s\", aborting.\n", p.utf8().get_data());
goto error;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing relative or absolute path, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Made directory scan optional
2017-10-10 12:45:54 +00:00
} else if (I->get() == "-u" || I->get() == "--upwards") { // scan folders upwards
upwards = true;
Make `-q` CLI argument toggle quiet stdout instead of quitting `-q` is a common toggle in a command line applications for quiet mode (see apt or dnf for examples). In contrast, `--quit` isn't needed as often.
2021-12-07 17:06:40 +00:00
} else if (I->get() == "--quit") { // Auto quit at the end of the first main loop iteration
Added an auto quit and auto build flag to the command line options.
2018-02-14 15:23:04 +00:00
auto_quit = true;
Rename project file to "project.godot" Slimmed down variant from the reverted #8375. The rationale behind the name change is to give Godot's project file a unique extension (".godot") that can be registered on the OS to be associated with the Godot binary (OS registration not implemented here). This PR also adds the possibility to start the game or editor if launched with the project.godot passed as argument, which paves the way for allowing a similar behaviour on a double-click in the OS file manager (code originally by @Hinsbart). Closes #6915.
2017-05-01 15:44:52 +00:00
} else if (I->get().ends_with("project.godot")) {
String path;
String file = I->get();
Remove String::find_last (same as rfind)
2020-07-03 13:26:22 +00:00
int sep = MAX(file.rfind("/"), file.rfind("\\"));
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (sep == -1) {
Rename project file to "project.godot" Slimmed down variant from the reverted #8375. The rationale behind the name change is to give Godot's project file a unique extension (".godot") that can be registered on the OS to be associated with the Godot binary (OS registration not implemented here). This PR also adds the possibility to start the game or editor if launched with the project.godot passed as argument, which paves the way for allowing a similar behaviour on a double-click in the OS file manager (code originally by @Hinsbart). Closes #6915.
2017-05-01 15:44:52 +00:00
path = ".";
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
} else {
Rename project file to "project.godot" Slimmed down variant from the reverted #8375. The rationale behind the name change is to give Godot's project file a unique extension (".godot") that can be registered on the OS to be associated with the Godot binary (OS registration not implemented here). This PR also adds the possibility to start the game or editor if launched with the project.godot passed as argument, which paves the way for allowing a similar behaviour on a double-click in the OS file manager (code originally by @Hinsbart). Closes #6915.
2017-05-01 15:44:52 +00:00
path = file.substr(0, sep);
}
if (OS::get_singleton()->set_cwd(path) == OK) {
// path already specified, don't override
} else {
Change reused variable name in command line parsing
2018-05-12 11:21:26 +00:00
project_path = path;
Rename project file to "project.godot" Slimmed down variant from the reverted #8375. The rationale behind the name change is to give Godot's project file a unique extension (".godot") that can be registered on the OS to be associated with the Godot binary (OS registration not implemented here). This PR also adds the possibility to start the game or editor if launched with the project.godot passed as argument, which paves the way for allowing a similar behaviour on a double-click in the OS file manager (code originally by @Hinsbart). Closes #6915.
2017-05-01 15:44:52 +00:00
}
#ifdef TOOLS_ENABLED
editor = true;
#endif
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "-b" || I->get() == "--breakpoints") { // add breakpoints
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
String bplist = I->next()->get();
breakpoints = bplist.split(",");
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing list of breakpoints, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--frame-delay") { // force frame delay
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
removed target_fps option, moved it to debug (it makes no sense for games). Added a frame_delay option for games that don't want to use the CPU fully.
2016-07-09 15:34:30 +00:00
frame_delay = I->next()->get().to_int();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing frame delay argument, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
}
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--time-scale") { // force time scale
Fixed too many little issues, check the issues closed today.
2014-09-21 04:43:42 +00:00
if (I->next()) {
Make all String float conversion methods be 64-bit
2020-07-24 18:07:57 +00:00
Engine::get_singleton()->set_time_scale(I->next()->get().to_float());
Fixed too many little issues, check the issues closed today.
2014-09-21 04:43:42 +00:00
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing time scale argument, aborting.\n");
Fixed too many little issues, check the issues closed today.
2014-09-21 04:43:42 +00:00
goto error;
}
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--main-pack") {
Misc Fixes ========== -NOTIFICATION_WM_QUIT fixed on android (seems tha way this is reported changed in newer sdk) -WIP implementation of APK Expansion APIs for publishing games larger than 50mb in Play Store -Feaures in the new tutorials are all present in the sourcecode -This (hopefully) should get rid of the animation list order getting corrupted -Improved 3D Scene Importer (Skeletons, Animations and other stuff were not being merged). Anything missing? -In code editor, the automatic syntax checker will only use file_exists() to check preload() else it might freeze the editor too much while typing if the preload is a big resource -Fixed bugs in PolygonPathFinder, stil pending to do a node and a demo
2014-06-28 02:21:45 +00:00
if (I->next()) {
main_pack = I->next()->get();
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing path to main pack file, aborting.\n");
Misc Fixes ========== -NOTIFICATION_WM_QUIT fixed on android (seems tha way this is reported changed in newer sdk) -WIP implementation of APK Expansion APIs for publishing games larger than 50mb in Play Store -Feaures in the new tutorials are all present in the sourcecode -This (hopefully) should get rid of the animation list order getting corrupted -Improved 3D Scene Importer (Skeletons, Animations and other stuff were not being merged). Anything missing? -In code editor, the automatic syntax checker will only use file_exists() to check preload() else it might freeze the editor too much while typing if the preload is a big resource -Fixed bugs in PolygonPathFinder, stil pending to do a node and a demo
2014-06-28 02:21:45 +00:00
goto error;
};
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (I->get() == "-d" || I->get() == "--debug") {
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
debug_uri = "local://";
Keep debug & verbose options after loading project from project manager
2020-07-09 07:32:42 +00:00
OS::get_singleton()->_debug_stdout = true;
Adds ability to debug stringnames * References (which include hash tables) can be profiled with --debug-stringnames
2021-07-20 20:01:18 +00:00
#if defined(DEBUG_ENABLED)
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (I->get() == "--debug-collisions") {
begin work on debugging collisions....
2015-09-19 02:10:58 +00:00
debug_collisions = true;
Add Path2D/3D debug options Add Path2D/3D debug options.
2022-06-15 21:24:06 +00:00
} else if (I->get() == "--debug-paths") {
debug_paths = true;
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--debug-navigation") {
Ability to visually debug geometry visually: -Visible 2D and 3D Shapes, Polygons, Tile collisions, etc. -Visible Navmesh and Navpoly -Visible collision contacts for 2D and 3D as a red point -Customizable colors in project settings
2015-09-20 16:03:46 +00:00
debug_navigation = true;
Adds ability to debug stringnames * References (which include hash tables) can be profiled with --debug-stringnames
2021-07-20 20:01:18 +00:00
} else if (I->get() == "--debug-stringnames") {
StringName::set_debug_stringnames(true);
Optimize-out some debug and/or non-tools methods Collisions and nav debug are conditionally compiled depending on DEBUG_ENABLED is_editor_hint() and is_node_being_edited() are compiled only with TOOLS_ENABLED Every affected method is implemented in the header in case its macro is not present (the getters just returning false and the setters having an empty body) so the compiler can inline and finally no-op-out them as likely as possible. is_node_being_edited() already showed a similar optimization effort and has been adapted to this change. Furthermore, and as a consequence, -debugcol and -debugnav will not work on non-debug (strict release) builds. This can bring a little bit of runtime performance on release and non-tooled builds (less code, so less cycles to spend and maybe more cache friendly).
2017-04-07 14:17:16 +00:00
#endif
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (I->get() == "--remote-debug") {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (I->next()) {
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
debug_uri = I->next()->get();
String: Add contains().
2022-02-03 16:03:38 +00:00
if (!debug_uri.contains("://")) { // wrong address
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print(
"Invalid debug host address, it should be of the form <protocol>://<host/IP>:<port>.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
HTML5 exporter Improvements -Better template handling -Voice support -Stream support
2015-09-10 03:10:54 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing remote debug host address, aborting.\n");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
goto error;
Improve debug focus behavior Fix focusing debugged game on Windows Add re-focusing editor on continue
2016-09-14 02:02:18 +00:00
}
Fix editor re-focus on debugger break on Windows
2022-07-21 19:41:02 +00:00
} else if (I->get() == "--editor-pid") { // not exposed to user
Improve debug focus behavior Fix focusing debugged game on Windows Add re-focusing editor on continue
2016-09-14 02:02:18 +00:00
if (I->next()) {
Fix editor re-focus on debugger break on Windows
2022-07-21 19:41:02 +00:00
editor_pid = I->next()->get().to_int();
Improve debug focus behavior Fix focusing debugged game on Windows Add re-focusing editor on continue
2016-09-14 02:02:18 +00:00
N = I->next()->next();
} else {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
OS::get_singleton()->print("Missing editor PID argument, aborting.\n");
Improve debug focus behavior Fix focusing debugged game on Windows Add re-focusing editor on continue
2016-09-14 02:02:18 +00:00
goto error;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Renderer/Simulator flags Now hopefully with correct code style
2017-08-30 10:40:35 +00:00
} 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;
}
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
} else if (I->get() == "--write-movie") {
if (I->next()) {
Add a Movie Quit On Finish property to AnimationPlayer This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-06-25 23:38:20 +00:00
Engine::get_singleton()->set_write_movie_path(I->next()->get());
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
N = I->next()->next();
if (fixed_fps == -1) {
fixed_fps = 60;
}
OS::get_singleton()->_writing_movie = true;
} else {
OS::get_singleton()->print("Missing write-movie argument, aborting.\n");
goto error;
}
} else if (I->get() == "--disable-vsync") {
disable_vsync = true;
Add --print-fps option to output FPS to stdout Works both for the editor and games. Projects can still use "debug/settings/stdout/print_fps" to enable it permanently. The --print-fps option takes precedence (so works even if the project setting is disabled). That setting is also no longer redefined on the fly based on the verbose flag, that was a mess.
2018-03-21 07:46:05 +00:00
} else if (I->get() == "--print-fps") {
print_fps = true;
Several GI related optimizations and fixes -SDFGI direct light is done over many frames -SDFGI Changed settings for rays/frame -SDFGI Misc optimizations -SDFGI Bug fix on probe scroll -GIProbe was not working, got it to work again -GIProbe dynamic objects were not working, fixed -Added a half size GI option.
2021-01-22 23:50:24 +00:00
} else if (I->get() == "--profile-gpu") {
profile_gpu = true;
Added a crash handler to dump the backtrace on Windows, Linux and OS X
2017-09-08 01:01:49 +00:00
} else if (I->get() == "--disable-crash-handler") {
OS::get_singleton()->disable_crash_handler();
Adds skip-breakpoints feature
2019-07-29 18:09:22 +00:00
} else if (I->get() == "--skip-breakpoints") {
skip_breakpoints = true;
Add startup flag to override XR mode settings
2022-07-24 10:43:30 +00:00
} else if (I->get() == "--xr-mode") {
if (I->next()) {
String xr_mode = I->next()->get().to_lower();
N = I->next()->next();
if (xr_mode == "default") {
XRServer::set_xr_mode(XRServer::XRMODE_DEFAULT);
} else if (xr_mode == "off") {
XRServer::set_xr_mode(XRServer::XRMODE_OFF);
} else if (xr_mode == "on") {
XRServer::set_xr_mode(XRServer::XRMODE_ON);
} else {
OS::get_singleton()->print("Unknown --xr-mode argument \"%s\", aborting.\n", xr_mode.ascii().get_data());
goto error;
}
} else {
OS::get_singleton()->print("Missing --xr-mode argument, aborting.\n");
goto error;
}
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
} else if (I->get() == "--startup-benchmark") {
use_startup_benchmark = true;
} else if (I->get() == "--startup-benchmark-file") {
if (I->next()) {
use_startup_benchmark = true;
startup_benchmark_file = I->next()->get();
N = I->next()->next();
} else {
OS::get_singleton()->print("Missing <path> argument for --startup-benchmark-file <path>.\n");
goto error;
}
Allow `++` as an alternative separator to `--` for user CLI arguments This is required when using `startx` to start a Godot project, as `--` is used by `startx` for its own arguments (and there is no way to escape it).
2022-11-11 17:05:39 +00:00
} else if (I->get() == "--" || I->get() == "++") {
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
adding_user_args = true;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
} else {
Remove dead branch in command line logic
2018-05-12 10:51:41 +00:00
main_args.push_back(I->get());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
I = N;
}
Main: Prevent Project Manager-ception in editor Fixes #34904.
2020-01-10 08:48:03 +00:00
#ifdef TOOLS_ENABLED
if (editor && project_manager) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->print(
"Error: Command line arguments implied opening both editor and project manager, which is not possible. Aborting.\n");
Main: Prevent Project Manager-ception in editor Fixes #34904.
2020-01-10 08:48:03 +00:00
goto error;
}
#endif
Fix deploy with network filesystem Also make some prints only happen in verbose mode.
2018-11-08 17:42:41 +00:00
// Network file system needs to be configured before globals, since globals are based on the
// 'project.godot' file which will only be available through the network if this is enabled
FileAccessNetwork::configure();
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!remotefs.is_empty()) {
Fix deploy with network filesystem Also make some prints only happen in verbose mode.
2018-11-08 17:42:41 +00:00
file_access_network_client = memnew(FileAccessNetworkClient);
int port;
String: Add contains().
2022-02-03 16:03:38 +00:00
if (remotefs.contains(":")) {
Fix deploy with network filesystem Also make some prints only happen in verbose mode.
2018-11-08 17:42:41 +00:00
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);
}
Ignore override.cfg when in editor
2021-11-22 15:10:31 +00:00
if (globals->setup(project_path, main_pack, upwards, editor) == OK) {
Fix warnings seen with warnings=all and recent GCC 8.2.
2019-02-18 19:28:40 +00:00
#ifdef TOOLS_ENABLED
Fix debugger_stdout_settings being ignored
2018-03-15 11:22:10 +00:00
found_project = true;
Fix warnings seen with warnings=all and recent GCC 8.2.
2019-02-18 19:28:40 +00:00
#endif
Fix debugger_stdout_settings being ignored
2018-03-15 11:22:10 +00:00
} else {
#ifdef TOOLS_ENABLED
editor = false;
#else
Improve the error message displayed when the PCK file can't be found This explains what to do if the executable was renamed, which is helpful for people exporting projects.
2020-01-27 23:10:31 +00:00
const String error_msg = "Error: Couldn't load project data at path \"" + project_path + "\". Is the .pck file missing?\nIf you've renamed the executable, the associated .pck file should also be renamed to match the executable's name (without the extension).\n";
Display an alert when attempting to run a project with no main scene This gives visual feedback when not starting Godot from a terminal. This could lead to confusion when placing a Godot binary within a project folder that has no main scene defined.
2021-09-01 14:19:25 +00:00
OS::get_singleton()->print("%s", error_msg.utf8().get_data());
Move `alert` function from `DisplayServer` to `OS`.
2021-07-22 16:23:48 +00:00
OS::get_singleton()->alert(error_msg);
Fix debugger_stdout_settings being ignored
2018-03-15 11:22:10 +00:00
goto error;
#endif
}
Main: Ensure existing of user data dir in `setup()` When it was in `setup2()`, it would arrive too late for the optional file logging feature. Fixes #32488.
2020-06-15 12:32:46 +00:00
// Initialize user data dir.
OS::get_singleton()->ensure_user_data_dir();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
initialize_modules(MODULE_INITIALIZATION_LEVEL_CORE);
Fix extension registration order.
2022-02-16 17:02:38 +00:00
register_core_extensions(); // core extensions must be registered after globals setup and before display
Implement Resource UIDs * Most resource types now have unique identifiers. * Applies to text, binary and imported resources. * File formats reference both by text and UID (when available). UID always has priority. * Resource UIDs are 64 bits for better compatibility with the engine. * Can be represented and used textually, example `uuid://dapwmgsmnl28u`. * A special binary cache file is used and exported, containing the mappings. Example of how it looks: ```GDScript [gd_scene load_steps=2 format=3 uid="uid://dw86wq31afig2"] [ext_resource type="PackedScene" uid="uid://bt36ojelx8q6c" path="res://subscene.scn" id="1_t56hs"] ``` GDScript, shaders and other special resource files can't currently provide UIDs, but this should be doable with special keywords on the files. This will be reserved for future PRs.
2021-07-23 19:01:18 +00:00
ResourceUID::get_singleton()->load_from_cache(); // load UUIDs from cache.
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::INT, "network/limits/debugger/max_chars_per_second", PROPERTY_HINT_RANGE, "0, 4096, 1, or_greater"), 32768);
GLOBAL_DEF(PropertyInfo(Variant::INT, "network/limits/debugger/max_queued_messages", PROPERTY_HINT_RANGE, "0, 8192, 1, or_greater"), 2048);
GLOBAL_DEF(PropertyInfo(Variant::INT, "network/limits/debugger/max_errors_per_second", PROPERTY_HINT_RANGE, "0, 200, 1, or_greater"), 400);
GLOBAL_DEF(PropertyInfo(Variant::INT, "network/limits/debugger/max_warnings_per_second", PROPERTY_HINT_RANGE, "0, 200, 1, or_greater"), 400);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fix editor re-focus on debugger break on Windows
2022-07-21 19:41:02 +00:00
EngineDebugger::initialize(debug_uri, skip_breakpoints, breakpoints, []() {
if (editor_pid) {
DisplayServer::get_singleton()->enable_for_stealing_focus(editor_pid);
}
});
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
if (editor) {
packed_data->set_disabled(true);
Adds editor_hint to Engine class
2017-08-13 14:21:45 +00:00
Engine::get_singleton()->set_editor_hint(true);
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
main_args.push_back("--editor");
Editor: Respect -w command line flag.
2017-12-29 19:10:15 +00:00
if (!init_windowed) {
init_maximized = true;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
window_mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
Editor: Respect -w command line flag.
2017-12-29 19:10:15 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Main: Prevent Project Manager-ception in editor Fixes #34904.
2020-01-10 08:48:03 +00:00
if (!project_manager && !editor) {
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
// If we didn't find a project, we fall back to the project manager.
project_manager = !found_project && !cmdline_tool;
Always detect and use hiDPI in the project manager if needed This makes its hiDPI behavior consistent with the editor.
2018-02-13 17:56:38 +00:00
}
Fix Project Manager crash on exit. Fix editor settings loading / saving by Project Manager.
2022-02-12 19:55:11 +00:00
if (project_manager) {
Engine::get_singleton()->set_project_manager_hint(true);
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
GLOBAL_DEF("debug/file_logging/enable_file_logging", false);
Disable file logging for the project manager Due to `user://` returning the current working directory when no project is open, this caused logs to be written to `$HOME` most of the time. This closes #40305.
2020-07-12 12:22:06 +00:00
// 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).
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
GLOBAL_DEF("debug/file_logging/enable_file_logging.pc", true);
GLOBAL_DEF("debug/file_logging/log_path", "user://logs/godot.log");
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::INT, "debug/file_logging/max_log_files", PROPERTY_HINT_RANGE, "0,20,1,or_greater"), 5);
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
if (!project_manager && !editor && FileAccess::get_create_func(FileAccess::ACCESS_USERDATA) &&
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
GLOBAL_GET("debug/file_logging/enable_file_logging")) {
Disable file logging for the project manager Due to `user://` returning the current working directory when no project is open, this caused logs to be written to `$HOME` most of the time. This closes #40305.
2020-07-12 12:22:06 +00:00
// Don't create logs for the project manager as they would be written to
// the current working directory, which is inconvenient.
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
String base_path = GLOBAL_GET("debug/file_logging/log_path");
int max_files = GLOBAL_GET("debug/file_logging/max_log_files");
Disable file logging for the project manager Due to `user://` returning the current working directory when no project is open, this caused logs to be written to `$HOME` most of the time. This closes #40305.
2020-07-12 12:22:06 +00:00
OS::get_singleton()->add_logger(memnew(RotatedFileLogger(base_path, max_files)));
}
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
if (main_args.size() == 0 && String(GLOBAL_GET("application/run/main_scene")) == "") {
Allow running with a custom resource without a main scene After 3f8a4cc7193e964f716fde2cd28a946669e2d8d6 trying to run an individual scene on a project without a main scene fails. We move the check until after we've determined whether or not we're trying to run an individual scene. We also stop trying to show the project manager if any game pack is found at all, unless the user explicitly asks for the project manager to be shown.
2018-02-26 16:16:29 +00:00
#ifdef TOOLS_ENABLED
if (!editor && !project_manager) {
#endif
Display an alert when attempting to run a project with no main scene This gives visual feedback when not starting Godot from a terminal. This could lead to confusion when placing a Godot binary within a project folder that has no main scene defined.
2021-09-01 14:19:25 +00:00
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);
Allow running with a custom resource without a main scene After 3f8a4cc7193e964f716fde2cd28a946669e2d8d6 trying to run an individual scene on a project without a main scene fails. We move the check until after we've determined whether or not we're trying to run an individual scene. We also stop trying to show the project manager if any game pack is found at all, unless the user explicitly asks for the project manager to be shown.
2018-02-26 16:16:29 +00:00
goto error;
#ifdef TOOLS_ENABLED
}
#endif
}
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
if (editor || project_manager) {
Set editor hint early for Project Manager and Editor We need it in setup() already before initializing the renderer, as it's used to force fallback to GLES2 if GLES3 fails. Fixes #26806.
2019-03-09 00:04:53 +00:00
Engine::get_singleton()->set_editor_hint(true);
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
use_custom_res = false;
Make Input Actions config not affect the editor
2016-06-05 04:19:42 +00:00
input_map->load_default(); //keys for editor
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
} else {
load_from_globals() -> load_from_project_settings()
2020-10-02 07:04:09 +00:00
input_map->load_from_project_settings(); //keys for game
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
}
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
if (bool(GLOBAL_GET("application/run/disable_stdout"))) {
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
quiet_stdout = true;
}
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
if (bool(GLOBAL_GET("application/run/disable_stderr"))) {
Variant memory pools Memory pools via PagedAllocator for Transform2D, Transform3D, Basis and AABB.
2022-05-20 12:28:44 +00:00
CoreGlobals::print_error_enabled = false;
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
};
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (quiet_stdout) {
Variant memory pools Memory pools via PagedAllocator for Transform2D, Transform3D, Basis and AABB.
2022-05-20 12:28:44 +00:00
CoreGlobals::print_line_enabled = false;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
Logger::set_flush_stdout_on_print(GLOBAL_GET("application/run/flush_stdout_on_print"));
Logger: Cache 'flush_stdout_on_print' to improve performance, and works before ProjectSettings starts. ProjectSetting: Now 'application/run/flush_stdout_on_print' requires a restart of the Editor to take effect
2021-02-28 22:26:14 +00:00
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
OS::get_singleton()->set_cmdline(execpath, main_args, user_args);
Revert "Fix extension registration order." This reverts commit 94ef200bab8feb5024b2c64ac14daa24e0c4cc55. This broke extension loading. Fixes #58273.
2022-02-18 13:18:24 +00:00
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
{
String driver_hints = "";
#ifdef VULKAN_ENABLED
driver_hints = "vulkan";
#endif
String default_driver = driver_hints.get_slice(",", 0);
// For now everything defaults to vulkan when available. This can change in future updates.
GLOBAL_DEF("rendering/rendering_device/driver", default_driver);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.windows", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.linuxbsd", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.android", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.ios", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.macos", PROPERTY_HINT_ENUM, driver_hints), default_driver);
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
driver_hints = "";
#ifdef GLES3_ENABLED
driver_hints += "opengl3";
#endif
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
default_driver = driver_hints.get_slice(",", 0);
GLOBAL_DEF("rendering/gl_compatibility/driver", default_driver);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.windows", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.linuxbsd", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.web", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.android", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.ios", PROPERTY_HINT_ENUM, driver_hints), default_driver);
GLOBAL_DEF(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.macos", PROPERTY_HINT_ENUM, driver_hints), default_driver);
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
}
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
// Start with RenderingDevice-based backends. Should be included if any RD driver present.
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
#ifdef VULKAN_ENABLED
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
renderer_hints = "forward_plus,mobile";
Use mobile as the default rendering method on mobile when vulkan is supported
2022-09-30 02:16:13 +00:00
default_renderer_mobile = "mobile";
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
#endif
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
// And Compatibility next, or first if Vulkan is disabled.
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
#ifdef GLES3_ENABLED
if (!renderer_hints.is_empty()) {
renderer_hints += ",";
}
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
renderer_hints += "gl_compatibility";
Use mobile as the default rendering method on mobile when vulkan is supported
2022-09-30 02:16:13 +00:00
if (default_renderer_mobile.is_empty()) {
default_renderer_mobile = "gl_compatibility";
}
Default to Opengl3 driver when using the project manager This only applies when starting the project manager without command line args
2022-10-18 17:42:54 +00:00
// Default to Compatibility when using the project manager.
if (rendering_driver.is_empty() && rendering_method.is_empty() && project_manager) {
rendering_driver = "opengl3";
rendering_method = "gl_compatibility";
Enable GLES3 on Android Add necessary build flags and switch from using a GLES2 context to a GLES3 one. This also enables building for OpenXR Co-authored-by: m4gr3d <fhuyakou@gmail.com> Co-authored-by: dsnopek <dsnopek@gmail.com>
2022-11-11 23:30:06 +00:00
default_renderer_mobile = "gl_compatibility";
Default to Opengl3 driver when using the project manager This only applies when starting the project manager without command line args
2022-10-18 17:42:54 +00:00
}
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
#endif
if (renderer_hints.is_empty()) {
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
ERR_PRINT("No renderers available.");
}
if (!rendering_method.is_empty()) {
if (rendering_method != "forward_plus" &&
rendering_method != "mobile" &&
rendering_method != "gl_compatibility") {
OS::get_singleton()->print("Unknown renderer name '%s', aborting. Valid options are: %s\n", rendering_method.utf8().get_data(), renderer_hints.utf8().get_data());
goto error;
}
}
if (!rendering_driver.is_empty()) {
// As the rendering drivers available may depend on the display driver and renderer
// selected, we can't do an exhaustive check here, but we can look through all
// the options in all the display drivers for a match.
bool found = false;
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
Vector<String> r_drivers = DisplayServer::get_create_function_rendering_drivers(i);
for (int d = 0; d < r_drivers.size(); d++) {
if (rendering_driver == r_drivers[d]) {
found = true;
break;
}
}
}
if (!found) {
OS::get_singleton()->print("Unknown rendering driver '%s', aborting.\nValid options are ",
rendering_driver.utf8().get_data());
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
Vector<String> r_drivers = DisplayServer::get_create_function_rendering_drivers(i);
for (int d = 0; d < r_drivers.size(); d++) {
OS::get_singleton()->print("'%s', ", r_drivers[d].utf8().get_data());
}
}
OS::get_singleton()->print(".\n");
goto error;
}
// Set a default renderer if none selected. Try to choose one that matches the driver.
if (rendering_method.is_empty()) {
if (rendering_driver == "opengl3") {
rendering_method = "gl_compatibility";
} else {
rendering_method = "forward_plus";
}
}
// Now validate whether the selected driver matches with the renderer.
bool valid_combination = false;
Vector<String> available_drivers;
Fix build with Vulkan disabled and no Vulkan headers installed.
2022-10-25 19:20:54 +00:00
#ifdef VULKAN_ENABLED
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
if (rendering_method == "forward_plus" || rendering_method == "mobile") {
available_drivers.push_back("vulkan");
Fix build with Vulkan disabled and no Vulkan headers installed.
2022-10-25 19:20:54 +00:00
}
#endif
#ifdef GLES3_ENABLED
if (rendering_method == "gl_compatibility") {
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
available_drivers.push_back("opengl3");
Fix build with Vulkan disabled and no Vulkan headers installed.
2022-10-25 19:20:54 +00:00
}
#endif
if (available_drivers.is_empty()) {
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
OS::get_singleton()->print("Unknown renderer name '%s', aborting.\n", rendering_method.utf8().get_data());
goto error;
}
for (int i = 0; i < available_drivers.size(); i++) {
if (rendering_driver == available_drivers[i]) {
valid_combination = true;
break;
}
}
if (!valid_combination) {
OS::get_singleton()->print("Invalid renderer/driver combination '%s' and '%s', aborting. %s only supports the following drivers ", rendering_method.utf8().get_data(), rendering_driver.utf8().get_data(), rendering_method.utf8().get_data());
for (int d = 0; d < available_drivers.size(); d++) {
OS::get_singleton()->print("'%s', ", available_drivers[d].utf8().get_data());
}
OS::get_singleton()->print(".\n");
goto error;
}
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
}
default_renderer = renderer_hints.get_slice(",", 0);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF_RST_BASIC(PropertyInfo(Variant::STRING, "rendering/renderer/rendering_method", PROPERTY_HINT_ENUM, renderer_hints), default_renderer);
Use mobile as the default rendering method on mobile when vulkan is supported
2022-09-30 02:16:13 +00:00
GLOBAL_DEF_RST_BASIC("rendering/renderer/rendering_method.mobile", default_renderer_mobile);
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
GLOBAL_DEF_RST_BASIC("rendering/renderer/rendering_method.web", "gl_compatibility"); // This is a bit of a hack until we have WebGPU support.
opengl3 driver now works on windows including multi window fixed and simplified gl_manager_windows swap buffers now called for all windows fixed missing pixel format setting in additional windows this makes them work in OpenGL contexts changed verbose error printing to write once this error message happens very frequently while opengl3 is not finished removed dead code no longer needed after changes fixed comments that were misinformation window messages during window creation now handled these were previously discarded messages now tunnel the required context changed failure to create opengl3 window on windows to be more fatal marked a problem with pen code conditional compilation of vulkan and opengl3 on windows fixed windows debug builds now show messages on debug console also rendering driver selection box now shows only compiled drivers marked some problematic code thanks to akien-mga for patiently rewriting my style mistakes
2022-05-08 23:25:49 +00:00
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
// Default to ProjectSettings default if nothing set on the command line.
if (rendering_method.is_empty()) {
rendering_method = GLOBAL_GET("rendering/renderer/rendering_method");
}
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (rendering_driver.is_empty()) {
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
if (rendering_method == "gl_compatibility") {
rendering_driver = GLOBAL_GET("rendering/gl_compatibility/driver");
} else {
rendering_driver = GLOBAL_GET("rendering/rendering_device/driver");
}
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
}
// note this is the desired rendering driver, it doesn't mean we will get it.
// TODO - make sure this is updated in the case of fallbacks, so that the user interface
// shows the correct driver string.
OS::get_singleton()->set_current_rendering_driver_name(rendering_driver);
Split rendering driver project setting into renderer_name and rendering_driver. To differentiate between a driver (e.g. Vulkan or D3D12) and a renderer (e.g. clustered or mobile renderer).
2022-09-08 00:44:36 +00:00
OS::get_singleton()->set_current_rendering_method(rendering_method);
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
Rename GLES2 driver to OpenGL to prepare for the upgrade to GLES3 - Use lowercase driver names for the `--rendering-driver` command line argument.
2021-09-26 23:07:10 +00:00
// always convert to lower case for consistency in the code
rendering_driver = rendering_driver.to_lower();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Make video mode initialization more intuitive, fixes #12022
2017-11-09 16:01:29 +00:00
if (use_custom_res) {
if (!force_res) {
Rename Project Window width and height settings to match their function
2021-03-31 11:50:24 +00:00
window_size.width = GLOBAL_GET("display/window/size/viewport_width");
window_size.height = GLOBAL_GET("display/window/size/viewport_height");
if (globals->has_setting("display/window/size/window_width_override") &&
globals->has_setting("display/window/size/window_height_override")) {
int desired_width = globals->get("display/window/size/window_width_override");
if (desired_width > 0) {
window_size.width = desired_width;
Make possible to use just one "size/test_*" value in the settings
2019-10-04 13:26:02 +00:00
}
Rename Project Window width and height settings to match their function
2021-03-31 11:50:24 +00:00
int desired_height = globals->get("display/window/size/window_height_override");
if (desired_height > 0) {
window_size.height = desired_height;
Make video mode initialization more intuitive, fixes #12022
2017-11-09 16:01:29 +00:00
}
}
3D Physics Rework, Other Stuff -=-=-=-=-=-=-=-=-=-=-=-=-=- 3D Physics: -Fixed "Bounce" parameter in 3D -Fixed bug affecting Area (sometims it would not detect properly) -Vehicle Body has seen heavy work -Added Query API for doing space queries in 3D. Needs some docs though. -Added JOINTS! Adapted Bullet Joints: and created easy gizmos for setting them up: -PinJoint -HingeJoint (with motor) -SliderJoint -ConeTwistJoint -Generic6DOFJoint -Added OBJECT PICKING! based on the new query API. Any physics object now (Area or Body) has the following signals and virtual functions: -input_event (mouse or multitouch input over the body) -mouse_enter (mouse entered the body area) -mouse_exit (mouse exited body area) For Area it needs to be activated manually, as it isn't by default (ray goes thru). Other: -Begun working on Windows 8 (RT) port. Compiles but does not work yet. -Added TheoraPlayer library for improved to-texture and portable video support. -Fixed a few bugs in the renderer, collada importer, collada exporter, etc.
2014-09-15 14:33:30 +00:00
}
Make video mode initialization more intuitive, fixes #12022
2017-11-09 16:01:29 +00:00
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
if (!bool(GLOBAL_GET("display/window/size/resizable"))) {
window_flags |= DisplayServer::WINDOW_FLAG_RESIZE_DISABLED_BIT;
}
if (bool(GLOBAL_GET("display/window/size/borderless"))) {
window_flags |= DisplayServer::WINDOW_FLAG_BORDERLESS_BIT;
}
if (bool(GLOBAL_GET("display/window/size/always_on_top"))) {
Fix "on top" incorrectly set on init (all platforms). Fix "on top" reseting on window update. (macOS).
2020-08-15 14:53:06 +00:00
window_flags |= DisplayServer::WINDOW_FLAG_ALWAYS_ON_TOP_BIT;
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
}
Add missing initial window flags and window mode to the project settings.
2022-09-15 07:05:41 +00:00
if (bool(GLOBAL_GET("display/window/size/transparent"))) {
window_flags |= DisplayServer::WINDOW_FLAG_TRANSPARENT_BIT;
}
if (bool(GLOBAL_GET("display/window/size/extend_to_title"))) {
window_flags |= DisplayServer::WINDOW_FLAG_EXTEND_TO_TITLE_BIT;
}
if (bool(GLOBAL_GET("display/window/size/no_focus"))) {
window_flags |= DisplayServer::WINDOW_FLAG_NO_FOCUS_BIT;
}
window_mode = (DisplayServer::WindowMode)(GLOBAL_GET("display/window/size/mode").operator int());
Reorganize main and sub-window initial position properties.
2023-01-19 08:28:53 +00:00
int initial_position_type = GLOBAL_GET("display/window/size/initial_position_type").operator int();
if (initial_position_type == 0) {
if (!init_use_custom_pos) {
init_custom_pos = GLOBAL_GET("display/window/size/initial_position").operator Vector2i();
init_use_custom_pos = true;
}
} else if (initial_position_type == 1) {
if (!init_use_custom_screen) {
init_screen = DisplayServer::SCREEN_PRIMARY;
init_use_custom_screen = true;
}
} else if (initial_position_type == 2) {
if (!init_use_custom_screen) {
init_screen = GLOBAL_GET("display/window/size/initial_screen").operator int();
init_use_custom_screen = true;
}
}
3D Physics Rework, Other Stuff -=-=-=-=-=-=-=-=-=-=-=-=-=- 3D Physics: -Fixed "Bounce" parameter in 3D -Fixed bug affecting Area (sometims it would not detect properly) -Vehicle Body has seen heavy work -Added Query API for doing space queries in 3D. Needs some docs though. -Added JOINTS! Adapted Bullet Joints: and created easy gizmos for setting them up: -PinJoint -HingeJoint (with motor) -SliderJoint -ConeTwistJoint -Generic6DOFJoint -Added OBJECT PICKING! based on the new query API. Any physics object now (Area or Body) has the following signals and virtual functions: -input_event (mouse or multitouch input over the body) -mouse_enter (mouse entered the body area) -mouse_exit (mouse exited body area) For Area it needs to be activated manually, as it isn't by default (ray goes thru). Other: -Begun working on Windows 8 (RT) port. Compiles but does not work yet. -Added TheoraPlayer library for improved to-texture and portable video support. -Fixed a few bugs in the renderer, collada importer, collada exporter, etc.
2014-09-15 14:33:30 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
ICU: Update to version 69.1, improve ICU data export process.
2021-04-22 12:08:59 +00:00
GLOBAL_DEF("internationalization/locale/include_text_server_data", false);
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
Enable "Allow Hidpi" by default This fixes window management issues across platforms on hiDPI monitors. The `--low-dpi` command line argument has been removed as similar functionality (forcing low-DPI mode on DPI-aware programs) is already provided by Windows and macOS itself.
2021-12-29 01:21:06 +00:00
OS::get_singleton()->_allow_hidpi = GLOBAL_DEF("display/window/dpi/allow_hidpi", true);
Re-enable per-pixel transparency support on Linux, macOS, and Windows (for Vulkan and OpenGL rendering drivers).
2022-09-03 10:40:53 +00:00
OS::get_singleton()->_allow_layered = GLOBAL_DEF("display/window/per_pixel_transparency/allowed", false);
clang-format: Various fixes to comments alignment from `clang-format` 13 All reviewed manually and occasionally rewritten to avoid bad auto formatting.
2021-10-28 13:43:36 +00:00
Force disable Vulkan overlays in the editor and project manager MangoHud would be shown on every popup in multi-window mode, and seemed to cause rendering issues for various users. There are also issues with RTSS, and VkBasalt also doesn't seem particularly good to use in the editor. All these stay available to enable when running the project itself, including running from the editor (so running the editor after e.g. `export MANGOHUD=1` in the environment will ignore it for the editor, but use it when playing the project). Fixes #57403. Fixes #57937.
2023-01-16 13:38:14 +00:00
#ifdef TOOLS_ENABLED
Always detect and use hiDPI in the project manager if needed This makes its hiDPI behavior consistent with the editor.
2018-02-13 17:56:38 +00:00
if (editor || project_manager) {
Force disable Vulkan overlays in the editor and project manager MangoHud would be shown on every popup in multi-window mode, and seemed to cause rendering issues for various users. There are also issues with RTSS, and VkBasalt also doesn't seem particularly good to use in the editor. All these stay available to enable when running the project itself, including running from the editor (so running the editor after e.g. `export MANGOHUD=1` in the environment will ignore it for the editor, but use it when playing the project). Fixes #57403. Fixes #57937.
2023-01-16 13:38:14 +00:00
// The editor and project manager always detect and use hiDPI if needed.
Always detect and use hiDPI in the project manager if needed This makes its hiDPI behavior consistent with the editor.
2018-02-13 17:56:38 +00:00
OS::get_singleton()->_allow_hidpi = true;
Force disable Vulkan overlays in the editor and project manager MangoHud would be shown on every popup in multi-window mode, and seemed to cause rendering issues for various users. There are also issues with RTSS, and VkBasalt also doesn't seem particularly good to use in the editor. All these stay available to enable when running the project itself, including running from the editor (so running the editor after e.g. `export MANGOHUD=1` in the environment will ignore it for the editor, but use it when playing the project). Fixes #57403. Fixes #57937.
2023-01-16 13:38:14 +00:00
// Disable Vulkan overlays in editor, they cause various issues.
OS::get_singleton()->set_environment("DISABLE_MANGOHUD", "1"); // GH-57403.
OS::get_singleton()->set_environment("DISABLE_RTSS_LAYER", "1"); // GH-57937.
OS::get_singleton()->set_environment("DISABLE_VKBASALT", "1");
} else {
// Re-allow using Vulkan overlays, disabled while using the editor.
OS::get_singleton()->unset_environment("DISABLE_MANGOHUD");
OS::get_singleton()->unset_environment("DISABLE_RTSS_LAYER");
OS::get_singleton()->unset_environment("DISABLE_VKBASALT");
Make sure to obey hidpi to off by default, as present in project settings. Set it to on by default for editor. Many integrated GPUs can't really get enough performance to play games at hidpi, so this should be enabled manually.
2017-10-05 19:41:42 +00:00
}
Force disable Vulkan overlays in the editor and project manager MangoHud would be shown on every popup in multi-window mode, and seemed to cause rendering issues for various users. There are also issues with RTSS, and VkBasalt also doesn't seem particularly good to use in the editor. All these stay available to enable when running the project itself, including running from the editor (so running the editor after e.g. `export MANGOHUD=1` in the environment will ignore it for the editor, but use it when playing the project). Fixes #57403. Fixes #57937.
2023-01-16 13:38:14 +00:00
#endif
Always detect and use hiDPI in the project manager if needed This makes its hiDPI behavior consistent with the editor.
2018-02-13 17:56:38 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (rtm == -1) {
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
rtm = GLOBAL_DEF("rendering/driver/threads/thread_model", OS::RENDER_THREAD_SAFE);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
force thread model to single-safe when running editor, fixes #2387
2015-12-31 19:24:27 +00:00
if (rtm >= 0 && rtm < 3) {
if (editor) {
rtm = OS::RENDER_THREAD_SAFE;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->_render_thread_mode = OS::RenderThreadMode(rtm);
force thread model to single-safe when running editor, fixes #2387
2015-12-31 19:24:27 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
/* Determine audio and video drivers */
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
// Display driver, e.g. X11, Wayland.
DisplayServer: Don't fallback to headless Unless users requested the headless driver specifically, they expect to either see a window, or that the process terminates if there's an error. Currently it would fallback to headless so they'd unexpectedly get a valid headless instance if their DisplayServer failed initializing (e.g. missing Vulkan support). Fixes #58414.
2022-06-30 13:41:19 +00:00
// Make sure that headless is the last one, which it is assumed to be by design.
DEV_ASSERT(String("headless") == DisplayServer::get_create_function_name(DisplayServer::get_create_function_count() - 1));
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < DisplayServer::get_create_function_count(); i++) {
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
String name = DisplayServer::get_create_function_name(i);
if (display_driver == name) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
display_driver_idx = i;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
break;
}
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
if (display_driver_idx < 0) {
DisplayServer: Don't fallback to headless Unless users requested the headless driver specifically, they expect to either see a window, or that the process terminates if there's an error. Currently it would fallback to headless so they'd unexpectedly get a valid headless instance if their DisplayServer failed initializing (e.g. missing Vulkan support). Fixes #58414.
2022-06-30 13:41:19 +00:00
// If the requested driver wasn't found, pick the first entry.
// If all else failed it would be the headless server.
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
display_driver_idx = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
// Store this in a globally accessible place, so we can retrieve the rendering drivers
// list from the display driver for the editor UI.
OS::get_singleton()->set_display_driver_id(display_driver_idx);
doctool: Fix differences between headless and Vulkan rendering backends Fixes #53913.
2021-10-20 14:37:19 +00:00
GLOBAL_DEF_RST_NOVAL("audio/driver/driver", AudioDriverManager::get_driver(0)->get_name());
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (audio_driver.is_empty()) { // Specified in project.godot.
doctool: Fix differences between headless and Vulkan rendering backends Fixes #53913.
2021-10-20 14:37:19 +00:00
audio_driver = GLOBAL_GET("audio/driver/driver");
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
}
DisplayServer: Don't fallback to headless Unless users requested the headless driver specifically, they expect to either see a window, or that the process terminates if there's an error. Currently it would fallback to headless so they'd unexpectedly get a valid headless instance if their DisplayServer failed initializing (e.g. missing Vulkan support). Fixes #58414.
2022-06-30 13:41:19 +00:00
// Make sure that dummy is the last one, which it is assumed to be by design.
DEV_ASSERT(String("Dummy") == AudioDriverManager::get_driver(AudioDriverManager::get_driver_count() - 1)->get_name());
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
if (audio_driver == AudioDriverManager::get_driver(i)->get_name()) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
audio_driver_idx = i;
break;
}
}
if (audio_driver_idx < 0) {
DisplayServer: Don't fallback to headless Unless users requested the headless driver specifically, they expect to either see a window, or that the process terminates if there's an error. Currently it would fallback to headless so they'd unexpectedly get a valid headless instance if their DisplayServer failed initializing (e.g. missing Vulkan support). Fixes #58414.
2022-06-30 13:41:19 +00:00
// If the requested driver wasn't found, pick the first entry.
// If all else failed it would be the dummy driver (no sound).
audio_driver_idx = 0;
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
}
Add a Movie Quit On Finish property to AnimationPlayer This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-06-25 23:38:20 +00:00
if (Engine::get_singleton()->get_write_movie_path() != String()) {
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
// Always use dummy driver for audio driver (which is last), also in no threaded mode.
audio_driver_idx = AudioDriverManager::get_driver_count() - 1;
AudioDriverDummy::get_dummy_singleton()->set_use_threads(false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
{
Use an enum to represent screen orientation in the Project Settings - Tweak the setting property hint to be more informative. - Make the setting a "basic" setting so it appears when Advanced Settings is disabled. - Remove redundant orientation setting in the iOS export preset. The project setting is now used (like on Android). Projects upgrading from a previous version will have to set the screen orientation again in the Project Settings if it wasn't set to the default value ("landscape").
2021-05-21 19:29:24 +00:00
window_orientation = DisplayServer::ScreenOrientation(int(GLOBAL_DEF_BASIC("display/window/handheld/orientation", DisplayServer::ScreenOrientation::SCREEN_LANDSCAPE)));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
{
Change VSync mode project setting enum type from string to integer
2021-07-12 01:35:51 +00:00
window_vsync_mode = DisplayServer::VSyncMode(int(GLOBAL_DEF("display/window/vsync/vsync_mode", DisplayServer::VSyncMode::VSYNC_ENABLED)));
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
if (disable_vsync) {
window_vsync_mode = DisplayServer::VSyncMode::VSYNC_DISABLED;
}
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
}
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
Engine::get_singleton()->set_physics_ticks_per_second(GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "physics/common/physics_ticks_per_second", PROPERTY_HINT_RANGE, "1,1000,1"), 60));
Engine::get_singleton()->set_max_physics_steps_per_frame(GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "physics/common/max_physics_steps_per_frame", PROPERTY_HINT_RANGE, "1,100,1"), 8));
Add hysteresis to physics timestep count per frame Add new class _TimerSync to manage timestep calculations. The new class handles the decisions about simulation progression previously handled by main::iteration(). It is fed the current timer ticks and determines how many physics updates are to be run and what the delta argument to the _process() functions should be. The new class tries to keep the number of physics updates per frame as constant as possible from frame to frame. Ideally, it would be N steps every render frame, but even with perfectly regular rendering, the general case is that N or N+1 steps are required per frame, for some fixed N. The best guess for N is stored in typical_physics_steps. When determining the number of steps to take, no restrictions are imposed between the choice of typical_physics_steps and typical_physics_steps+1 steps. Should more or less steps than that be required, the accumulated remaining time (as before, stored in time_accum) needs to surpass its boundaries by some minimal threshold. Once surpassed, typical_physics_steps is updated to allow the new step count for future updates. Care is taken that the modified calculation of the number of physics steps is not observable from game code that only checks the delta parameters to the _process and _physics_process functions; in addition to modifying the number of steps, the _process argument is modified as well to stay in expected bounds. Extra care is taken that the accumulated steps still sum up to roughly the real elapsed time, up to a maximum tolerated difference. To allow the hysteresis code to work correctly on higher refresh monitors, the number of typical physics steps is not only recorded and kept consistent for single render frames, but for groups of them. Currently, up to 12 frames are grouped that way. The engine parameter physics_jitter_fix controls both the maximum tolerated difference between wall clock time and summed up _process arguments and the threshold for changing typical_physics_steps. It is given in units of the real physics frame slice 1/physics_fps. Set physics_jitter_fix to 0 to disable the effects of the new code here. It starts to be effective against the random physics jitter at around 0.02 to 0.05. at values greater than 1 it starts having ill effects on the engine's ability to react sensibly to dropped frames and framerate changes.
2018-02-10 23:03:31 +00:00
Engine::get_singleton()->set_physics_jitter_fix(GLOBAL_DEF("physics/common/physics_jitter_fix", 0.5));
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
Engine::get_singleton()->set_max_fps(GLOBAL_DEF(PropertyInfo(Variant::INT, "application/run/max_fps", PROPERTY_HINT_RANGE, "0,1000,1"), 0));
-Changed most project settings in the engine, so they have major and minor categories. -Changed SectionedPropertyEditor to support this -Renamed Globals singleton to GlobalConfig, makes more sense. -Changed the logic behind persisten global settings, instead of the persist checkbox, a revert button is now available
2017-01-05 12:16:00 +00:00
Add --print-fps option to output FPS to stdout Works both for the editor and games. Projects can still use "debug/settings/stdout/print_fps" to enable it permanently. The --print-fps option takes precedence (so works even if the project setting is disabled). That setting is also no longer redefined on the fly based on the verbose flag, that was a mess.
2018-03-21 07:46:05 +00:00
GLOBAL_DEF("debug/settings/stdout/print_fps", false);
Fixes and optimizations to mobile renderer * Only apply final actions to attachments used in the last pass. * Fixes to draw list final action (was using continue instead of read/drop). * Profiling regions inside draw lists now properly throw errors. * Ability to enable gpu profile printing from project settings. (used to debug).
2021-08-11 00:50:28 +00:00
GLOBAL_DEF("debug/settings/stdout/print_gpu_profile", false);
DocData: Skip unexposed classes Properly expose classes that we actually want accessible.
2020-04-20 10:29:34 +00:00
GLOBAL_DEF("debug/settings/stdout/verbose_stdout", false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
DocData: Skip unexposed classes Properly expose classes that we actually want accessible.
2020-04-20 10:29:34 +00:00
if (!OS::get_singleton()->_verbose_stdout) { // Not manually overridden.
OS::get_singleton()->_verbose_stdout = GLOBAL_GET("debug/settings/stdout/verbose_stdout");
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
removed target_fps option, moved it to debug (it makes no sense for games). Added a frame_delay option for games that don't want to use the CPU fully.
2016-07-09 15:34:30 +00:00
if (frame_delay == 0) {
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
frame_delay = GLOBAL_DEF(PropertyInfo(Variant::INT, "application/run/frame_delay_msec", PROPERTY_HINT_RANGE, "0,100,1,or_greater"), 0);
removed target_fps option, moved it to debug (it makes no sense for games). Added a frame_delay option for games that don't want to use the CPU fully.
2016-07-09 15:34:30 +00:00
}
Modified low processor sleep to 8000 and made it customizable (should be customizable for editor too)
2017-11-22 17:40:43 +00:00
OS::get_singleton()->set_low_processor_usage_mode(GLOBAL_DEF("application/run/low_processor_mode", false));
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::INT, "application/run/low_processor_mode_sleep_usec", PROPERTY_HINT_RANGE, "0,33200,1,or_greater"), 6900)); // Roughly 144 FPS
Modified low processor sleep to 8000 and made it customizable (should be customizable for editor too)
2017-11-22 17:40:43 +00:00
Add ProMotion Support to iOS Exports
2022-10-30 03:31:13 +00:00
GLOBAL_DEF("display/window/ios/allow_high_refresh_rate", true);
Add project setting to hide home indicator on iOS On iOS devices without a physical home button iOS shows a home indicator instead. This is often in the way of the UI or the game. Added a project setting to disable hidden home indicator. The default value is to hide the home indicator
2019-12-09 19:38:22 +00:00
GLOBAL_DEF("display/window/ios/hide_home_indicator", true);
Add iOS UI Options
2022-10-12 19:17:36 +00:00
GLOBAL_DEF("display/window/ios/hide_status_bar", true);
GLOBAL_DEF("display/window/ios/suppress_ui_gesture", true);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "input_devices/pointing/ios/touch_delay", PROPERTY_HINT_RANGE, "0,1,0.001"), 0.15);
Add project setting to hide home indicator on iOS On iOS devices without a physical home button iOS shows a home indicator instead. This is often in the way of the UI or the game. Added a project setting to disable hidden home indicator. The default value is to hide the home indicator
2019-12-09 19:38:22 +00:00
Move OpenXR project settings to the main, to make them visible on unsupported platforms.
2022-03-25 07:27:46 +00:00
// XR project settings.
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
GLOBAL_DEF_RST_BASIC("xr/openxr/enabled", false);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "xr/openxr/default_action_map", PROPERTY_HINT_FILE, "*.tres"), "res://openxr_action_map.tres");
GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "xr/openxr/form_factor", PROPERTY_HINT_ENUM, "Head Mounted,Handheld"), "0");
GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "xr/openxr/view_configuration", PROPERTY_HINT_ENUM, "Mono,Stereo"), "1"); // "Mono,Stereo,Quad,Observer"
GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "xr/openxr/reference_space", PROPERTY_HINT_ENUM, "Local,Stage"), "1");
Move OpenXR project settings to the main, to make them visible on unsupported platforms.
2022-03-25 07:27:46 +00:00
Make submitting depth buffer in OpenXR optional
2022-12-06 11:20:51 +00:00
GLOBAL_DEF_BASIC("xr/openxr/submit_depth_buffer", false);
Move OpenXR project settings to the main, to make them visible on unsupported platforms.
2022-03-25 07:27:46 +00:00
#ifdef TOOLS_ENABLED
// Disabled for now, using XR inside of the editor we'll be working on during the coming months.
// editor settings (it seems we're too early in the process when setting up rendering, to access editor settings...)
// EDITOR_DEF_RST("xr/openxr/in_editor", false);
// GLOBAL_DEF("xr/openxr/in_editor", false);
#endif
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
Engine::get_singleton()->set_frame_delay(frame_delay);
removed target_fps option, moved it to debug (it makes no sense for games). Added a frame_delay option for games that don't want to use the CPU fully.
2016-07-09 15:34:30 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
message_queue = memnew(MessageQueue);
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
engine->startup_benchmark_end_measure(); // core
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (p_second_phase) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
return setup2();
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
return OK;
error:
remove trailing whitespace
2016-03-08 23:00:52 +00:00
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
text_driver = "";
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
display_driver = "";
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
audio_driver = "";
[Windows] Add tablet driver selection.
2020-05-19 20:34:26 +00:00
tablet_driver = "";
Add a Movie Quit On Finish property to AnimationPlayer This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-06-25 23:38:20 +00:00
Engine::get_singleton()->set_write_movie_path(String());
Change reused variable name in command line parsing
2018-05-12 11:21:26 +00:00
project_path = "";
remove trailing whitespace
2016-03-08 23:00:52 +00:00
args.clear();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
main_args.clear();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (show_help) {
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
print_help(execpath);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
EngineDebugger::deinitialize();
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (performance) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(performance);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (input_map) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(input_map);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Add Time singleton
2021-05-24 11:54:05 +00:00
if (time_singleton) {
memdelete(time_singleton);
}
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (translation_server) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(translation_server);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (globals) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(globals);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (engine) {
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
memdelete(engine);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (packed_data) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(packed_data);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (file_access_network_client) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(file_access_network_client);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
-Changed Godot exit to be clean. -Added more debug information on memory cleanliness on exit (if run with -v) -Fixed several memory leaks, fixes #1731, fixes #755
2015-04-20 22:38:02 +00:00
Fixing memleaks in main/main.cpp
2015-10-30 11:56:07 +00:00
unregister_core_driver_types();
Fix extension registration order.
2022-02-16 17:02:38 +00:00
unregister_core_extensions();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
unregister_core_types();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->_cmdline.clear();
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
OS::get_singleton()->_user_args.clear();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (message_queue) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(message_queue);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->finalize_core();
locale = String();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Command line arguments '--version' and '--help' return exit code 0 instead of 255 Allows to detect whether those commands executed successfully, which makes integration with shell scripts/CI/bindings straightforward.
2022-06-30 11:55:15 +00:00
return exit_code;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Fix Android remote debug not hitting breakpoints A change in `Main`'s API is needed. Please read the comment in the diff for an explanation.
2017-08-22 15:21:41 +00:00
Error Main::setup2(Thread::ID p_main_tid_override) {
Main::setup2 move print engine version to top
2022-11-16 15:05:00 +00:00
// Print engine name and version
print_line(String(VERSION_NAME) + " v" + get_full_version_string() + " - " + String(VERSION_WEBSITE));
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
engine->startup_benchmark_begin_measure("servers");
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
tsman = memnew(TextServerManager);
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
if (tsman) {
Ref<TextServerDummy> ts;
ts.instantiate();
tsman->add_interface(ts);
}
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
physics_server_3d_manager = memnew(PhysicsServer3DManager);
physics_server_2d_manager = memnew(PhysicsServer2DManager);
Change Server initialization order * Registration of server classes happened after Display initialization. * This made no sense in practice and avoided the registration of custom server drivers (like custom XR server, custom Rendering server, custom XR server). * Initialization moved to _before_ Display.
2022-05-26 12:51:42 +00:00
register_server_types();
initialize_modules(MODULE_INITIALIZATION_LEVEL_SERVERS);
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->initialize_extensions(GDExtension::INITIALIZATION_LEVEL_SERVERS);
Moved the shader source compilation code outside RenderingDevice and Vulkan
2019-07-28 22:58:32 +00:00
Fix Android remote debug not hitting breakpoints A change in `Main`'s API is needed. Please read the comment in the diff for an explanation.
2017-08-22 15:21:41 +00:00
if (p_main_tid_override) {
Modernize Thread - Based on C++11's `thread` and `thread_local` - No more need to allocate-deallocate or check for null - No pointer anymore, just a member variable - Platform-specific implementations no longer needed (except for the few cases of non-portable functions) - Simpler for `NO_THREADS` - Thread ids are now the same across platforms (main is 1; others follow)
2021-01-19 12:29:41 +00:00
Thread::main_thread_id = p_main_tid_override;
Fix Android remote debug not hitting breakpoints A change in `Main`'s API is needed. Please read the comment in the diff for an explanation.
2017-08-22 15:21:41 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Implement shader caching * Shader compilation is now cached. Subsequent loads take less than a millisecond. * Improved game, editor and project manager startup time. * Editor uses .godot/shader_cache to store shaders. * Game uses user://shader_cache * Project manager uses $config_dir/shader_cache * Options to tweak shader caching in project settings. * Editor path configuration moved from EditorSettings to new class, EditorPaths, so it can be available early on (before shaders are compiled). * Reworked ShaderCompilerRD to ensure deterministic shader code creation (else shader may change and cache will be invalidated). * Added shader compression with SMOLV: https://github.com/aras-p/smol-v
2021-05-25 00:25:11 +00:00
#ifdef TOOLS_ENABLED
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
if (editor || project_manager || cmdline_tool) {
Refactor editor paths validation in EditorPaths and EditorSettings - EditorSettings: Ensure that `create()` makes a valid singleton. Fixes #49179, fixes #49450. - EditorPaths: Cleanup code, properly set `paths_valid`. - EditorPaths: Move more paths validation (check, mkdir) from EditorSettings for a better separation of concerns. - EditorPaths: Move EditorFileSystem creation of `.godot/imported` next to other paths.
2021-06-09 08:47:32 +00:00
EditorPaths::create();
Fix project manager not working in self-contained mode
2022-09-24 16:49:53 +00:00
if (found_project && EditorPaths::get_singleton()->is_self_contained()) {
Error if trying to run a self-contained editor in a project folder
2022-09-21 06:34:26 +00:00
if (ProjectSettings::get_singleton()->get_resource_path() == OS::get_singleton()->get_executable_path().get_base_dir()) {
ERR_PRINT("You are trying to run a self-contained editor at the same location as a project. This is not allowed, since editor files will mix with project files.");
OS::get_singleton()->set_exit_code(EXIT_FAILURE);
return FAILED;
}
}
Implement shader caching * Shader compilation is now cached. Subsequent loads take less than a millisecond. * Improved game, editor and project manager startup time. * Editor uses .godot/shader_cache to store shaders. * Game uses user://shader_cache * Project manager uses $config_dir/shader_cache * Options to tweak shader caching in project settings. * Editor path configuration moved from EditorSettings to new class, EditorPaths, so it can be available early on (before shaders are compiled). * Reworked ShaderCompilerRD to ensure deterministic shader code creation (else shader may change and cache will be invalidated). * Added shader compression with SMOLV: https://github.com/aras-p/smol-v
2021-05-25 00:25:11 +00:00
}
#endif
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
/* Initialize Input */
Rename InputFilter back to Input It changed name as part of the DisplayServer and input refactoring in #37317, with the rationale that input no longer goes through the main loop, so the previous Input singleton now only does filtering. But the gains in consistency are quite limited in the renaming, and it breaks compatibility for all scripts and tutorials that access the Input singleton via the scripting language. A temporary option was suggested to keep the scripting singleton named `Input` even if its type is `InputFilter`, but that adds inconsistency and breaks C#. Fixes godotengine/godot-proposals#639. Fixes #37319. Fixes #37690.
2020-04-28 13:19:37 +00:00
input = memnew(Input);
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Fixes small typos and grammar correction
2021-03-12 13:35:16 +00:00
/* Initialize Display Server */
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
{
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
String display_driver = DisplayServer::get_create_function_name(display_driver_idx);
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Make window creation with custom position do not flash
2022-10-23 10:34:41 +00:00
Vector2i *window_position = nullptr;
Vector2i position = init_custom_pos;
if (init_use_custom_pos) {
window_position = &position;
}
Add framework for avoidance of color flash in new windows
2023-01-11 18:14:43 +00:00
Color boot_bg_color = GLOBAL_DEF_BASIC("application/boot_splash/bg_color", boot_splash_bg_color);
DisplayServer::set_early_window_clear_color_override(true, boot_bg_color);
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
// rendering_driver now held in static global String in main and initialized in setup()
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Error err;
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
display_server = DisplayServer::create(display_driver_idx, rendering_driver, window_mode, window_vsync_mode, window_flags, window_position, window_size, init_screen, err);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
if (err != OK || display_server == nullptr) {
DisplayServer: Don't fallback to headless Unless users requested the headless driver specifically, they expect to either see a window, or that the process terminates if there's an error. Currently it would fallback to headless so they'd unexpectedly get a valid headless instance if their DisplayServer failed initializing (e.g. missing Vulkan support). Fixes #58414.
2022-06-30 13:41:19 +00:00
// We can't use this display server, try other ones as fallback.
// Skip headless (always last registered) because that's not what users
// would expect if they didn't request it explicitly.
for (int i = 0; i < DisplayServer::get_create_function_count() - 1; i++) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
if (i == display_driver_idx) {
DisplayServer: Don't fallback to headless Unless users requested the headless driver specifically, they expect to either see a window, or that the process terminates if there's an error. Currently it would fallback to headless so they'd unexpectedly get a valid headless instance if their DisplayServer failed initializing (e.g. missing Vulkan support). Fixes #58414.
2022-06-30 13:41:19 +00:00
continue; // Don't try the same twice.
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
}
Add support for the custom initial screen for the main window, fix primary screen detection.
2023-01-04 22:00:02 +00:00
display_server = DisplayServer::create(i, rendering_driver, window_mode, window_vsync_mode, window_flags, window_position, window_size, init_screen, err);
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
if (err == OK && display_server != nullptr) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
break;
}
}
}
[Complex Text Layouts] Implement TextServer interface. Implement Fallback TextServer.
2020-08-05 06:25:28 +00:00
if (err != OK || display_server == nullptr) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
ERR_PRINT("Unable to create DisplayServer, all display drivers failed.");
return err;
}
}
if (display_server->has_feature(DisplayServer::FEATURE_ORIENTATION)) {
display_server->screen_set_orientation(window_orientation);
Change OS::initialize signature to return Error (fix segfault on x11)
2018-01-03 17:26:44 +00:00
}
Fall back to GLES2 if GLES3 is not working This adds a static is_viable() method to all rasterizers which has to be called before initializing the rasterizer. This allows us to check what rasterizer to use in OS::initialize together with the GL context initialization. This commit also adds a new project setting "rendering/quality/driver/driver_fallback" which allows the creator of a project to specify whether or not fallback to GLES2 is allowed. This setting is ignored for the editor so the editor will always open even if the project itself cannot run. This will hopefully reduce confusion for users downloading projects from the internet. We also no longer crash when GLES3 is not functioning on a platform. This fixes #15324
2018-08-24 22:04:25 +00:00
Print requested V-Sync mode when Print Fps is enabled This can be used to diagnose why the printed FPS is locked to the monitor refresh rate.
2021-12-20 18:49:04 +00:00
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.
switch (window_vsync_mode) {
case DisplayServer::VSyncMode::VSYNC_DISABLED:
print_line("Requested V-Sync mode: Disabled");
break;
case DisplayServer::VSyncMode::VSYNC_ENABLED:
print_line("Requested V-Sync mode: Enabled - FPS will likely be capped to the monitor refresh rate.");
break;
case DisplayServer::VSyncMode::VSYNC_ADAPTIVE:
print_line("Requested V-Sync mode: Adaptive");
break;
case DisplayServer::VSyncMode::VSYNC_MAILBOX:
print_line("Requested V-Sync mode: Mailbox");
break;
}
}
Fixes small typos and grammar correction
2021-03-12 13:35:16 +00:00
/* Initialize Pen Tablet Driver */
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
{
GLOBAL_DEF_RST_NOVAL("input_devices/pen_tablet/driver", "");
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "input_devices/pen_tablet/driver.windows", PROPERTY_HINT_ENUM, "wintab,winink"), "");
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
}
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (tablet_driver.is_empty()) { // specified in project.godot
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
tablet_driver = GLOBAL_GET("input_devices/pen_tablet/driver");
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (tablet_driver.is_empty()) {
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
tablet_driver = DisplayServer::get_singleton()->tablet_get_driver_name(0);
}
}
for (int i = 0; i < DisplayServer::get_singleton()->tablet_get_driver_count(); i++) {
if (tablet_driver == DisplayServer::get_singleton()->tablet_get_driver_name(i)) {
DisplayServer::get_singleton()->tablet_set_current_driver(DisplayServer::get_singleton()->tablet_get_driver_name(i));
break;
}
}
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (DisplayServer::get_singleton()->tablet_get_current_driver().is_empty()) {
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
DisplayServer::get_singleton()->tablet_set_current_driver(DisplayServer::get_singleton()->tablet_get_driver_name(0));
}
print_verbose("Using \"" + tablet_driver + "\" pen tablet driver...");
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
/* Initialize Rendering Server */
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Make Servers truly Thread Safe -Rendering server now uses a split RID allocate/initialize internally, this allows generating RIDs immediately but initialization to happen later on the proper thread (as rendering APIs generally requiere to call on the right thread). -RenderingServerWrapMT is no more, multithreading is done in RenderingServerDefault. -Some functions like texture or mesh creation, when renderer supports it, can register and return immediately (so no waiting for server API to flush, and saving staging and command buffer memory). -3D physics server changed to be made multithread friendly. -Added PhysicsServer3DWrapMT to use 3D physics server from multiple threads. -Disablet Bullet (too much effort to make multithread friendly, this needs to be fixed eventually).
2021-02-09 16:19:03 +00:00
rendering_server = memnew(RenderingServerDefault(OS::get_singleton()->get_render_thread_mode() == OS::RENDER_SEPARATE_THREAD));
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
rendering_server->init();
Add GLES2 2D renderer + Linux display manager First implementation with Linux display manager. - Add single-threaded mode for EditorResourcePreview (needed for OpenGL). Co-authored-by: clayjohn <claynjohn@gmail.com> Co-authored-by: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
2020-11-18 18:11:30 +00:00
//rendering_server->call_set_use_vsync(OS::get_singleton()->_use_vsync);
Expose disable_render_loop property to GDScript
2020-06-14 17:06:48 +00:00
rendering_server->set_render_loop_enabled(!disable_render_loop);
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
Fixes and optimizations to mobile renderer * Only apply final actions to attachments used in the last pass. * Fixes to draw list final action (was using continue instead of read/drop). * Profiling regions inside draw lists now properly throw errors. * Ability to enable gpu profile printing from project settings. (used to debug).
2021-08-11 00:50:28 +00:00
if (profile_gpu || (!editor && bool(GLOBAL_GET("debug/settings/stdout/print_gpu_profile")))) {
Several GI related optimizations and fixes -SDFGI direct light is done over many frames -SDFGI Changed settings for rays/frame -SDFGI Misc optimizations -SDFGI Bug fix on probe scroll -GIProbe was not working, got it to work again -GIProbe dynamic objects were not working, fixed -Added a half size GI option.
2021-01-22 23:50:24 +00:00
rendering_server->set_print_gpu_profile(true);
}
Add a Movie Quit On Finish property to AnimationPlayer This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-06-25 23:38:20 +00:00
if (Engine::get_singleton()->get_write_movie_path() != String()) {
movie_writer = MovieWriter::find_writer_for_file(Engine::get_singleton()->get_write_movie_path());
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
if (movie_writer == nullptr) {
Add a Movie Quit On Finish property to AnimationPlayer This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-06-25 23:38:20 +00:00
ERR_PRINT("Can't find movie writer for file type, aborting: " + Engine::get_singleton()->get_write_movie_path());
Engine::get_singleton()->set_write_movie_path(String());
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
}
}
Print a warning when the engine is started as `root`/superuser This is a security risk (especially when hosting a game server) and can make audio non-functional on Linux.
2021-07-31 14:23:26 +00:00
#ifdef UNIX_ENABLED
// Print warning after initializing the renderer but before initializing audio.
if (OS::get_singleton()->get_environment("USER") == "root" && !OS::get_singleton()->has_environment("GODOT_SILENCE_ROOT_WARNING")) {
WARN_PRINT("Started the engine as `root`/superuser. This is a security risk, and subsystems like audio may not work correctly.\nSet the environment variable `GODOT_SILENCE_ROOT_WARNING` to 1 to silence this warning.");
}
#endif
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
OS::get_singleton()->initialize_joypads();
/* Initialize Audio Driver */
AudioDriverManager::initialize(audio_driver_idx);
Add a separator in debug output for readability
2019-06-04 13:20:37 +00:00
print_line(" "); //add a blank line for readability
Redoing the ARVR GDNative interface as module and tighter implementation
2017-10-07 13:51:17 +00:00
// right moment to create and initialize the audio server
Oops! Audio engine has vanished :D
2017-01-15 19:06:14 +00:00
audio_server = memnew(AudioServer);
audio_server->init();
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
// also init our xr_server from here
xr_server = memnew(XRServer);
Redoing the ARVR GDNative interface as module and tighter implementation
2017-10-07 13:51:17 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
register_core_singletons();
MAIN_PRINT("Main: Setup Logo");
Add boot splash for the Godot Android Editor
2022-12-16 18:49:28 +00:00
#if !defined(TOOLS_ENABLED) && (defined(WEB_ENABLED) || defined(ANDROID_ENABLED))
Removed unnecessary assignments
2017-08-21 19:15:36 +00:00
bool show_logo = false;
#else
bool show_logo = true;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
-added windowed mode with -w, fixes #3020 -changed default windowed resolution to 1280x720
2015-12-12 15:06:53 +00:00
if (init_windowed) {
//do none..
} else if (init_maximized) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->window_set_mode(DisplayServer::WINDOW_MODE_MAXIMIZED);
-added windowed mode with -w, fixes #3020 -changed default windowed resolution to 1280x720
2015-12-12 15:06:53 +00:00
} else if (init_fullscreen) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->window_set_mode(DisplayServer::WINDOW_MODE_FULLSCREEN);
some editor window changes -ability to make dock position configurable, and it gets saved -editor starts maximized default
2015-06-14 01:12:53 +00:00
}
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
if (init_always_on_top) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->window_set_flag(DisplayServer::WINDOW_FLAG_ALWAYS_ON_TOP, true);
Add new window setting: always on top Implemented for Windows and Linux.
2017-12-27 19:51:19 +00:00
}
Restored (And auto-generated) splash image
2017-04-09 23:02:04 +00:00
Main: Load translations and remaps before scene types This ensures that settings like `gui/theme/custom_font` handle resource remappings properly, as they load resources in `register_scene_types()`. Path remaps used to be done before loading scene types in early Godot versions (as hinted by the "Load Remaps" comment just before "Load Scene Types") but this was broken when developing new localization features. Fixes #17640.
2021-02-02 14:15:13 +00:00
MAIN_PRINT("Main: Load Boot Image");
merged some stuff for okam
2015-09-04 02:24:55 +00:00
Mark some common project settings as basic
2022-06-12 17:50:14 +00:00
Color clear = GLOBAL_DEF_BASIC("rendering/environment/defaults/default_clear_color", Color(0.3, 0.3, 0.3));
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
RenderingServer::get_singleton()->set_default_clear_color(clear);
-Changed most project settings in the engine, so they have major and minor categories. -Changed SectionedPropertyEditor to support this -Renamed Globals singleton to GlobalConfig, makes more sense. -Changed the logic behind persisten global settings, instead of the persist checkbox, a revert button is now available
2017-01-05 12:16:00 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (show_logo) { //boot logo!
Mark some common project settings as basic
2022-06-12 17:50:14 +00:00
const bool boot_logo_image = GLOBAL_DEF_BASIC("application/boot_splash/show_image", true);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
const String boot_logo_path = String(GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "application/boot_splash/image", PROPERTY_HINT_FILE, "*.png"), String())).strip_edges();
Mark some common project settings as basic
2022-06-12 17:50:14 +00:00
const bool boot_logo_scale = GLOBAL_DEF_BASIC("application/boot_splash/fullsize", true);
const bool boot_logo_filter = GLOBAL_DEF_BASIC("application/boot_splash/use_filter", true);
-Changed bootsplash option to use a file, fixes #1539 -Added OS.get_splash_tick_msec() to query when splash appeared
2015-04-12 20:55:01 +00:00
Removal of Image from Variant, converted to a Resource.
2017-05-17 10:36:47 +00:00
Ref<Image> boot_logo;
-Changed bootsplash option to use a file, fixes #1539 -Added OS.get_splash_tick_msec() to query when splash appeared
2015-04-12 20:55:01 +00:00
Add a project setting to disable the boot splash image This allows disabling the boot splash image while keeping the background color.
2021-04-02 13:33:50 +00:00
if (boot_logo_image) {
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!boot_logo_path.is_empty()) {
Add a project setting to disable the boot splash image This allows disabling the boot splash image while keeping the background color.
2021-04-02 13:33:50 +00:00
boot_logo.instantiate();
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.");
}
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Add a project setting to disable the boot splash image This allows disabling the boot splash image while keeping the background color.
2021-04-02 13:33:50 +00:00
} else {
// Create a 1×1 transparent image. This will effectively hide the splash image.
boot_logo.instantiate();
Make some Image methods static
2022-07-22 18:06:19 +00:00
boot_logo->initialize_data(1, 1, false, Image::FORMAT_RGBA8);
Add a project setting to disable the boot splash image This allows disabling the boot splash image while keeping the background color.
2021-04-02 13:33:50 +00:00
boot_logo->set_pixel(0, 0, Color(0, 0, 0, 0));
-Changed bootsplash option to use a file, fixes #1539 -Added OS.get_splash_tick_msec() to query when splash appeared
2015-04-12 20:55:01 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add framework for avoidance of color flash in new windows
2023-01-11 18:14:43 +00:00
Color boot_bg_color = GLOBAL_GET("application/boot_splash/bg_color");
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
Tweak the editor splash screen color to better match the default theme This helps achieve a visually "smoother" transition between the splash screen and the editor.
2021-03-17 21:56:58 +00:00
#if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
boot_bg_color =
Mark some common project settings as basic
2022-06-12 17:50:14 +00:00
GLOBAL_DEF_BASIC("application/boot_splash/bg_color",
Tweak the editor splash screen color to better match the default theme This helps achieve a visually "smoother" transition between the splash screen and the editor.
2021-03-17 21:56:58 +00:00
(editor || project_manager) ? boot_splash_editor_bg_color : boot_splash_bg_color);
#endif
Removal of Image from Variant, converted to a Resource.
2017-05-17 10:36:47 +00:00
if (boot_logo.is_valid()) {
Revert "Add new scaling modes for splash screen" This reverts commit fcc9f5ce396ff921ed8253f657a8c9c38e7a878d. The feature is good but the implementation still needs more work. A new PR will be made with a rework of this commit.
2022-01-19 15:09:52 +00:00
RenderingServer::get_singleton()->set_boot_image(boot_logo, boot_bg_color, boot_logo_scale,
boot_logo_filter);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
} else {
#ifndef NO_DEFAULT_BOOT_LOGO
Silence too verbose boot splash debug info
2015-11-22 23:38:12 +00:00
MAIN_PRINT("Main: Create bootsplash");
Added custom editor splash (including sponsor logo).
2017-12-16 19:11:13 +00:00
#if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
Ref<Image> splash = (editor || project_manager) ? memnew(Image(boot_splash_editor_png)) : memnew(Image(boot_splash_png));
Added custom editor splash (including sponsor logo).
2017-12-16 19:11:13 +00:00
#else
Removal of Image from Variant, converted to a Resource.
2017-05-17 10:36:47 +00:00
Ref<Image> splash = memnew(Image(boot_splash_png));
Added custom editor splash (including sponsor logo).
2017-12-16 19:11:13 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MAIN_PRINT("Main: ClearColor");
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
RenderingServer::get_singleton()->set_default_clear_color(boot_bg_color);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MAIN_PRINT("Main: Image");
Revert "Add new scaling modes for splash screen" This reverts commit fcc9f5ce396ff921ed8253f657a8c9c38e7a878d. The feature is good but the implementation still needs more work. A new PR will be made with a rework of this commit.
2022-01-19 15:09:52 +00:00
RenderingServer::get_singleton()->set_boot_image(splash, boot_bg_color, false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
}
[Windows] Fix main window project icon not set when using editor executable.
2023-01-19 07:50:01 +00:00
#if defined(TOOLS_ENABLED) && defined(MACOS_ENABLED)
[macOS] Prefer .app bundle icon over the default one.
2021-05-13 06:25:09 +00:00
if (OS::get_singleton()->get_bundle_icon_path().is_empty()) {
Ref<Image> icon = memnew(Image(app_icon_png));
DisplayServer::get_singleton()->set_icon(icon);
}
Fix setting the default icon briefly with tools=no
2017-09-15 16:41:11 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Always set default clear color
2016-04-07 23:30:00 +00:00
Add framework for avoidance of color flash in new windows
2023-01-11 18:14:43 +00:00
DisplayServer::set_early_window_clear_color_override(false);
Always set default clear color
2016-04-07 23:30:00 +00:00
MAIN_PRINT("Main: DCC");
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
RenderingServer::get_singleton()->set_default_clear_color(
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
GLOBAL_GET("rendering/environment/defaults/default_clear_color"));
Always set default clear color
2016-04-07 23:30:00 +00:00
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF(PropertyInfo(Variant::STRING, "application/config/icon", PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), String());
GLOBAL_DEF(PropertyInfo(Variant::STRING, "application/config/macos_native_icon", PROPERTY_HINT_FILE, "*.icns"), String());
GLOBAL_DEF(PropertyInfo(Variant::STRING, "application/config/windows_native_icon", PROPERTY_HINT_FILE, "*.ico"), String());
Add native window/taskbar icon support for Windows and macOS. Co-authored-by: Markus Törnqvist <mjt@nysv.org>
2019-05-17 13:43:56 +00:00
Rename InputFilter back to Input It changed name as part of the DisplayServer and input refactoring in #37317, with the rationale that input no longer goes through the main loop, so the previous Input singleton now only does filtering. But the gains in consistency are quite limited in the renaming, and it breaks compatibility for all scripts and tutorials that access the Input singleton via the scripting language. A temporary option was suggested to keep the scripting singleton named `Input` even if its type is `InputFilter`, but that adds inconsistency and breaks C#. Fixes godotengine/godot-proposals#639. Fixes #37319. Fixes #37690.
2020-04-28 13:19:37 +00:00
Input *id = Input::get_singleton();
Implement universal translation of touch to mouse Now generating mouse events from touch is optional (on by default) and it's performed by `InputDefault` instead of having each OS abstraction doing it. (*) The translation algorithm waits for a touch index to be pressed and tracks it translating its events to mouse events until it is raised, while ignoring other pointers. Furthermore, to avoid an stuck "touch mouse", since not all platforms may report touches raised when the window is unfocused, it checks if touches are still down by the time it's focused again and if so it resets the state of the emulated mouse. *: In the case of Windows, since it already provides touch-to-mouse translation by itself, "echo" mouse events are filtered out to have it working like the rest. On X11 a little hack has been needed to avoid a case of a spurious mouse motion event that is generated during touch interaction. Plus: Improve/fix tracking of current mouse position. ** Summary of changes to settings: ** - `display/window/handheld/emulate_touchscreen` becomes `input/pointing_devices/emulate_touch_from_mouse` - New setting: `input/pointing_devices/emulate_mouse_from_touch`
2018-02-24 02:04:30 +00:00
if (id) {
Add project setting for agile input event flushing If enabled, key/touch/joystick events will be flushed just before every idle and physics frame. Enabling this can greatly improve the responsiveness to input, specially in devices that need to run multiple physics frames per each idle frame, because of not being powerful enough to run at the target frame rate. This will only work for platforms using input buffering (regardless event accumulation). Currenly, only Android does so, but could be implemented for iOS in an upcoming PR.
2020-09-20 23:35:20 +00:00
agile_input_event_flushing = GLOBAL_DEF("input_devices/buffering/agile_event_flushing", false);
Mark touch emulation project settings as basic These settings are likely to be toggled often during development, so they should be as accessible as possible.
2023-01-23 09:07:47 +00:00
if (bool(GLOBAL_DEF_BASIC("input_devices/pointing/emulate_touch_from_mouse", false)) &&
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
!(editor || project_manager)) {
Fix Determining Window for Touchscreen DisplayServer::screen_is_touchscreen will likely never utilize its parameter p_screen. This PR replaces this function by DisplayServer::is_touchscreen_available() with the same functionality. This solves the problem, that a SubViewport was used for determining the screen, which resulted in error messages.
2022-10-16 22:59:51 +00:00
if (!DisplayServer::get_singleton()->is_touchscreen_available()) {
Implement universal translation of touch to mouse Now generating mouse events from touch is optional (on by default) and it's performed by `InputDefault` instead of having each OS abstraction doing it. (*) The translation algorithm waits for a touch index to be pressed and tracks it translating its events to mouse events until it is raised, while ignoring other pointers. Furthermore, to avoid an stuck "touch mouse", since not all platforms may report touches raised when the window is unfocused, it checks if touches are still down by the time it's focused again and if so it resets the state of the emulated mouse. *: In the case of Windows, since it already provides touch-to-mouse translation by itself, "echo" mouse events are filtered out to have it working like the rest. On X11 a little hack has been needed to avoid a case of a spurious mouse motion event that is generated during touch interaction. Plus: Improve/fix tracking of current mouse position. ** Summary of changes to settings: ** - `display/window/handheld/emulate_touchscreen` becomes `input/pointing_devices/emulate_touch_from_mouse` - New setting: `input/pointing_devices/emulate_mouse_from_touch`
2018-02-24 02:04:30 +00:00
//only if no touchscreen ui hint, set emulation
id->set_emulate_touch_from_mouse(true);
}
-display/emulate_touchscreen now really emulates a touchscreen -icons to show node menus
2015-08-29 20:16:11 +00:00
}
Implement universal translation of touch to mouse Now generating mouse events from touch is optional (on by default) and it's performed by `InputDefault` instead of having each OS abstraction doing it. (*) The translation algorithm waits for a touch index to be pressed and tracks it translating its events to mouse events until it is raised, while ignoring other pointers. Furthermore, to avoid an stuck "touch mouse", since not all platforms may report touches raised when the window is unfocused, it checks if touches are still down by the time it's focused again and if so it resets the state of the emulated mouse. *: In the case of Windows, since it already provides touch-to-mouse translation by itself, "echo" mouse events are filtered out to have it working like the rest. On X11 a little hack has been needed to avoid a case of a spurious mouse motion event that is generated during touch interaction. Plus: Improve/fix tracking of current mouse position. ** Summary of changes to settings: ** - `display/window/handheld/emulate_touchscreen` becomes `input/pointing_devices/emulate_touch_from_mouse` - New setting: `input/pointing_devices/emulate_mouse_from_touch`
2018-02-24 02:04:30 +00:00
Mark touch emulation project settings as basic These settings are likely to be toggled often during development, so they should be as accessible as possible.
2023-01-23 09:07:47 +00:00
id->set_emulate_mouse_from_touch(bool(GLOBAL_DEF_BASIC("input_devices/pointing/emulate_mouse_from_touch", true)));
-display/emulate_touchscreen now really emulates a touchscreen -icons to show node menus
2015-08-29 20:16:11 +00:00
}
Added ability to set custom mouse cursors. Not hardware accelerated yet.
2015-09-24 21:06:15 +00:00
Main: Load translations and remaps before scene types This ensures that settings like `gui/theme/custom_font` handle resource remappings properly, as they load resources in `register_scene_types()`. Path remaps used to be done before loading scene types in early Godot versions (as hinted by the "Load Remaps" comment just before "Load Scene Types") but this was broken when developing new localization features. Fixes #17640.
2021-02-02 14:15:13 +00:00
MAIN_PRINT("Main: Load Translations and Remaps");
translation_server->setup(); //register translations, load them, etc.
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!locale.is_empty()) {
Main: Load translations and remaps before scene types This ensures that settings like `gui/theme/custom_font` handle resource remappings properly, as they load resources in `register_scene_types()`. Path remaps used to be done before loading scene types in early Godot versions (as hinted by the "Load Remaps" comment just before "Load Scene Types") but this was broken when developing new localization features. Fixes #17640.
2021-02-02 14:15:13 +00:00
translation_server->set_locale(locale);
}
translation_server->load_translations();
ResourceLoader::load_translation_remaps(); //load remaps for resources
ResourceLoader::load_path_remaps();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
MAIN_PRINT("Main: Load TextServer");
/* Enum text drivers */
Mark some editor settings as requiring editor restart
2022-07-24 18:25:34 +00:00
GLOBAL_DEF_RST("internationalization/rendering/text_driver", "");
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
String text_driver_options;
for (int i = 0; i < TextServerManager::get_singleton()->get_interface_count(); i++) {
Hide Dummy text driver in the Project Settings as it makes editor unusable This also improves documentation related to driver project settings.
2022-08-13 10:51:07 +00:00
const String driver_name = TextServerManager::get_singleton()->get_interface(i)->get_name();
if (driver_name == "Dummy") {
// Dummy text driver cannot draw any text, making the editor unusable if selected.
continue;
}
if (!text_driver_options.is_empty() && text_driver_options.find(",") == -1) {
// Not the first option; add a comma before it as a separator for the property hint.
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
text_driver_options += ",";
}
Hide Dummy text driver in the Project Settings as it makes editor unusable This also improves documentation related to driver project settings.
2022-08-13 10:51:07 +00:00
text_driver_options += driver_name;
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
}
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
ProjectSettings::get_singleton()->set_custom_property_info(PropertyInfo(Variant::STRING, "internationalization/rendering/text_driver", PROPERTY_HINT_ENUM, text_driver_options));
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
/* Determine text driver */
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (text_driver.is_empty()) {
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
text_driver = GLOBAL_GET("internationalization/rendering/text_driver");
}
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!text_driver.is_empty()) {
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
/* Load user selected text server. */
for (int i = 0; i < TextServerManager::get_singleton()->get_interface_count(); i++) {
if (TextServerManager::get_singleton()->get_interface(i)->get_name() == text_driver) {
text_driver_idx = i;
break;
}
}
}
if (text_driver_idx < 0) {
/* If not selected, use one with the most features available. */
int max_features = 0;
for (int i = 0; i < TextServerManager::get_singleton()->get_interface_count(); i++) {
uint32_t features = TextServerManager::get_singleton()->get_interface(i)->get_features();
int feature_number = 0;
while (features) {
feature_number += features & 1;
features >>= 1;
}
if (feature_number >= max_features) {
max_features = feature_number;
text_driver_idx = i;
}
}
}
if (text_driver_idx >= 0) {
TextServerManager::get_singleton()->set_primary_interface(TextServerManager::get_singleton()->get_interface(text_driver_idx));
} else {
Unify TextServer built-in module and GDExtension code.
2022-02-13 12:41:29 +00:00
ERR_FAIL_V_MSG(ERR_CANT_CREATE, "TextServer: Unable to create TextServer interface.");
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
}
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
engine->startup_benchmark_end_measure(); // servers
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MAIN_PRINT("Main: Load Scene Types");
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
engine->startup_benchmark_begin_measure("scene");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
register_scene_types();
Reorder native extension types initialization, initializing editor last
2022-02-28 13:50:43 +00:00
register_driver_types();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
initialize_modules(MODULE_INITIALIZATION_LEVEL_SCENE);
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->initialize_extensions(GDExtension::INITIALIZATION_LEVEL_SCENE);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
Move cursor shape loading after module loading fixes #46685
2021-03-05 16:22:06 +00:00
#ifdef TOOLS_ENABLED
ClassDB::set_current_api(ClassDB::API_EDITOR);
Move editor class and plugin registrations to a dedicated file
2022-05-01 09:57:36 +00:00
register_editor_types();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
initialize_modules(MODULE_INITIALIZATION_LEVEL_EDITOR);
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->initialize_extensions(GDExtension::INITIALIZATION_LEVEL_EDITOR);
Move cursor shape loading after module loading fixes #46685
2021-03-05 16:22:06 +00:00
ClassDB::set_current_api(ClassDB::API_CORE);
#endif
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
MAIN_PRINT("Main: Load Modules");
Move cursor shape loading after module loading fixes #46685
2021-03-05 16:22:06 +00:00
register_platform_apis();
Make default/project theme wait for modules before initializing
2021-11-30 16:09:29 +00:00
// Theme needs modules to be initialized so that sub-resources can be loaded.
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
initialize_theme_db();
register_scene_singletons();
Make default/project theme wait for modules before initializing
2021-11-30 16:09:29 +00:00
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "display/mouse_cursor/custom_image", PROPERTY_HINT_FILE, "*.png,*.webp"), String());
Mark some common project settings as basic
2022-06-12 17:50:14 +00:00
GLOBAL_DEF_BASIC("display/mouse_cursor/custom_image_hotspot", Vector2());
GLOBAL_DEF_BASIC("display/mouse_cursor/tooltip_position_offset", Point2(10, 10));
Added ability to set custom mouse cursors. Not hardware accelerated yet.
2015-09-24 21:06:15 +00:00
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
if (String(GLOBAL_GET("display/mouse_cursor/custom_image")) != String()) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
Ref<Texture2D> cursor = ResourceLoader::load(
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
GLOBAL_GET("display/mouse_cursor/custom_image"));
Added ability to set custom mouse cursors. Not hardware accelerated yet.
2015-09-24 21:06:15 +00:00
if (cursor.is_valid()) {
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
Vector2 hotspot = GLOBAL_GET("display/mouse_cursor/custom_image_hotspot");
Rename InputFilter back to Input It changed name as part of the DisplayServer and input refactoring in #37317, with the rationale that input no longer goes through the main loop, so the previous Input singleton now only does filtering. But the gains in consistency are quite limited in the renaming, and it breaks compatibility for all scripts and tutorials that access the Input singleton via the scripting language. A temporary option was suggested to keep the scripting singleton named `Input` even if its type is `InputFilter`, but that adds inconsistency and breaks C#. Fixes godotengine/godot-proposals#639. Fixes #37319. Fixes #37690.
2020-04-28 13:19:37 +00:00
Input::get_singleton()->set_custom_mouse_cursor(cursor, Input::CURSOR_ARROW, hotspot);
Added ability to set custom mouse cursors. Not hardware accelerated yet.
2015-09-24 21:06:15 +00:00
}
}
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
iOS modular build and export implementation.
2019-11-29 06:54:39 +00:00
camera_server = CameraServer::create();
Reorder native extension types initialization, initializing editor last
2022-02-28 13:50:43 +00:00
MAIN_PRINT("Main: Load Physics");
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
initialize_physics();
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
initialize_navigation_server();
Implemented physics plug Moved init_physics Implemented physics 2D plug Fix clang Fix clang Fix static check Fix clang Fix static check Moved physics server initialization Moved physics server settings initialization
2017-10-21 11:02:06 +00:00
register_server_singletons();
Added basic support for custom resource savers and loaders
2018-06-11 00:59:53 +00:00
// This loads global classes, so it must happen before custom loaders and savers are registered
UDP Fixes -=-=-=-=- Curse the day I decided to port UDP code, as it ended up being two nights of work. At least It's done now (I hope). -Fixed UDP Support, API seems stable -Added UDP Chat demo (chat that can lose your packets, heh) -Added helpers to areas and bodies to get list of collided bodies and contained bodies. -Sped up screen/viewport capture code. -Added code to save an image as PNG -Small fix so scripts register their singletons after modules did.
2014-11-13 03:53:12 +00:00
ScriptServer::init_languages();
Audio bus editing is COMPLETE!
2017-01-25 17:30:40 +00:00
audio_server->load_default_bus_layout();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
if (use_debug_profiler && EngineDebugger::is_active()) {
// Start the "scripts" profiler, used in local debugging.
// We could add more, and make the CLI arg require a comma-separated list of profilers.
EngineDebugger::get_singleton()->profiler_enable("scripts", true);
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
}
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
if (!project_manager) {
// If not running the project manager, and now that the engine is
// able to load resources, load the global shader variables.
Fixes small typos and grammar correction
2021-03-12 13:35:16 +00:00
// If running on editor, don't load the textures because the editor
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
// may want to import them first. Editor will reload those later.
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
rendering_server->global_shader_parameters_load_settings(!editor);
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
_start_success = true;
Fixes small typos and grammar correction
2021-03-12 13:35:16 +00:00
ClassDB::set_current_api(ClassDB::API_NONE); //no more APIs are registered at this point
Added API version and hashing to ObjectTypeDB
2016-09-14 22:37:37 +00:00
Fix some crashes, overflows and using variables without values
2019-11-01 15:16:31 +00:00
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)));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
MAIN_PRINT("Main: Done");
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
engine->startup_benchmark_end_measure(); // scene
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
return OK;
}
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
String Main::get_rendering_driver_name() {
return rendering_driver;
}
Add hysteresis to physics timestep count per frame Add new class _TimerSync to manage timestep calculations. The new class handles the decisions about simulation progression previously handled by main::iteration(). It is fed the current timer ticks and determines how many physics updates are to be run and what the delta argument to the _process() functions should be. The new class tries to keep the number of physics updates per frame as constant as possible from frame to frame. Ideally, it would be N steps every render frame, but even with perfectly regular rendering, the general case is that N or N+1 steps are required per frame, for some fixed N. The best guess for N is stored in typical_physics_steps. When determining the number of steps to take, no restrictions are imposed between the choice of typical_physics_steps and typical_physics_steps+1 steps. Should more or less steps than that be required, the accumulated remaining time (as before, stored in time_accum) needs to surpass its boundaries by some minimal threshold. Once surpassed, typical_physics_steps is updated to allow the new step count for future updates. Care is taken that the modified calculation of the number of physics steps is not observable from game code that only checks the delta parameters to the _process and _physics_process functions; in addition to modifying the number of steps, the _process argument is modified as well to stay in expected bounds. Extra care is taken that the accumulated steps still sum up to roughly the real elapsed time, up to a maximum tolerated difference. To allow the hysteresis code to work correctly on higher refresh monitors, the number of typical physics steps is not only recorded and kept consistent for single render frames, but for groups of them. Currently, up to 12 frames are grouped that way. The engine parameter physics_jitter_fix controls both the maximum tolerated difference between wall clock time and summed up _process arguments and the threshold for changing typical_physics_steps. It is given in units of the real physics frame slice 1/physics_fps. Set physics_jitter_fix to 0 to disable the effects of the new code here. It starts to be effective against the random physics jitter at around 0.02 to 0.05. at values greater than 1 it starts having ill effects on the engine's ability to react sensibly to dropped frames and framerate changes.
2018-02-10 23:03:31 +00:00
// everything the main loop needs to know about frame timings
-New inspector. -Changed UI resizing code, gained huge amount of speed. -Reorganized timer sync to clean up behavior (sorry forgot commit this before) -
2018-05-15 20:12:35 +00:00
static MainTimerSync main_timer_sync;
Add hysteresis to physics timestep count per frame Add new class _TimerSync to manage timestep calculations. The new class handles the decisions about simulation progression previously handled by main::iteration(). It is fed the current timer ticks and determines how many physics updates are to be run and what the delta argument to the _process() functions should be. The new class tries to keep the number of physics updates per frame as constant as possible from frame to frame. Ideally, it would be N steps every render frame, but even with perfectly regular rendering, the general case is that N or N+1 steps are required per frame, for some fixed N. The best guess for N is stored in typical_physics_steps. When determining the number of steps to take, no restrictions are imposed between the choice of typical_physics_steps and typical_physics_steps+1 steps. Should more or less steps than that be required, the accumulated remaining time (as before, stored in time_accum) needs to surpass its boundaries by some minimal threshold. Once surpassed, typical_physics_steps is updated to allow the new step count for future updates. Care is taken that the modified calculation of the number of physics steps is not observable from game code that only checks the delta parameters to the _process and _physics_process functions; in addition to modifying the number of steps, the _process argument is modified as well to stay in expected bounds. Extra care is taken that the accumulated steps still sum up to roughly the real elapsed time, up to a maximum tolerated difference. To allow the hysteresis code to work correctly on higher refresh monitors, the number of typical physics steps is not only recorded and kept consistent for single render frames, but for groups of them. Currently, up to 12 frames are grouped that way. The engine parameter physics_jitter_fix controls both the maximum tolerated difference between wall clock time and summed up _process arguments and the threshold for changing typical_physics_steps. It is given in units of the real physics frame slice 1/physics_fps. Set physics_jitter_fix to 0 to disable the effects of the new code here. It starts to be effective against the random physics jitter at around 0.02 to 0.05. at values greater than 1 it starts having ill effects on the engine's ability to react sensibly to dropped frames and framerate changes.
2018-02-10 23:03:31 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool Main::start() {
ERR_FAIL_COND_V(!_start_success, false);
Fix setting the default icon briefly with tools=no
2017-09-15 16:41:11 +00:00
bool hasicon = false;
Be stricter on what's considered a scene path in CLI argument parsing This closes #8721.
2019-10-29 00:42:57 +00:00
String positional_arg;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String game_path;
String script;
Export: Add dedicated --export-pack option to export data pack The previous behavior relying on the provided extension was problematic on macOS since .zip is the main extension used for the full project export (binary + data pack). We add a dedicated `--export-pack` command line option to define when only the data pack should be exported. Its extension will still be inferred from the path. Fixes #23073.
2020-01-08 13:22:50 +00:00
bool check_only = false;
#ifdef TOOLS_ENABLED
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
String doc_tool_path;
Export: Add dedicated --export-pack option to export data pack The previous behavior relying on the provided extension was problematic on macOS since .zip is the main extension used for the full project export (binary + data pack). We add a dedicated `--export-pack` command line option to define when only the data pack should be exported. Its extension will still be inferred from the path. Fixes #23073.
2020-01-08 13:22:50 +00:00
bool doc_base = true;
Enable command-line export The syntax is identical to what it was in 2.1, but now you specify preset name instead of platform name.
2017-08-14 13:15:06 +00:00
String _export_preset;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool export_debug = false;
Export: Add dedicated --export-pack option to export data pack The previous behavior relying on the provided extension was problematic on macOS since .zip is the main extension used for the full project export (binary + data pack). We add a dedicated `--export-pack` command line option to define when only the data pack should be exported. Its extension will still be inferred from the path. Fixes #23073.
2020-01-08 13:22:50 +00:00
bool export_pack_only = false;
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
bool converting_project = false;
bool validating_converting_project = false;
Export: Add dedicated --export-pack option to export data pack The previous behavior relying on the provided extension was problematic on macOS since .zip is the main extension used for the full project export (binary + data pack). We add a dedicated `--export-pack` command line option to define when only the data pack should be exported. Its extension will still be inferred from the path. Fixes #23073.
2020-01-08 13:22:50 +00:00
#endif
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
-New inspector. -Changed UI resizing code, gained huge amount of speed. -Reorganized timer sync to clean up behavior (sorry forgot commit this before) -
2018-05-15 20:12:35 +00:00
main_timer_sync.init(OS::get_singleton()->get_ticks_usec());
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
List<String> args = OS::get_singleton()->get_cmdline_args();
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
for (int i = 0; i < args.size(); i++) {
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
// First check parameters that do not have an argument to the right.
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
// Doctest Unit Testing Handler
// Designed to override and pass arguments to the unit test handler.
Fix warnings seen with warnings=all and recent GCC 8.2.
2019-02-18 19:28:40 +00:00
if (args[i] == "--check-only") {
check_only = true;
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
#ifdef TOOLS_ENABLED
Fix warnings seen with warnings=all and recent GCC 8.2.
2019-02-18 19:28:40 +00:00
} else if (args[i] == "--no-docbase") {
doc_base = false;
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
} else if (args[i] == "--convert-3to4") {
converting_project = true;
} else if (args[i] == "--validate-conversion-3to4") {
validating_converting_project = true;
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (args[i] == "-e" || args[i] == "--editor") {
Fix arguments parsing in the main function Fixes #2611 which was a regression from 692216b86ab97db91e7ff3903ffc9ac8e37433f6. The bogus behaviour considered that if there were more than one arguments left to parse, they would be a pair of arguments (switch and its parameter), and thus skipped the next argument in all cases (thus potentially skipping a "-editor", which triggered #2611). This is fixed by checking first for arguments that don't expect a parameter, and only afterwards for arguments that expect a parameter. And if a "pair" of arguments is not valid, we no longer increment the counter.
2015-11-01 16:50:44 +00:00
editor = true;
Fixes for new two-dash long command line arguments - Fixes some single-dash leftovers that were missed in the previous commit - Reorder the help output for clarity, and document missing options - Drop obsolete options: --noop, --pack, --editor-scene, --level, --import, --import-script, --no-quit - Improve error message on malformed arguments and do not display help on error - Always use long form of arguments when starting a new Godot process from C++, for clarity and easy grepping - Cleanup obsolete code here and there
2017-08-19 14:45:03 +00:00
} else if (args[i] == "-p" || args[i] == "--project-manager") {
Always detect and use hiDPI in the project manager if needed This makes its hiDPI behavior consistent with the editor.
2018-02-13 17:56:38 +00:00
project_manager = true;
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
#endif
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
} else if (args[i].length() && args[i][0] != '-' && positional_arg.is_empty()) {
Be stricter on what's considered a scene path in CLI argument parsing This closes #8721.
2019-10-29 00:42:57 +00:00
positional_arg = args[i];
Allow `.res` and `.tres` extensions in the scene CLI positional argument This closes #35709.
2020-05-06 17:59:29 +00:00
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")) {
Be stricter on what's considered a scene path in CLI argument parsing This closes #8721.
2019-10-29 00:42:57 +00:00
// Only consider the positional argument to be a scene path if it ends with
// a file extension associated with Godot scenes. This makes it possible
// 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];
}
Fix arguments parsing in the main function Fixes #2611 which was a regression from 692216b86ab97db91e7ff3903ffc9ac8e37433f6. The bogus behaviour considered that if there were more than one arguments left to parse, they would be a pair of arguments (switch and its parameter), and thus skipped the next argument in all cases (thus potentially skipping a "-editor", which triggered #2611). This is fixed by checking first for arguments that don't expect a parameter, and only afterwards for arguments that expect a parameter. And if a "pair" of arguments is not valid, we no longer increment the counter.
2015-11-01 16:50:44 +00:00
}
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
// Then parameters that have an argument to the right.
Fix arguments parsing in the main function Fixes #2611 which was a regression from 692216b86ab97db91e7ff3903ffc9ac8e37433f6. The bogus behaviour considered that if there were more than one arguments left to parse, they would be a pair of arguments (switch and its parameter), and thus skipped the next argument in all cases (thus potentially skipping a "-editor", which triggered #2611). This is fixed by checking first for arguments that don't expect a parameter, and only afterwards for arguments that expect a parameter. And if a "pair" of arguments is not valid, we no longer increment the counter.
2015-11-01 16:50:44 +00:00
else if (i < (args.size() - 1)) {
bool parsed_pair = true;
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
if (args[i] == "-s" || args[i] == "--script") {
ran cppcheck, fixed cases where array index is used before limits check
2015-09-16 20:51:19 +00:00
script = args[i + 1];
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
#ifdef TOOLS_ENABLED
} else if (args[i] == "--doctool") {
Main: Default `--doctool` path to '.' if none given
2021-04-05 13:35:19 +00:00
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;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Rename `--export` command line argument to `--export-release` This makes the action of exporting to release mode more explicit.
2022-04-15 15:11:53 +00:00
} else if (args[i] == "--export-release") {
ran cppcheck, fixed cases where array index is used before limits check
2015-09-16 20:51:19 +00:00
editor = true; //needs editor
Ensure --export implies --editor Fixes #30149
2019-06-28 12:34:09 +00:00
_export_preset = args[i + 1];
Tweak command-line arguments to make them more UNIX-like Also improves the command-line help text readability.
2017-06-21 09:09:30 +00:00
} else if (args[i] == "--export-debug") {
ran cppcheck, fixed cases where array index is used before limits check
2015-09-16 20:51:19 +00:00
editor = true; //needs editor
Ensure --export implies --editor Fixes #30149
2019-06-28 12:34:09 +00:00
_export_preset = args[i + 1];
ran cppcheck, fixed cases where array index is used before limits check
2015-09-16 20:51:19 +00:00
export_debug = true;
Export: Add dedicated --export-pack option to export data pack The previous behavior relying on the provided extension was problematic on macOS since .zip is the main extension used for the full project export (binary + data pack). We add a dedicated `--export-pack` command line option to define when only the data pack should be exported. Its extension will still be inferred from the path. Fixes #23073.
2020-01-08 13:22:50 +00:00
} else if (args[i] == "--export-pack") {
editor = true;
_export_preset = args[i + 1];
export_pack_only = true;
Ignore tools CLI flags in non-tools builds. Some flags were still parsed but either did nothing or broke everything. No reason to parse them.
2018-02-16 18:40:22 +00:00
#endif
Fix arguments parsing in the main function Fixes #2611 which was a regression from 692216b86ab97db91e7ff3903ffc9ac8e37433f6. The bogus behaviour considered that if there were more than one arguments left to parse, they would be a pair of arguments (switch and its parameter), and thus skipped the next argument in all cases (thus potentially skipping a "-editor", which triggered #2611). This is fixed by checking first for arguments that don't expect a parameter, and only afterwards for arguments that expect a parameter. And if a "pair" of arguments is not valid, we no longer increment the counter.
2015-11-01 16:50:44 +00:00
} else {
// The parameter does not match anything known, don't skip the next argument
parsed_pair = false;
}
if (parsed_pair) {
i++;
ran cppcheck, fixed cases where array index is used before limits check
2015-09-16 20:51:19 +00:00
}
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
}
#ifdef TOOLS_ENABLED
// Handle case where no path is given to --doctool.
else if (args[i] == "--doctool") {
Main: Default `--doctool` path to '.' if none given
2021-04-05 13:35:19 +00:00
doc_tool_path = ".";
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
uint64_t minimum_time_msec = GLOBAL_DEF(PropertyInfo(Variant::INT, "application/boot_splash/minimum_display_time", PROPERTY_HINT_RANGE, "0,100,1,or_greater,suffix:ms"), 0);
Add boot splash display time setting Implements #8867.
2022-06-28 15:13:00 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!doc_tool_path.is_empty()) {
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
// Needed to instance editor-only classes for their default values
Engine::get_singleton()->set_editor_hint(true);
Add default values to the editor help, docs, and generated RST Also, make spacing of "=" in the editor help a bit more consistent. Closes #16086
2019-06-01 13:42:22 +00:00
Make `--doctool` locale aware * Adds `indent(str)` to `String`: * Indent the (multiline) string with the given indentation. * This method is added in order to keep the translated XML correctly indented. * Moves the loading of tool/doc translation into `editor/editor_translation.{h,cpp}`. * This will be used from both `EditorSettings` and the doc tool from `main`. * Makes use of doc translation when generating XML class references, and setup the translation locale based on `-l LOCALE` CLI parameter. The XML class reference won't be translated if `-l LOCALE` parameter is not given, or when it's `-l en`.
2021-12-15 15:01:06 +00:00
// Translate the class reference only when `-l LOCALE` parameter is given.
if (!locale.is_empty() && locale != "en") {
load_doc_translations(locale);
}
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
{
Make FileAccess and DirAccess classes reference counted.
2022-03-23 09:08:58 +00:00
Ref<DirAccess> da = DirAccess::open(doc_tool_path);
ERR_FAIL_COND_V_MSG(da.is_null(), false, "Argument supplied to --doctool must be a valid directory path.");
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
}
DocData: Keep Mono properties on non-Mono builds This doesn't make much sense API-wise, but it's important for the documentation workflow that the Mono and non-Mono builds produce the same output, otherwise we keep having non-Mono builds removing Mono properties and losing their descriptions. This is a terrible hack but it's ad hoc, and should be OK for the time being.
2020-04-20 15:57:38 +00:00
doc: Define dummy Mono settings to keep them in doctool Revival of #54840.
2023-01-20 12:10:00 +00:00
#ifndef MODULE_MONO_ENABLED
// Hack to define .NET-specific project settings even on non-.NET builds,
// so that we don't lose their descriptions and default values in DocTools.
// Default values should be synced with mono_gd/gd_mono.cpp.
GLOBAL_DEF("dotnet/project/assembly_name", "");
GLOBAL_DEF("dotnet/project/solution_directory", "");
#endif
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
Error err;
Refactor DocData into core and editor (DocTools) parts
2020-11-29 03:42:06 +00:00
DocTools doc;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
doc.generate(doc_base);
Refactor DocData into core and editor (DocTools) parts
2020-11-29 03:42:06 +00:00
DocTools docsrc;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<String, String> doc_data_classes;
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
HashSet<String> checked_paths;
Change ".." punctuation for "..." in editor strings (#16507)
2018-04-22 17:36:01 +00:00
print_line("Loading docs...");
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Style: Apply clang-format to @reduz's changes [ci skip]
2017-09-13 07:13:23 +00:00
for (int i = 0; i < _doc_data_class_path_count; i++) {
Add `custom_modules` build option to compile external user modules This patch adds ability to include external, user-defined C++ modules to be compiled as part of Godot via `custom_modules` build option which can be passed to `scons`. ``` scons platform=x11 tools=yes custom_modules="../project/modules" ``` Features: - detects all available modules under `custom_modules` directory the same way as it does for built-in modules (not recursive); - works with both relative and absolute paths on the filesystem; - multiple search paths can be specified as a comma-separated list. Module custom documentation and editor icons collection and generation process is adapted to work with absolute paths needed by such modules. Also fixed doctool bug mixing absolute and relative paths respectively. Implementation details: - `env.module_list` is a dictionary now, which holds both module name as key and either a relative or absolute path to a module as a value. - `methods.detect_modules` is run twice: once for built-in modules, and second for external modules, all combined later. - `methods.detect_modules` was not doing what it says on the tin. It is split into `detect_modules` which collects a list of available modules and `write_modules` which generates `register_types` sources for each. - whether a module is built-in or external is distinguished by relative or absolute paths respectively. `custom_modules` scons converter ensures that the path is absolute even if relative path is supplied, including expanding user paths and symbolic links. - treats the parent directory as if it was Godot's base directory, so that there's no need to change include paths in cases where custom modules are included as dependencies in other modules.
2020-03-08 16:34:09 +00:00
// Custom modules are always located by absolute path.
String path = _doc_data_class_paths[i].path;
Rename String::is_rel_path to String::is_relative_path
2021-08-29 23:43:47 +00:00
if (path.is_relative_path()) {
Rename String `plus_file` to `path_join`
2022-08-30 00:34:01 +00:00
path = doc_tool_path.path_join(path);
Add `custom_modules` build option to compile external user modules This patch adds ability to include external, user-defined C++ modules to be compiled as part of Godot via `custom_modules` build option which can be passed to `scons`. ``` scons platform=x11 tools=yes custom_modules="../project/modules" ``` Features: - detects all available modules under `custom_modules` directory the same way as it does for built-in modules (not recursive); - works with both relative and absolute paths on the filesystem; - multiple search paths can be specified as a comma-separated list. Module custom documentation and editor icons collection and generation process is adapted to work with absolute paths needed by such modules. Also fixed doctool bug mixing absolute and relative paths respectively. Implementation details: - `env.module_list` is a dictionary now, which holds both module name as key and either a relative or absolute path to a module as a value. - `methods.detect_modules` is run twice: once for built-in modules, and second for external modules, all combined later. - `methods.detect_modules` was not doing what it says on the tin. It is split into `detect_modules` which collects a list of available modules and `write_modules` which generates `register_types` sources for each. - whether a module is built-in or external is distinguished by relative or absolute paths respectively. `custom_modules` scons converter ensures that the path is absolute even if relative path is supplied, including expanding user paths and symbolic links. - treats the parent directory as if it was Godot's base directory, so that there's no need to change include paths in cases where custom modules are included as dependencies in other modules.
2020-03-08 16:34:09 +00:00
}
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
String name = _doc_data_class_paths[i].name;
Style: Apply clang-format to @reduz's changes [ci skip]
2017-09-13 07:13:23 +00:00
doc_data_classes[name] = path;
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
if (!checked_paths.has(path)) {
checked_paths.insert(path);
Make `--doctool` create directories if they don't exist This prevents errors due to missing directories when generating engine documentation. This closes #17297.
2019-06-08 19:13:16 +00:00
// Create the module documentation directory if it doesn't exist
Make FileAccess and DirAccess classes reference counted.
2022-03-23 09:08:58 +00:00
Ref<DirAccess> da = DirAccess::create_for_path(path);
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
err = da->make_dir_recursive(path);
ERR_FAIL_COND_V_MSG(err != OK, false, "Error: Can't create directory: " + path + ": " + itos(err));
Make `--doctool` create directories if they don't exist This prevents errors due to missing directories when generating engine documentation. This closes #17297.
2019-06-08 19:13:16 +00:00
Style: Apply clang-format to @reduz's changes [ci skip]
2017-09-13 07:13:23 +00:00
print_line("Loading docs from: " + path);
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
err = docsrc.load_classes(path);
ERR_FAIL_COND_V_MSG(err != OK, false, "Error loading docs from: " + path + ": " + itos(err));
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Rename String `plus_file` to `path_join`
2022-08-30 00:34:01 +00:00
String index_path = doc_tool_path.path_join("doc/classes");
Make `--doctool` create directories if they don't exist This prevents errors due to missing directories when generating engine documentation. This closes #17297.
2019-06-08 19:13:16 +00:00
// Create the main documentation directory if it doesn't exist
Make FileAccess and DirAccess classes reference counted.
2022-03-23 09:08:58 +00:00
Ref<DirAccess> da = DirAccess::create_for_path(index_path);
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
err = da->make_dir_recursive(index_path);
ERR_FAIL_COND_V_MSG(err != OK, false, "Error: Can't create index directory: " + index_path + ": " + itos(err));
Make `--doctool` create directories if they don't exist This prevents errors due to missing directories when generating engine documentation. This closes #17297.
2019-06-08 19:13:16 +00:00
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
print_line("Loading classes from: " + index_path);
err = docsrc.load_classes(index_path);
ERR_FAIL_COND_V_MSG(err != OK, false, "Error loading classes from: " + index_path + ": " + itos(err));
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
checked_paths.insert(index_path);
Change ".." punctuation for "..." in editor strings (#16507)
2018-04-22 17:36:01 +00:00
print_line("Merging docs...");
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
doc.merge_from(docsrc);
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
Use range iterators for RBSet in most cases
2022-05-18 23:43:40 +00:00
for (const String &E : checked_paths) {
print_line("Erasing old docs at: " + E);
err = DocTools::erase_classes(E);
ERR_FAIL_COND_V_MSG(err != OK, false, "Error erasing old docs at: " + E + ": " + itos(err));
Implements modules documents Editor can generate documents for modules in thier own xml files
2016-12-16 11:12:22 +00:00
}
Change ".." punctuation for "..." in editor strings (#16507)
2018-04-22 17:36:01 +00:00
print_line("Generating new docs...");
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
err = doc.save_classes(index_path, doc_data_classes);
ERR_FAIL_COND_V_MSG(err != OK, false, "Error saving new docs:" + itos(err));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Doctool: Add error checks and exit code handling
2022-01-17 22:54:53 +00:00
OS::get_singleton()->set_exit_code(EXIT_SUCCESS);
Fix arguments always being found and returned some items back to normal
2020-07-24 13:16:02 +00:00
return false;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
if (dump_gdextension_interface) {
GDExtensionInterfaceDump::generate_gdextension_interface_file("gdextension_interface.h");
Implement a way to dump the gdnative_interface.h file from the executable
2022-10-12 14:21:34 +00:00
}
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
if (dump_extension_api) {
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionAPIDump::generate_extension_json_file("extension_api.json");
Implement a way to dump the gdnative_interface.h file from the executable
2022-10-12 14:21:34 +00:00
}
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
if (dump_gdextension_interface || dump_extension_api) {
CI: Fix dumping GDExtension interface and API for godot-cpp Follow-up to https://github.com/godotengine/godot-cpp/pull/960. Fix exit code for --dump-extension-api and --dump-gdextension-interface. Removed the planned API validation step as we still didn't implement anything, and maintaining a stub isn't useful.
2022-12-14 15:13:38 +00:00
OS::get_singleton()->set_exit_code(EXIT_SUCCESS);
Implement native extension system * Deprecates GDNative in favor of a simpler, lower level interface. * New extension system allows registering core engine classes. * Simple header interface in gdnative_interace.h
2021-06-19 15:58:49 +00:00
return false;
}
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
if (converting_project) {
Speedup conversion and add option to set maximum line length to prevent freezes
2022-08-13 20:17:35 +00:00
int exit_code = ProjectConverter3To4(converter_max_kb_file, converter_max_line_length).convert();
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
OS::get_singleton()->set_exit_code(exit_code);
return false;
}
if (validating_converting_project) {
Speedup conversion and add option to set maximum line length to prevent freezes
2022-08-13 20:17:35 +00:00
int exit_code = ProjectConverter3To4(converter_max_kb_file, converter_max_line_length).validate_conversion();
Add Godot 3.x -> Godot 4.x project converter
2022-03-10 15:21:22 +00:00
OS::get_singleton()->set_exit_code(exit_code);
return false;
}
Export: Add dedicated --export-pack option to export data pack The previous behavior relying on the provided extension was problematic on macOS since .zip is the main extension used for the full project export (binary + data pack). We add a dedicated `--export-pack` command line option to define when only the data pack should be exported. Its extension will still be inferred from the path. Fixes #23073.
2020-01-08 13:22:50 +00:00
#endif
Print error if no export destination has been passed
2015-11-26 20:59:25 +00:00
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (script.is_empty() && game_path.is_empty() && String(GLOBAL_GET("application/run/main_scene")) != "") {
Reorganize Project Settings -Advanced Settings toggle also hides advanced properties when disabled -Simplified Advanced Bar (errors were just plain redundant) -Reorganized rendering quality settings. -Reorganized miscelaneous settings for clean up.
2021-02-17 16:44:49 +00:00
game_path = GLOBAL_GET("application/run/main_scene");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
#ifdef TOOLS_ENABLED
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!editor && !project_manager && !cmdline_tool && script.is_empty() && game_path.is_empty()) {
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
// If we end up here, it means we didn't manage to detect what we want to run.
// Let's throw an error gently. The code leading to this is pretty brittle so
// this might end up triggered by valid usage, in which case we'll have to
// fine-tune further.
Move `alert` function from `DisplayServer` to `OS`.
2021-07-22 16:23:48 +00:00
OS::get_singleton()->alert("Couldn't detect whether to run the editor, the project manager or a specific project. Aborting.");
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
ERR_FAIL_V_MSG(false, "Couldn't detect whether to run the editor, the project manager or a specific project. Aborting.");
}
#endif
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
MainLoop *main_loop = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (editor) {
SceneMainLoop -> SceneTree -=-=-=-=-=-=-=-=-=-=-=-=-=- *YOUR SOURCE MIGHT NOT WORK* For mor information on fix: https://github.com/okamstudio/godot/wiki/devel_scene_tree Other stuff: -Shower of bullets demo -Fixes all around
2014-11-06 00:20:42 +00:00
main_loop = memnew(SceneTree);
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
}
Accept global classes for `MainLoop` type in project settings `application/run/main_loop_type` setting can handle custom global classes (`class_name`). For instance: `MySceneTree`. The setting's default is changed from empty to `SceneTree` as to give some hint of what kind of input is accepted for the main loop type.
2020-08-11 17:20:30 +00:00
String main_loop_type = GLOBAL_DEF("application/run/main_loop_type", "SceneTree");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!script.is_empty()) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<Script> script_res = ResourceLoader::load(script);
Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in "main" and "servers" directories
2019-08-08 20:08:27 +00:00
ERR_FAIL_COND_V_MSG(script_res.is_null(), false, "Can't load script: " + script);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Add cli paramerter --check-only for script parsing
2018-05-30 22:23:23 +00:00
if (check_only) {
godot exit code improvement for --script --check-only, fixes #33895 this commit causes godot executable to return non-zero exit code once invalid script is passed via --script during --check-only
2019-11-25 21:39:51 +00:00
if (!script_res->is_valid()) {
Remove GDScript bindings for OS.get/set_exit_code, SceneTree.quit(<exit_code>) should be used instead
2020-06-04 20:03:45 +00:00
OS::get_singleton()->set_exit_code(EXIT_FAILURE);
Fix exit code for --script --check-only, fixes #54087 this commit makes godot executable to return zero exit code once a valid script is passed via --script during --check-only
2021-10-21 18:34:43 +00:00
} else {
OS::get_singleton()->set_exit_code(EXIT_SUCCESS);
godot exit code improvement for --script --check-only, fixes #33895 this commit causes godot executable to return non-zero exit code once invalid script is passed via --script during --check-only
2019-11-25 21:39:51 +00:00
}
Fix arguments always being found and returned some items back to normal
2020-07-24 13:16:02 +00:00
return false;
Add cli paramerter --check-only for script parsing
2018-05-30 22:23:23 +00:00
}
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
if (script_res->can_instantiate()) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
StringName instance_type = script_res->get_instance_base_type();
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
Object *obj = ClassDB::instantiate(instance_type);
Convert Object::cast_to() to the static version Currently we rely on some undefined behavior when Object->cast_to() gets called with a Null pointer. This used to work fine with GCC < 6 but newer versions of GCC remove all codepaths in which the this pointer is Null. However, the non-static cast_to() was supposed to be null safe. This patch makes cast_to() Null safe and removes the now redundant Null checks where they existed. It is explained in this article: https://www.viva64.com/en/b/0226/
2017-08-24 20:58:51 +00:00
MainLoop *script_loop = Object::cast_to<MainLoop>(obj);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (!script_loop) {
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (obj) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(obj);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Move `alert` function from `DisplayServer` to `OS`.
2021-07-22 16:23:48 +00:00
OS::get_singleton()->alert(vformat("Can't load the script \"%s\" as it doesn't inherit from SceneTree or MainLoop.", script));
ERR_FAIL_V_MSG(false, vformat("Can't load the script \"%s\" as it doesn't inherit from SceneTree or MainLoop.", script));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
script_loop->set_initialize_script(script_res);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
main_loop = script_loop;
} else {
Fix arguments always being found and returned some items back to normal
2020-07-24 13:16:02 +00:00
return false;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Accept global classes for `MainLoop` type in project settings `application/run/main_loop_type` setting can handle custom global classes (`class_name`). For instance: `MySceneTree`. The setting's default is changed from empty to `SceneTree` as to give some hint of what kind of input is accepted for the main loop type.
2020-08-11 17:20:30 +00:00
} 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);
GDScript: Avoid using `get_global_class_native_base`
2022-11-25 10:21:15 +00:00
if (script_res.is_null()) {
OS::get_singleton()->alert("Error: Could not load MainLoop script type: " + main_loop_type);
ERR_FAIL_V_MSG(false, vformat("Could not load global class %s.", main_loop_type));
}
StringName script_base = script_res->get_instance_base_type();
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
Object *obj = ClassDB::instantiate(script_base);
Accept global classes for `MainLoop` type in project settings `application/run/main_loop_type` setting can handle custom global classes (`class_name`). For instance: `MySceneTree`. The setting's default is changed from empty to `SceneTree` as to give some hint of what kind of input is accepted for the main loop type.
2020-08-11 17:20:30 +00:00
MainLoop *script_loop = Object::cast_to<MainLoop>(obj);
if (!script_loop) {
if (obj) {
memdelete(obj);
}
Move `alert` function from `DisplayServer` to `OS`.
2021-07-22 16:23:48 +00:00
OS::get_singleton()->alert("Error: Invalid MainLoop script base type: " + script_base);
Accept global classes for `MainLoop` type in project settings `application/run/main_loop_type` setting can handle custom global classes (`class_name`). For instance: `MySceneTree`. The setting's default is changed from empty to `SceneTree` as to give some hint of what kind of input is accepted for the main loop type.
2020-08-11 17:20:30 +00:00
ERR_FAIL_V_MSG(false, vformat("The global class %s does not inherit from SceneTree or MainLoop.", main_loop_type));
}
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
script_loop->set_initialize_script(script_res);
Accept global classes for `MainLoop` type in project settings `application/run/main_loop_type` setting can handle custom global classes (`class_name`). For instance: `MySceneTree`. The setting's default is changed from empty to `SceneTree` as to give some hint of what kind of input is accepted for the main loop type.
2020-08-11 17:20:30 +00:00
main_loop = script_loop;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!main_loop && main_loop_type.is_empty()) {
SceneMainLoop -> SceneTree -=-=-=-=-=-=-=-=-=-=-=-=-=- *YOUR SOURCE MIGHT NOT WORK* For mor information on fix: https://github.com/okamstudio/godot/wiki/devel_scene_tree Other stuff: -Shower of bullets demo -Fixes all around
2014-11-06 00:20:42 +00:00
main_loop_type = "SceneTree";
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (!main_loop) {
ObjectTypeDB was renamed to ClassDB. Types are meant to be more generic to Variant. All usages of "type" to refer to classes were renamed to "class" ClassDB has been exposed to GDScript. OBJ_TYPE() macro is now GDCLASS()
2017-01-03 02:03:46 +00:00
if (!ClassDB::class_exists(main_loop_type)) {
Move `alert` function from `DisplayServer` to `OS`.
2021-07-22 16:23:48 +00:00
OS::get_singleton()->alert("Error: MainLoop type doesn't exist: " + main_loop_type);
Fix arguments always being found and returned some items back to normal
2020-07-24 13:16:02 +00:00
return false;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
} else {
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
Object *ml = ClassDB::instantiate(main_loop_type);
Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in "main" and "servers" directories
2019-08-08 20:08:27 +00:00
ERR_FAIL_COND_V_MSG(!ml, false, "Can't instance MainLoop type.");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Convert Object::cast_to() to the static version Currently we rely on some undefined behavior when Object->cast_to() gets called with a Null pointer. This used to work fine with GCC < 6 but newer versions of GCC remove all codepaths in which the this pointer is Null. However, the non-static cast_to() was supposed to be null safe. This patch makes cast_to() Null safe and removes the now redundant Null checks where they existed. It is explained in this article: https://www.viva64.com/en/b/0226/
2017-08-24 20:58:51 +00:00
main_loop = Object::cast_to<MainLoop>(ml);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (!main_loop) {
memdelete(ml);
Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in "main" and "servers" directories
2019-08-08 20:08:27 +00:00
ERR_FAIL_V_MSG(false, "Invalid MainLoop type.");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
}
}
Refactor some object type checking code with `cast_to` Less stringly typed logic, and less String allocations and comparisons.
2022-02-06 13:12:19 +00:00
SceneTree *sml = Object::cast_to<SceneTree>(main_loop);
if (sml) {
Optimize-out some debug and/or non-tools methods Collisions and nav debug are conditionally compiled depending on DEBUG_ENABLED is_editor_hint() and is_node_being_edited() are compiled only with TOOLS_ENABLED Every affected method is implemented in the header in case its macro is not present (the getters just returning false and the setters having an empty body) so the compiler can inline and finally no-op-out them as likely as possible. is_node_being_edited() already showed a similar optimization effort and has been adapted to this change. Furthermore, and as a consequence, -debugcol and -debugnav will not work on non-debug (strict release) builds. This can bring a little bit of runtime performance on release and non-tooled builds (less code, so less cycles to spend and maybe more cache friendly).
2017-04-07 14:17:16 +00:00
#ifdef DEBUG_ENABLED
begin work on debugging collisions....
2015-09-19 02:10:58 +00:00
if (debug_collisions) {
sml->set_debug_collisions_hint(true);
}
Add Path2D/3D debug options Add Path2D/3D debug options.
2022-06-15 21:24:06 +00:00
if (debug_paths) {
sml->set_debug_paths_hint(true);
}
Ability to visually debug geometry visually: -Visible 2D and 3D Shapes, Polygons, Tile collisions, etc. -Visible Navmesh and Navpoly -Visible collision contacts for 2D and 3D as a red point -Customizable colors in project settings
2015-09-20 16:03:46 +00:00
if (debug_navigation) {
sml->set_debug_navigation_hint(true);
Add more detailed Navigation Debug Visualization - Adds more customization options to ProjectSettings. - Displays navregion edge connections and navigation polygon edges in editor and at runtime. - Majority of debug code moved from SceneTree to NavigationServer. - Removes the irritating debug MeshInstance child node from NavigationRegion3D and replaces it with direct RenderingServer API.
2022-07-01 16:58:03 +00:00
NavigationServer3D::get_singleton()->set_active(true);
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
NavigationServer3D::get_singleton()->set_debug_enabled(true);
Ability to visually debug geometry visually: -Visible 2D and 3D Shapes, Polygons, Tile collisions, etc. -Visible Navmesh and Navpoly -Visible collision contacts for 2D and 3D as a red point -Customizable colors in project settings
2015-09-20 16:03:46 +00:00
}
Optimize-out some debug and/or non-tools methods Collisions and nav debug are conditionally compiled depending on DEBUG_ENABLED is_editor_hint() and is_node_being_edited() are compiled only with TOOLS_ENABLED Every affected method is implemented in the header in case its macro is not present (the getters just returning false and the setters having an empty body) so the compiler can inline and finally no-op-out them as likely as possible. is_node_being_edited() already showed a similar optimization effort and has been adapted to this change. Furthermore, and as a consequence, -debugcol and -debugnav will not work on non-debug (strict release) builds. This can bring a little bit of runtime performance on release and non-tooled builds (less code, so less cycles to spend and maybe more cache friendly).
2017-04-07 14:17:16 +00:00
#endif
Enable single-window mode by default in projects There are many issues with using multiple windows by default: - Taking screenshots of a specific window will not capture subwindows. This also applies when recording a video using tools such as OBS. - Subwindows may not behave correctly when fullscreen mode is enabled, especially if exclusive fullscreen is implemented in the future to decrease input lag on Windows. "Subwindows" is quite general here, and also refers to dropdown menus (e.g. those spawned by OptionButton) and Control tooltips. Therefore, it's safer to embed subwindows by default in projects. Multi-window mode remains the default in the editor.
2021-07-21 01:54:45 +00:00
bool embed_subwindows = GLOBAL_DEF("display/window/subwindows/embed_subwindows", true);
Expose 'Embedded Windows Mode' as Editor and Project Settings
2020-03-28 20:56:50 +00:00
Overhaul CLI argument forwarding to processes started by the editor
2022-08-13 19:52:03 +00:00
if (single_window || (!project_manager && !editor && embed_subwindows) || !DisplayServer::get_singleton()->has_feature(DisplayServer::Feature::FEATURE_SUBWINDOWS)) {
Cleanup embed subwindows getters
2022-03-13 15:18:44 +00:00
sml->get_root()->set_embedding_subwindows(true);
Open sub-windows as embedded if the OS does not support them
2020-03-14 16:06:39 +00:00
}
Android port of the Godot Editor These set of changes focus primarily on getting the core logic and overall Godot Editor UI and functionality up and running natively on Android devices. UI tweaks / cleanup / polish, as well configuration for Android specific functionality / restrictions will be addressed in follow-up PRs iteratively based on feedback. Co-authored-by: thebestnom <shoval.arad@gmail.com>
2021-06-25 13:45:16 +00:00
Added basic support for custom resource savers and loaders
2018-06-11 00:59:53 +00:00
ResourceLoader::add_custom_loaders();
ResourceSaver::add_custom_savers();
Only add autoloads in editor if they have tool scripts
2018-05-22 16:26:13 +00:00
if (!project_manager && !editor) { // game
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!game_path.is_empty() || !script.is_empty()) {
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
//autoload
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_begin_measure("load_autoloads");
Add a new HashMap implementation Adds a new, cleaned up, HashMap implementation. * Uses Robin Hood Hashing (https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing). * Keeps elements in a double linked list for simpler, ordered, iteration. * Allows keeping iterators for later use in removal (Unlike Map<>, it does not do much for performance vs keeping the key, but helps replace old code). * Uses a more modern C++ iterator API, deprecates the old one. * Supports custom allocator (in case there is a wish to use a paged one). This class aims to unify all the associative template usage and replace it by this one: * Map<> (whereas key order does not matter, which is 99% of cases) * HashMap<> * OrderedHashMap<> * OAHashMap<>
2022-05-08 08:09:19 +00:00
HashMap<StringName, ProjectSettings::AutoloadInfo> autoloads = ProjectSettings::get_singleton()->get_autoload_list();
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
//first pass, add the constants so they exist before any script is loaded
Add a new HashMap implementation Adds a new, cleaned up, HashMap implementation. * Uses Robin Hood Hashing (https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing). * Keeps elements in a double linked list for simpler, ordered, iteration. * Allows keeping iterators for later use in removal (Unlike Map<>, it does not do much for performance vs keeping the key, but helps replace old code). * Uses a more modern C++ iterator API, deprecates the old one. * Supports custom allocator (in case there is a wish to use a paged one). This class aims to unify all the associative template usage and replace it by this one: * Map<> (whereas key order does not matter, which is 99% of cases) * HashMap<> * OrderedHashMap<> * OAHashMap<>
2022-05-08 08:09:19 +00:00
for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : autoloads) {
const ProjectSettings::AutoloadInfo &info = E.value;
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
Add a map of autoloads to ProjectSettings So places that need to look into it can use the list instead of parsing ProjectSettings details (like checking "*" in path for testing if it's singleton).
2020-06-17 23:45:08 +00:00
if (info.is_singleton) {
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
Add a map of autoloads to ProjectSettings So places that need to look into it can use the list instead of parsing ProjectSettings details (like checking "*" in path for testing if it's singleton).
2020-06-17 23:45:08 +00:00
ScriptServer::get_language(i)->add_global_constant(info.name, Variant());
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
}
}
}
//second pass, load into global constants
List<Node *> to_add;
Add a new HashMap implementation Adds a new, cleaned up, HashMap implementation. * Uses Robin Hood Hashing (https://en.wikipedia.org/wiki/Hash_table#Robin_Hood_hashing). * Keeps elements in a double linked list for simpler, ordered, iteration. * Allows keeping iterators for later use in removal (Unlike Map<>, it does not do much for performance vs keeping the key, but helps replace old code). * Uses a more modern C++ iterator API, deprecates the old one. * Supports custom allocator (in case there is a wish to use a paged one). This class aims to unify all the associative template usage and replace it by this one: * Map<> (whereas key order does not matter, which is 99% of cases) * HashMap<> * OrderedHashMap<> * OAHashMap<>
2022-05-08 08:09:19 +00:00
for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : autoloads) {
const ProjectSettings::AutoloadInfo &info = E.value;
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
Node *n = nullptr;
Fix singleton scene cyclic loading
2022-11-23 23:13:13 +00:00
if (ResourceLoader::get_resource_type(info.path) == "PackedScene") {
// Cache the scene reference before loading it (for cyclic references)
Ref<PackedScene> scn;
scn.instantiate();
scn->set_path(info.path);
scn->reload_from_file();
ERR_CONTINUE_MSG(!scn.is_valid(), vformat("Can't autoload: %s.", info.path));
if (scn.is_valid()) {
n = scn->instantiate();
}
} else {
Ref<Resource> res = ResourceLoader::load(info.path);
ERR_CONTINUE_MSG(res.is_null(), vformat("Can't autoload: %s.", info.path));
Ref<Script> script_res = res;
if (script_res.is_valid()) {
StringName ibt = script_res->get_instance_base_type();
bool valid_type = ClassDB::is_parent_class(ibt, "Node");
ERR_CONTINUE_MSG(!valid_type, vformat("Script does not inherit from Node: %s.", info.path));
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
Fix singleton scene cyclic loading
2022-11-23 23:13:13 +00:00
Object *obj = ClassDB::instantiate(ibt);
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
Fix singleton scene cyclic loading
2022-11-23 23:13:13 +00:00
ERR_CONTINUE_MSG(!obj, vformat("Cannot instance script for autoload, expected 'Node' inheritance, got: %s."));
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
Fix singleton scene cyclic loading
2022-11-23 23:13:13 +00:00
n = Object::cast_to<Node>(obj);
n->set_script(script_res);
}
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
}
Fix singleton scene cyclic loading
2022-11-23 23:13:13 +00:00
ERR_CONTINUE_MSG(!n, vformat("Path in autoload not a node or script: %s.", info.path));
Add a map of autoloads to ProjectSettings So places that need to look into it can use the list instead of parsing ProjectSettings details (like checking "*" in path for testing if it's singleton).
2020-06-17 23:45:08 +00:00
n->set_name(info.name);
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
//defer so references are all valid on _ready()
to_add.push_back(n);
Add a map of autoloads to ProjectSettings So places that need to look into it can use the list instead of parsing ProjectSettings details (like checking "*" in path for testing if it's singleton).
2020-06-17 23:45:08 +00:00
if (info.is_singleton) {
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
Add a map of autoloads to ProjectSettings So places that need to look into it can use the list instead of parsing ProjectSettings details (like checking "*" in path for testing if it's singleton).
2020-06-17 23:45:08 +00:00
ScriptServer::get_language(i)->add_global_constant(info.name, n);
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
}
}
}
Use C++ iterators for Lists in many situations
2021-07-16 03:45:57 +00:00
for (Node *E : to_add) {
sml->get_root()->add_child(E);
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
}
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_end_measure(); // load autoloads
Enable autoload in editor - Tool scripts will be executed and can be accessed by plugins. - Other script languages can implement add/remove_named_global_constant to make use of this functionality.
2018-05-01 14:06:23 +00:00
}
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
EditorNode *editor_node = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (editor) {
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_begin_measure("editor");
remove trailing whitespace
2016-03-08 23:00:52 +00:00
editor_node = memnew(EditorNode);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
sml->get_root()->add_child(editor_node);
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!_export_preset.is_empty()) {
Be stricter on what's considered a scene path in CLI argument parsing This closes #8721.
2019-10-29 00:42:57 +00:00
editor_node->export_preset(_export_preset, positional_arg, export_debug, export_pack_only);
Export: Improve usability of command line interface I'm barely scratching the surface of the changes needed to make the --export command line interface easy to use, but this should already improve things somewhat. - Streamline `can_export()` templates check in all platforms, checking first for the presence of official templates, then of any defined custom template, and reporting on the absence of any. Shouldn't change the actual return value much which is still true if either release or debug is usable - we might want to change that eventually and better validate against the requested target. - Fix discrepancy between platforms using `custom_package/debug` and `custom_template/debug` (resp. `release`). All now use `custom_template`, which will break compatibility for `export_presets.cfg` with earlier projects (but is easy to fix). - Use `can_export()` when attempting a command line export and report the same errors that would be shown in the editor. - Improve error reporting after a failed export attempt, handling missing template and invalid path more gracefully. - Cleanup of unused stuff in EditorNode around the export workflow. - Improve --export documentation in --help a bit. Fixes #16949 (at least many of the misunderstandings listed there). Fixes #18470.
2020-01-07 12:29:02 +00:00
game_path = ""; // Do not load anything.
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_end_measure();
editor_node->set_use_startup_benchmark(use_startup_benchmark, startup_benchmark_file);
// Editor takes over
use_startup_benchmark = false;
startup_benchmark_file = String();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
#endif
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "display/window/stretch/mode", PROPERTY_HINT_ENUM, "disabled,canvas_items,viewport"), "disabled");
GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "display/window/stretch/aspect", PROPERTY_HINT_ENUM, "ignore,keep,keep_width,keep_height,expand"), "keep");
GLOBAL_DEF_BASIC(PropertyInfo(Variant::FLOAT, "display/window/stretch/scale", PROPERTY_HINT_RANGE, "0.5,8.0,0.01"), 1.0);
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
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_BASIC("gui/common/snap_controls_to_pixels", true);
GLOBAL_DEF_BASIC("gui/fonts/dynamic_fonts/use_oversampling", true);
Add PropertyInfo overload for GLOBAL_DEF
2022-11-08 18:53:22 +00:00
GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "rendering/textures/canvas_textures/default_texture_filter", PROPERTY_HINT_ENUM, "Nearest,Linear,Linear Mipmap,Nearest Mipmap"), 1);
GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "rendering/textures/canvas_textures/default_texture_repeat", PROPERTY_HINT_ENUM, "Disable,Enable,Mirror"), 0);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
if (!editor && !project_manager) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
//standard helpers that can be changed from main config
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
String stretch_mode = GLOBAL_GET("display/window/stretch/mode");
String stretch_aspect = GLOBAL_GET("display/window/stretch/aspect");
Size2i stretch_size = Size2i(GLOBAL_GET("display/window/size/viewport_width"),
GLOBAL_GET("display/window/size/viewport_height"));
real_t stretch_scale = GLOBAL_GET("display/window/stretch/scale");
-Added google play services (needed for some stuff) -Added new screen resizing options, stretch_2d is removed, new much more flexible ones. -Fixed bug in viewport (can create more instances in 3d-in-2d demo now) -Can set android permissions and screen sizes manually in the export settings -Changed export templates extension to .tpz (too many people unzipped the manually..) -File dialog now ensures that the proper extension is used (will not allow to save without it) -Fixed bug that made collision exceptions not work in 2D
2014-04-15 01:43:44 +00:00
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
Window::ContentScaleMode cs_sm = Window::CONTENT_SCALE_MODE_DISABLED;
Fix content scale mode, closes #37941
2020-07-02 20:15:11 +00:00
if (stretch_mode == "canvas_items") {
cs_sm = Window::CONTENT_SCALE_MODE_CANVAS_ITEMS;
} else if (stretch_mode == "viewport") {
cs_sm = Window::CONTENT_SCALE_MODE_VIEWPORT;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
-Added google play services (needed for some stuff) -Added new screen resizing options, stretch_2d is removed, new much more flexible ones. -Fixed bug in viewport (can create more instances in 3d-in-2d demo now) -Can set android permissions and screen sizes manually in the export settings -Changed export templates extension to .tpz (too many people unzipped the manually..) -File dialog now ensures that the proper extension is used (will not allow to save without it) -Fixed bug that made collision exceptions not work in 2D
2014-04-15 01:43:44 +00:00
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
Window::ContentScaleAspect cs_aspect = Window::CONTENT_SCALE_ASPECT_IGNORE;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (stretch_aspect == "keep") {
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
cs_aspect = Window::CONTENT_SCALE_ASPECT_KEEP;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
} else if (stretch_aspect == "keep_width") {
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
cs_aspect = Window::CONTENT_SCALE_ASPECT_KEEP_WIDTH;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
} else if (stretch_aspect == "keep_height") {
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
cs_aspect = Window::CONTENT_SCALE_ASPECT_KEEP_HEIGHT;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
} else if (stretch_aspect == "expand") {
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
cs_aspect = Window::CONTENT_SCALE_ASPECT_EXPAND;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
-Added google play services (needed for some stuff) -Added new screen resizing options, stretch_2d is removed, new much more flexible ones. -Fixed bug in viewport (can create more instances in 3d-in-2d demo now) -Can set android permissions and screen sizes manually in the export settings -Changed export templates extension to .tpz (too many people unzipped the manually..) -File dialog now ensures that the proper extension is used (will not allow to save without it) -Fixed bug that made collision exceptions not work in 2D
2014-04-15 01:43:44 +00:00
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
sml->get_root()->set_content_scale_mode(cs_sm);
sml->get_root()->set_content_scale_aspect(cs_aspect);
sml->get_root()->set_content_scale_size(stretch_size);
add 2d scale factor property
2021-12-17 12:11:19 +00:00
sml->get_root()->set_content_scale_factor(stretch_scale);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
sml->set_auto_accept_quit(GLOBAL_GET("application/config/auto_accept_quit"));
sml->set_quit_on_go_back(GLOBAL_GET("application/config/quit_on_go_back"));
Unify usage of GLOBAL/EDITOR_GET
2022-10-18 14:43:37 +00:00
String appname = GLOBAL_GET("application/config/name");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
appname = TranslationServer::get_singleton()->translate(appname);
Add a suffix to the window title when running from a debug build Since projects started from the editor or exported in debug mode run slower than those exported in release mode, this should be clearly presented to the user. This partially addresses #20219.
2020-06-16 09:27:46 +00:00
#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.
DisplayServer::get_singleton()->window_set_title(vformat("%s (DEBUG)", appname));
#else
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->window_set_title(appname);
Add a suffix to the window title when running from a debug build Since projects started from the editor or exported in debug mode run slower than those exported in release mode, this should be clearly presented to the user. This partially addresses #20219.
2020-06-16 09:27:46 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
bool snap_controls = GLOBAL_GET("gui/common/snap_controls_to_pixels");
Restored auto snapping of controls to pixels, fixes #10847 and probably several more issues. Made it optional in the project settings but defaults to true.
2017-09-07 14:22:07 +00:00
sml->get_root()->set_snap_controls_to_pixels(snap_controls);
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
bool font_oversampling = GLOBAL_GET("gui/fonts/dynamic_fonts/use_oversampling");
Added a Window node, and made it the scene root. Still a lot of work to do.
2020-03-04 01:51:12 +00:00
sml->get_root()->set_use_font_oversampling(font_oversampling);
Added font oversampling support
2017-12-19 21:48:30 +00:00
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
int texture_filter = GLOBAL_GET("rendering/textures/canvas_textures/default_texture_filter");
int texture_repeat = GLOBAL_GET("rendering/textures/canvas_textures/default_texture_repeat");
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
sml->get_root()->set_default_canvas_item_texture_filter(
Viewport::DefaultCanvasItemTextureFilter(texture_filter));
sml->get_root()->set_default_canvas_item_texture_repeat(
Viewport::DefaultCanvasItemTextureRepeat(texture_repeat));
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Fix editor ignoring 'single_window_mode' with no main scene Previously the editor would ignore the 'single_window_mode' editor setting if the edited project didn't have a main scene configured in the project settings.
2020-05-21 23:55:28 +00:00
#ifdef TOOLS_ENABLED
if (editor) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
bool editor_embed_subwindows = EditorSettings::get_singleton()->get_setting(
"interface/editor/single_window_mode");
Fix editor ignoring 'single_window_mode' with no main scene Previously the editor would ignore the 'single_window_mode' editor setting if the edited project didn't have a main scene configured in the project settings.
2020-05-21 23:55:28 +00:00
if (editor_embed_subwindows) {
Cleanup embed subwindows getters
2022-03-13 15:18:44 +00:00
sml->get_root()->set_embedding_subwindows(true);
Fix editor ignoring 'single_window_mode' with no main scene Previously the editor would ignore the 'single_window_mode' editor setting if the edited project didn't have a main scene configured in the project settings.
2020-05-21 23:55:28 +00:00
}
}
#endif
enable autoload for command-line scripts fixes #6360
2016-09-06 16:45:35 +00:00
String local_game_path;
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!game_path.is_empty() && !project_manager) {
enable autoload for command-line scripts fixes #6360
2016-09-06 16:45:35 +00:00
local_game_path = game_path.replace("\\", "/");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (!local_game_path.begins_with("res://")) {
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
bool absolute =
(local_game_path.size() > 1) && (local_game_path[0] == '/' || local_game_path[1] == ':');
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if (!absolute) {
-Renamed GlobalConfig to ProjectSettings, makes more sense. -Added system for feature overrides, it's pretty cool :)
2017-07-19 20:00:46 +00:00
if (ProjectSettings::get_singleton()->is_using_datapack()) {
-improved physics ccd -html5 exporter works again -disable repeat on image loader by default -can change shape offset en tileset, texture offset was broken
2014-02-19 14:57:14 +00:00
local_game_path = "res://" + local_game_path;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
-improved physics ccd -html5 exporter works again -disable repeat on image loader by default -can change shape offset en tileset, texture offset was broken
2014-02-19 14:57:14 +00:00
} else {
Remove String::find_last (same as rfind)
2020-07-03 13:26:22 +00:00
int sep = local_game_path.rfind("/");
-improved physics ccd -html5 exporter works again -disable repeat on image loader by default -can change shape offset en tileset, texture offset was broken
2014-02-19 14:57:14 +00:00
if (sep == -1) {
Make FileAccess and DirAccess classes reference counted.
2022-03-23 09:08:58 +00:00
Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
Rename String `plus_file` to `path_join`
2022-08-30 00:34:01 +00:00
local_game_path = da->get_current_dir().path_join(local_game_path);
-improved physics ccd -html5 exporter works again -disable repeat on image loader by default -can change shape offset en tileset, texture offset was broken
2014-02-19 14:57:14 +00:00
} else {
Make FileAccess and DirAccess classes reference counted.
2022-03-23 09:08:58 +00:00
Ref<DirAccess> da = DirAccess::open(local_game_path.substr(0, sep));
if (da.is_valid()) {
Rename String `plus_file` to `path_join`
2022-08-30 00:34:01 +00:00
local_game_path = da->get_current_dir().path_join(
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
local_game_path.substr(sep + 1, local_game_path.length()));
-improved physics ccd -html5 exporter works again -disable repeat on image loader by default -can change shape offset en tileset, texture offset was broken
2014-02-19 14:57:14 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
}
}
}
-Renamed GlobalConfig to ProjectSettings, makes more sense. -Added system for feature overrides, it's pretty cool :)
2017-07-19 20:00:46 +00:00
local_game_path = ProjectSettings::get_singleton()->localize_path(local_game_path);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
if (editor) {
Refactored Variant Operators. -Using classes to call and a table -For typed code (GDS or GDNative), can obtain functions to call prevalidated or ptr.
2020-11-05 02:01:55 +00:00
if (game_path != String(GLOBAL_GET("application/run/main_scene")) || !editor_node->has_scenes_in_session()) {
Editor: Skip loading main scene if restore_scenes_on_load is used
2018-09-21 03:14:04 +00:00
Error serr = editor_node->load_scene(local_game_path);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (serr != OK) {
Editor: Skip loading main scene if restore_scenes_on_load is used
2018-09-21 03:14:04 +00:00
ERR_PRINT("Failed to load scene");
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Editor: Skip loading main scene if restore_scenes_on_load is used
2018-09-21 03:14:04 +00:00
}
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->set_context(DisplayServer::CONTEXT_EDITOR);
[Editor] Add "--debug-server <uri>" option. Allow starting the editor debugger server for the given protocol (and optionally bound to the given ip/port combination: godot -e --debug-server tcp://*:8080
2021-08-28 23:58:15 +00:00
if (!debug_server_uri.is_empty()) {
EditorDebuggerNode::get_singleton()->start(debug_server_uri);
[Editor] Add button to keep the debug server open. The setting is stored in the project editor metadata, and the server is automatically started/stopped when the option change (only stopped if no session is currently active). The CLI option `--debug-server` now also forces the server to stay open (without saving the state, unlike the menu option). This commit also removes the "Keep debugger open" option in the script editor "debug" menu. That option was really confusing, it used to hide the bottom panel if and only if the debugger pane was selected, so if you had your output log open instead (default when pressing play) it would effectively do nothing. Having an option to save a click in such a very specific case seems very overkill.
2022-11-24 21:03:29 +00:00
EditorDebuggerNode::get_singleton()->set_keep_open(true);
[Editor] Add "--debug-server <uri>" option. Allow starting the editor debugger server for the given protocol (and optionally bound to the given ip/port combination: godot -e --debug-server tcp://*:8080
2021-08-28 23:58:15 +00:00
}
enable autoload for command-line scripts fixes #6360
2016-09-06 16:45:35 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
[x11] Use "application/config/name" for WM_CLASS
2018-10-05 20:18:10 +00:00
if (!editor) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->set_context(DisplayServer::CONTEXT_ENGINE);
[x11] Use "application/config/name" for WM_CLASS
2018-10-05 20:18:10 +00:00
}
enable autoload for command-line scripts fixes #6360
2016-09-06 16:45:35 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Prevent loading project-specific config in Project Manager The Project Manager should share the same settings as the editor most of the time. The whole init stuff with Main::setup and Main::start needs a good cleanup though. Fixes #15199.
2018-02-19 12:31:06 +00:00
if (!project_manager && !editor) { // game
Allow system certs file to be used by Editor. Note, it will only used by the Editor, not when running the game. This allows package maintainer to compile Godot to use system installed certificates when accessing the AssetLib.
2018-09-15 12:45:54 +00:00
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_begin_measure("game_load");
Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in "main" and "servers" directories
2019-08-08 20:08:27 +00:00
// Load SSL Certificates from Project Settings (or builtin).
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
Crypto::load_default_certificates(GLOBAL_GET("network/tls/certificate_bundle_override"));
Allow system certs file to be used by Editor. Note, it will only used by the Editor, not when running the game. This allows package maintainer to compile Godot to use system installed certificates when accessing the AssetLib.
2018-09-15 12:45:54 +00:00
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!game_path.is_empty()) {
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
Node *scene = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<PackedScene> scenedata = ResourceLoader::load(local_game_path);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (scenedata.is_valid()) {
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
scene = scenedata->instantiate();
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in "main" and "servers" directories
2019-08-08 20:08:27 +00:00
ERR_FAIL_COND_V_MSG(!scene, false, "Failed loading scene: " + local_game_path);
added a built-in scene changer API, closes #1928
2015-05-17 19:33:35 +00:00
sml->add_current_scene(scene);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rename OSX to macOS and iPhoneOS to iOS.
2022-07-20 06:28:22 +00:00
#ifdef MACOS_ENABLED
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
String mac_iconpath = GLOBAL_GET("application/config/macos_native_icon");
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!mac_iconpath.is_empty()) {
Add macOS DisplayServer implementation. Change global menu to use Callable, add support for check items and submenus.
2020-03-07 16:02:54 +00:00
DisplayServer::get_singleton()->set_native_icon(mac_iconpath);
Add native window/taskbar icon support for Windows and macOS. Co-authored-by: Markus Törnqvist <mjt@nysv.org>
2019-05-17 13:43:56 +00:00
hasicon = true;
}
#endif
#ifdef WINDOWS_ENABLED
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
String win_iconpath = GLOBAL_GET("application/config/windows_native_icon");
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if (!win_iconpath.is_empty()) {
Separate DisplayServer from OS on Windows
2020-03-09 15:56:48 +00:00
DisplayServer::get_singleton()->set_native_icon(win_iconpath);
Add native window/taskbar icon support for Windows and macOS. Co-authored-by: Markus Törnqvist <mjt@nysv.org>
2019-05-17 13:43:56 +00:00
hasicon = true;
}
#endif
Remove duplicate project settings definitions
2022-10-20 13:43:17 +00:00
String iconpath = GLOBAL_GET("application/config/icon");
Replace String comparisons with "", String() to is_empty() Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-09 09:42:46 +00:00
if ((!iconpath.is_empty()) && (!hasicon)) {
Removal of Image from Variant, converted to a Resource.
2017-05-17 10:36:47 +00:00
Ref<Image> icon;
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
icon.instantiate();
Main: Use ImageLoader directly instead of Image::load Image::load is now issuing warnings (since ef50957) to prevent users from using it to load images at runtime which would be included in their exported game. So we now use ImageLoader explicitly instead for the custom-handled cases in Main. Fixes #21072, supersedes #22321.
2018-09-30 15:21:07 +00:00
if (ImageLoader::load_image(iconpath, icon) == OK) {
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->set_icon(icon);
Fix setting the default icon briefly with tools=no
2017-09-15 16:41:11 +00:00
hasicon = true;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
}
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_end_measure(); // game_load
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
#ifdef TOOLS_ENABLED
Main: Fixup bogus fallback to project manager with more bolognese WARNING: Hacks everywhere! The logic in `main.cpp` is due a full rewrite as it's extremely hacky, splitting argument parsing over several functions, with a mess of global state and assumptions about what combinations of arguments or lack thereof should mean in terms of what we want to read: game, editor, project manager, or command line tools such as `--doctool`, `--export` or `--script`. Until this is fully rewritten, this patch hacks things some more to ensure that we don't fall back to the project manager in cases where it's not warranted, and especially not *too late*, as it can mean that we haven't properly initialized stuff like `EditorPaths` needed by the PM (which in turn impacts what kind of path will be used for logs and the shader cache, etc... the rabbit hole goes deep). Fixes #41435. Fixes #49392. Fixes #49658. Fixes https://github.com/godotengine/godot/issues/38202#issuecomment-773158477.
2021-06-16 17:08:29 +00:00
if (project_manager) {
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_begin_measure("project_manager");
Make sure project manager gets editor hint set Previous fix in e8e06b2 worked in most cases but not if you run e.g. 'godot -', where the '-' argument would mean that 'project_manager' is false and yet that's what will be opened eventually.
2018-09-10 12:53:31 +00:00
Engine::get_singleton()->set_editor_hint(true);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
ProjectManager *pmanager = memnew(ProjectManager);
Fix crash on asset lib install This is not the perfect solution, but fixes the crash and avoid a dependency on EditorNode.
2016-07-10 20:19:19 +00:00
ProgressDialog *progress_dialog = memnew(ProgressDialog);
pmanager->add_child(progress_dialog);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
sml->get_root()->add_child(pmanager);
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->set_context(DisplayServer::CONTEXT_PROJECTMAN);
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
Engine::get_singleton()->startup_benchmark_end_measure();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Allow system certs file to be used by Editor. Note, it will only used by the Editor, not when running the game. This allows package maintainer to compile Godot to use system installed certificates when accessing the AssetLib.
2018-09-15 12:45:54 +00:00
if (project_manager || editor) {
Rewrite StreamPeerSSL with SSLContext helper class connect_to_stream now accepts optional parameter to specify which certificates to trust. Implement accept_stream (SSL server) with key/cert parameters to specify the RSA key and X509 certificate resources.
2019-07-19 13:29:57 +00:00
// Load SSL Certificates from Editor Settings (or builtin)
Refactor editor paths validation in EditorPaths and EditorSettings - EditorSettings: Ensure that `create()` makes a valid singleton. Fixes #49179, fixes #49450. - EditorPaths: Cleanup code, properly set `paths_valid`. - EditorPaths: Move more paths validation (check, mkdir) from EditorSettings for a better separation of concerns. - EditorPaths: Move EditorFileSystem creation of `.godot/imported` next to other paths.
2021-06-09 08:47:32 +00:00
Crypto::load_default_certificates(
[Net] Rename "ssl" references to "tls" in methods and members.
2022-09-07 06:25:47 +00:00
EditorSettings::get_singleton()->get_setting("network/tls/editor_tls_certificates").operator String());
Rewrite StreamPeerSSL with SSLContext helper class connect_to_stream now accepts optional parameter to specify which certificates to trust. Implement accept_stream (SSL server) with key/cert parameters to specify the RSA key and X509 certificate resources.
2019-07-19 13:29:57 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
}
[macOS] Prefer .app bundle icon over the default one.
2021-05-13 06:25:09 +00:00
if (!hasicon && OS::get_singleton()->get_bundle_icon_path().is_empty()) {
Fix setting the default icon briefly with tools=no
2017-09-15 16:41:11 +00:00
Ref<Image> icon = memnew(Image(app_icon_png));
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
DisplayServer::get_singleton()->set_icon(icon);
Fix setting the default icon briefly with tools=no
2017-09-15 16:41:11 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->set_main_loop(main_loop);
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
if (movie_writer) {
Add a Movie Quit On Finish property to AnimationPlayer This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-06-25 23:38:20 +00:00
movie_writer->begin(DisplayServer::get_singleton()->window_get_size(), fixed_fps, Engine::get_singleton()->get_write_movie_path());
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
}
Add boot splash display time setting Implements #8867.
2022-06-28 15:13:00 +00: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);
}
}
Add Startup benchmarking support This adds support for benchmarking engine startup (and editor startup if used). The goal is to use this in the benchmarking server to track improvements and changes to engine, editor, importer and scene loading startup times.
2022-08-19 12:21:43 +00:00
if (use_startup_benchmark) {
Engine::get_singleton()->startup_dump(startup_benchmark_file);
startup_benchmark_file = String();
}
Fix arguments always being found and returned some items back to normal
2020-07-24 13:16:02 +00:00
return true;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
/* 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.
*/
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
uint64_t Main::last_ticks = 0;
Revert "Make the performance reporting update frequency customizable"
2018-05-28 11:47:09 +00:00
uint32_t Main::frames = 0;
Hide the first `--print-fps` outputs after the engine has started The first 2 or 3 prints are inaccurate since the engine has just started at that point.
2022-04-11 22:23:22 +00:00
uint32_t Main::hide_print_fps_attempts = 3;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
uint32_t Main::frame = 0;
bool Main::force_redraw_requested = false;
Make recursive nature of iteration not fail.
2019-01-24 16:09:05 +00:00
int Main::iterating = 0;
Add project setting for agile input event flushing If enabled, key/touch/joystick events will be flushed just before every idle and physics frame. Enabling this can greatly improve the responsiveness to input, specially in devices that need to run multiple physics frames per each idle frame, because of not being powerful enough to run at the target frame rate. This will only work for platforms using input buffering (regardless event accumulation). Currenly, only Android does so, but could be implemented for iOS in an upcoming PR.
2020-09-20 23:35:20 +00:00
bool Main::agile_input_event_flushing = false;
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
Avoid cyclic iteration check, fixes #24969
2019-01-22 16:17:39 +00:00
bool Main::is_iterating() {
Make recursive nature of iteration not fail.
2019-01-24 16:09:05 +00:00
return iterating > 0;
Avoid cyclic iteration check, fixes #24969
2019-01-22 16:17:39 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in "main" and "servers" directories
2019-08-08 20:08:27 +00:00
// For performance metrics.
Renamed fixed_process to physics_process
2017-09-30 14:19:07 +00:00
static uint64_t physics_process_max = 0;
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
static uint64_t process_max = 0;
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
static uint64_t navigation_process_max = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool Main::iteration() {
Do not fail on recursive iteration. Not ideal but should work for now and not crash. Fixes #25272 Eventually some sort of main even queue should be implemented to do this properly.
2019-01-24 15:42:05 +00:00
//for now do not error on this
//ERR_FAIL_COND_V(iterating, false);
Avoid cyclic iteration check, fixes #24969
2019-01-22 16:17:39 +00:00
Make recursive nature of iteration not fail.
2019-01-24 16:09:05 +00:00
iterating++;
Avoid cyclic iteration check, fixes #24969
2019-01-22 16:17:39 +00:00
Fix some LGTM errors of "Multiplication result converted to larger type"
2021-09-08 04:25:35 +00:00
const uint64_t ticks = OS::get_singleton()->get_ticks_usec();
Lots of work on Audio & Physics engine: -Added new 3D stream player node -Added ability for Area to capture sound from streams -Added small features in physics to be able to properly guess distance to areas for sound -Fixed 3D CollisionObject so shapes are added the same as in 2D, directly from children -Fixed KinematicBody API to make it the same as 2D.
2017-07-15 04:23:10 +00:00
Engine::get_singleton()->_frame_ticks = ticks;
-New inspector. -Changed UI resizing code, gained huge amount of speed. -Reorganized timer sync to clean up behavior (sorry forgot commit this before) -
2018-05-15 20:12:35 +00:00
main_timer_sync.set_cpu_ticks_usec(ticks);
main_timer_sync.set_fixed_fps(fixed_fps);
Lots of work on Audio & Physics engine: -Added new 3D stream player node -Added ability for Area to capture sound from streams -Added small features in physics to be able to properly guess distance to areas for sound -Fixed 3D CollisionObject so shapes are added the same as in 2D, directly from children -Fixed KinematicBody API to make it the same as 2D.
2017-07-15 04:23:10 +00:00
Fix some LGTM errors of "Multiplication result converted to larger type"
2021-09-08 04:25:35 +00:00
const uint64_t ticks_elapsed = ticks - last_ticks;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fix some LGTM errors of "Multiplication result converted to larger type"
2021-09-08 04:25:35 +00:00
const int physics_ticks_per_second = Engine::get_singleton()->get_physics_ticks_per_second();
const double physics_step = 1.0 / physics_ticks_per_second;
Renderer/Simulator flags Now hopefully with correct code style
2017-08-30 10:40:35 +00:00
Fix some LGTM errors of "Multiplication result converted to larger type"
2021-09-08 04:25:35 +00:00
const double time_scale = Engine::get_singleton()->get_time_scale();
Rasterizers are now in sync with engine The rasterisers (both GLES3 and GLES2) were calculating their own frame delta time This fix lets the rasterizers get the frame delta through the draw call That way any regulations to the frame step from the main script will not cause particle systems to process at a different step than the rest of the Engine. Remove unused rasterizer storage variable frame.prev_tick variable were not used anywhere and has been removed
2018-05-09 06:11:43 +00:00
Rename `iterations_per_second` to `physics_ticks_per_second` This makes it clearer that this property is only about physics FPS, not rendering FPS. The `physics_fps` project setting was also renamed to `physics_ticks_per_second` for consistency.
2021-08-11 00:35:16 +00:00
MainFrameTime advance = main_timer_sync.advance(physics_step, physics_ticks_per_second);
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
double process_step = advance.process_step;
double scaled_step = process_step * time_scale;
Fix clipping when used in viewport or inside another viewport, fixes #1661
2015-04-15 01:05:14 +00:00
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
Engine::get_singleton()->_process_step = process_step;
Add access to interpolation fraction for fixed timestep interpolation Addresses #30068 This is a prerequisite for allowing proper support for fixed timestep interpolation, exposing the interpolation fraction to the engine, modules and gdscript. The interpolation fraction is the fraction through the current physics tick at the time of the current frame.
2019-07-01 16:42:02 +00:00
Engine::get_singleton()->_physics_interpolation_fraction = advance.interpolation_fraction;
Lots of work on Audio & Physics engine: -Added new 3D stream player node -Added ability for Area to capture sound from streams -Added small features in physics to be able to properly guess distance to areas for sound -Fixed 3D CollisionObject so shapes are added the same as in 2D, directly from children -Fixed KinematicBody API to make it the same as 2D.
2017-07-15 04:23:10 +00:00
Renamed fixed_process to physics_process
2017-09-30 14:19:07 +00:00
uint64_t physics_process_ticks = 0;
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
uint64_t process_ticks = 0;
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
uint64_t navigation_process_ticks = 0;
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
frame += ticks_elapsed;
last_ticks = ticks;
Implement adjusting the maximum number of physics steps per rendered frame When using high physics FPS (which is a requirement to minimize input lag and improve precision in simulation racing games), a higher value prevents the game from slowing down at low rendering FPS. This can be done via an Engine property for run-time changes, or a project setting for initial changes.
2022-09-15 16:57:34 +00:00
const int max_physics_steps = Engine::get_singleton()->get_max_physics_steps_per_frame();
Add hysteresis to physics timestep count per frame Add new class _TimerSync to manage timestep calculations. The new class handles the decisions about simulation progression previously handled by main::iteration(). It is fed the current timer ticks and determines how many physics updates are to be run and what the delta argument to the _process() functions should be. The new class tries to keep the number of physics updates per frame as constant as possible from frame to frame. Ideally, it would be N steps every render frame, but even with perfectly regular rendering, the general case is that N or N+1 steps are required per frame, for some fixed N. The best guess for N is stored in typical_physics_steps. When determining the number of steps to take, no restrictions are imposed between the choice of typical_physics_steps and typical_physics_steps+1 steps. Should more or less steps than that be required, the accumulated remaining time (as before, stored in time_accum) needs to surpass its boundaries by some minimal threshold. Once surpassed, typical_physics_steps is updated to allow the new step count for future updates. Care is taken that the modified calculation of the number of physics steps is not observable from game code that only checks the delta parameters to the _process and _physics_process functions; in addition to modifying the number of steps, the _process argument is modified as well to stay in expected bounds. Extra care is taken that the accumulated steps still sum up to roughly the real elapsed time, up to a maximum tolerated difference. To allow the hysteresis code to work correctly on higher refresh monitors, the number of typical physics steps is not only recorded and kept consistent for single render frames, but for groups of them. Currently, up to 12 frames are grouped that way. The engine parameter physics_jitter_fix controls both the maximum tolerated difference between wall clock time and summed up _process arguments and the threshold for changing typical_physics_steps. It is given in units of the real physics frame slice 1/physics_fps. Set physics_jitter_fix to 0 to disable the effects of the new code here. It starts to be effective against the random physics jitter at around 0.02 to 0.05. at values greater than 1 it starts having ill effects on the engine's ability to react sensibly to dropped frames and framerate changes.
2018-02-10 23:03:31 +00:00
if (fixed_fps == -1 && advance.physics_steps > max_physics_steps) {
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
process_step -= (advance.physics_steps - max_physics_steps) * physics_step;
Add hysteresis to physics timestep count per frame Add new class _TimerSync to manage timestep calculations. The new class handles the decisions about simulation progression previously handled by main::iteration(). It is fed the current timer ticks and determines how many physics updates are to be run and what the delta argument to the _process() functions should be. The new class tries to keep the number of physics updates per frame as constant as possible from frame to frame. Ideally, it would be N steps every render frame, but even with perfectly regular rendering, the general case is that N or N+1 steps are required per frame, for some fixed N. The best guess for N is stored in typical_physics_steps. When determining the number of steps to take, no restrictions are imposed between the choice of typical_physics_steps and typical_physics_steps+1 steps. Should more or less steps than that be required, the accumulated remaining time (as before, stored in time_accum) needs to surpass its boundaries by some minimal threshold. Once surpassed, typical_physics_steps is updated to allow the new step count for future updates. Care is taken that the modified calculation of the number of physics steps is not observable from game code that only checks the delta parameters to the _process and _physics_process functions; in addition to modifying the number of steps, the _process argument is modified as well to stay in expected bounds. Extra care is taken that the accumulated steps still sum up to roughly the real elapsed time, up to a maximum tolerated difference. To allow the hysteresis code to work correctly on higher refresh monitors, the number of typical physics steps is not only recorded and kept consistent for single render frames, but for groups of them. Currently, up to 12 frames are grouped that way. The engine parameter physics_jitter_fix controls both the maximum tolerated difference between wall clock time and summed up _process arguments and the threshold for changing typical_physics_steps. It is given in units of the real physics frame slice 1/physics_fps. Set physics_jitter_fix to 0 to disable the effects of the new code here. It starts to be effective against the random physics jitter at around 0.02 to 0.05. at values greater than 1 it starts having ill effects on the engine's ability to react sensibly to dropped frames and framerate changes.
2018-02-10 23:03:31 +00:00
advance.physics_steps = max_physics_steps;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool exit = false;
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
// process all our active interfaces
XRServer::get_singleton()->_process();
Add hysteresis to physics timestep count per frame Add new class _TimerSync to manage timestep calculations. The new class handles the decisions about simulation progression previously handled by main::iteration(). It is fed the current timer ticks and determines how many physics updates are to be run and what the delta argument to the _process() functions should be. The new class tries to keep the number of physics updates per frame as constant as possible from frame to frame. Ideally, it would be N steps every render frame, but even with perfectly regular rendering, the general case is that N or N+1 steps are required per frame, for some fixed N. The best guess for N is stored in typical_physics_steps. When determining the number of steps to take, no restrictions are imposed between the choice of typical_physics_steps and typical_physics_steps+1 steps. Should more or less steps than that be required, the accumulated remaining time (as before, stored in time_accum) needs to surpass its boundaries by some minimal threshold. Once surpassed, typical_physics_steps is updated to allow the new step count for future updates. Care is taken that the modified calculation of the number of physics steps is not observable from game code that only checks the delta parameters to the _process and _physics_process functions; in addition to modifying the number of steps, the _process argument is modified as well to stay in expected bounds. Extra care is taken that the accumulated steps still sum up to roughly the real elapsed time, up to a maximum tolerated difference. To allow the hysteresis code to work correctly on higher refresh monitors, the number of typical physics steps is not only recorded and kept consistent for single render frames, but for groups of them. Currently, up to 12 frames are grouped that way. The engine parameter physics_jitter_fix controls both the maximum tolerated difference between wall clock time and summed up _process arguments and the threshold for changing typical_physics_steps. It is given in units of the real physics frame slice 1/physics_fps. Set physics_jitter_fix to 0 to disable the effects of the new code here. It starts to be effective against the random physics jitter at around 0.02 to 0.05. at values greater than 1 it starts having ill effects on the engine's ability to react sensibly to dropped frames and framerate changes.
2018-02-10 23:03:31 +00:00
for (int iters = 0; iters < advance.physics_steps; ++iters) {
Add project setting for agile input event flushing If enabled, key/touch/joystick events will be flushed just before every idle and physics frame. Enabling this can greatly improve the responsiveness to input, specially in devices that need to run multiple physics frames per each idle frame, because of not being powerful enough to run at the target frame rate. This will only work for platforms using input buffering (regardless event accumulation). Currenly, only Android does so, but could be implemented for iOS in an upcoming PR.
2020-09-20 23:35:20 +00:00
if (Input::get_singleton()->is_using_input_buffering() && agile_input_event_flushing) {
Input::get_singleton()->flush_buffered_events();
}
Engine::get_singleton()->_in_physics = true;
Refactor Fixed to Physics
2017-10-21 14:28:08 +00:00
uint64_t physics_begin = OS::get_singleton()->get_ticks_usec();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Make Servers truly Thread Safe -Rendering server now uses a split RID allocate/initialize internally, this allows generating RIDs immediately but initialization to happen later on the proper thread (as rendering APIs generally requiere to call on the right thread). -RenderingServerWrapMT is no more, multithreading is done in RenderingServerDefault. -Some functions like texture or mesh creation, when renderer supports it, can register and return immediately (so no waiting for server API to flush, and saving staging and command buffer memory). -3D physics server changed to be made multithread friendly. -Added PhysicsServer3DWrapMT to use 3D physics server from multiple threads. -Disablet Bullet (too much effort to make multithread friendly, this needs to be fixed eventually).
2021-02-09 16:19:03 +00:00
PhysicsServer3D::get_singleton()->sync();
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
PhysicsServer3D::get_singleton()->flush_queries();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
PhysicsServer2D::get_singleton()->sync();
PhysicsServer2D::get_singleton()->flush_queries();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
if (OS::get_singleton()->get_main_loop()->physics_process(physics_step * time_scale)) {
Make physics servers `end_sync` on exit
2023-01-17 13:04:19 +00:00
PhysicsServer3D::get_singleton()->end_sync();
PhysicsServer2D::get_singleton()->end_sync();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
exit = true;
break;
}
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
uint64_t navigation_begin = OS::get_singleton()->get_ticks_usec();
NavigationServer3D::get_singleton()->process(physics_step * time_scale);
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);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Flushes commands just before the navigation server is destroyed
2020-02-26 08:42:51 +00:00
message_queue->flush();
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Make Servers truly Thread Safe -Rendering server now uses a split RID allocate/initialize internally, this allows generating RIDs immediately but initialization to happen later on the proper thread (as rendering APIs generally requiere to call on the right thread). -RenderingServerWrapMT is no more, multithreading is done in RenderingServerDefault. -Some functions like texture or mesh creation, when renderer supports it, can register and return immediately (so no waiting for server API to flush, and saving staging and command buffer memory). -3D physics server changed to be made multithread friendly. -Added PhysicsServer3DWrapMT to use 3D physics server from multiple threads. -Disablet Bullet (too much effort to make multithread friendly, this needs to be fixed eventually).
2021-02-09 16:19:03 +00:00
PhysicsServer3D::get_singleton()->end_sync();
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
PhysicsServer3D::get_singleton()->step(physics_step * time_scale);
ability to run 2D physics in a thread also, 2D physics is now thread safe too. see physics_2d/thread_model
2015-05-26 04:05:08 +00:00
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
PhysicsServer2D::get_singleton()->end_sync();
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
PhysicsServer2D::get_singleton()->step(physics_step * time_scale);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
message_queue->flush();
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
physics_process_ticks = MAX(physics_process_ticks, OS::get_singleton()->get_ticks_usec() - physics_begin); // keep the largest one for reference
Refactor Fixed to Physics
2017-10-21 14:28:08 +00:00
physics_process_max = MAX(OS::get_singleton()->get_ticks_usec() - physics_begin, physics_process_max);
Renamed fixed_process to physics_process
2017-09-30 14:19:07 +00:00
Engine::get_singleton()->_physics_frames++;
Add project setting for agile input event flushing If enabled, key/touch/joystick events will be flushed just before every idle and physics frame. Enabling this can greatly improve the responsiveness to input, specially in devices that need to run multiple physics frames per each idle frame, because of not being powerful enough to run at the target frame rate. This will only work for platforms using input buffering (regardless event accumulation). Currenly, only Android does so, but could be implemented for iOS in an upcoming PR.
2020-09-20 23:35:20 +00:00
Engine::get_singleton()->_in_physics = false;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Add project setting for agile input event flushing If enabled, key/touch/joystick events will be flushed just before every idle and physics frame. Enabling this can greatly improve the responsiveness to input, specially in devices that need to run multiple physics frames per each idle frame, because of not being powerful enough to run at the target frame rate. This will only work for platforms using input buffering (regardless event accumulation). Currenly, only Android does so, but could be implemented for iOS in an upcoming PR.
2020-09-20 23:35:20 +00:00
if (Input::get_singleton()->is_using_input_buffering() && agile_input_event_flushing) {
Input::get_singleton()->flush_buffered_events();
}
-Modified Input and added is_action_just_pressed() as well as is_action_just_released()
2016-09-01 21:58:52 +00:00
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
uint64_t process_begin = OS::get_singleton()->get_ticks_usec();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
if (OS::get_singleton()->get_main_loop()->process(process_step * time_scale)) {
Fixes physic_fps=0 bug. Added a condition to check if the loop exited without iteration being run by checking the return value from idle(). Fixes: #26321
2019-03-09 11:36:37 +00:00
exit = true;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
message_queue->flush();
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
RenderingServer::get_singleton()->sync(); //sync if still drawing from previous frames.
-fixed many memory initialization issues -fixed deadlock on previews thread -fixed compilation errors on unix
2015-06-07 01:06:58 +00:00
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
if (DisplayServer::get_singleton()->can_any_window_draw() &&
RenderingServer::get_singleton()->is_render_loop_enabled()) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
if ((!force_redraw_requested) && OS::get_singleton()->is_in_low_processor_usage_mode()) {
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
if (RenderingServer::get_singleton()->has_changed()) {
RenderingServer::get_singleton()->draw(true, scaled_step); // flush visual commands
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
Engine::get_singleton()->frames_drawn++;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
} else {
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
RenderingServer::get_singleton()->draw(true, scaled_step); // flush visual commands
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
Engine::get_singleton()->frames_drawn++;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
force_redraw_requested = false;
}
}
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
process_ticks = OS::get_singleton()->get_ticks_usec() - process_begin;
process_max = MAX(process_ticks, process_max);
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
uint64_t frame_time = OS::get_singleton()->get_ticks_usec() - ticks;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
ScriptServer::get_language(i)->frame();
}
Add Audio Server profiling time to the profiler
2018-06-21 00:02:02 +00:00
AudioServer::get_singleton()->update();
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (EngineDebugger::is_active()) {
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
EngineDebugger::get_singleton()->iteration(frame_time, process_ticks, physics_process_ticks, physics_step);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Revert "Make the performance reporting update frequency customizable"
2018-05-28 11:47:09 +00:00
frames++;
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
Engine::get_singleton()->_process_frames++;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Revert "Make the performance reporting update frequency customizable"
2018-05-28 11:47:09 +00:00
if (frame > 1000000) {
Hide the first `--print-fps` outputs after the engine has started The first 2 or 3 prints are inaccurate since the engine has just started at that point.
2022-04-11 22:23:22 +00: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)));
Add --print-fps option to output FPS to stdout Works both for the editor and games. Projects can still use "debug/settings/stdout/print_fps" to enable it permanently. The --print-fps option takes precedence (so works even if the project setting is disabled). That setting is also no longer redefined on the fly based on the verbose flag, that was a mess.
2018-03-21 07:46:05 +00:00
}
Hide the first `--print-fps` outputs after the engine has started The first 2 or 3 prints are inaccurate since the engine has just started at that point.
2022-04-11 22:23:22 +00:00
} else {
hide_print_fps_attempts--;
Add --print-fps option to output FPS to stdout Works both for the editor and games. Projects can still use "debug/settings/stdout/print_fps" to enable it permanently. The --print-fps option takes precedence (so works even if the project setting is disabled). That setting is also no longer redefined on the fly based on the verbose flag, that was a mess.
2018-03-21 07:46:05 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
Engine::get_singleton()->_fps = frames;
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
performance->set_process_time(USEC_TO_SEC(process_max));
Renamed fixed_process to physics_process
2017-09-30 14:19:07 +00:00
performance->set_physics_process_time(USEC_TO_SEC(physics_process_max));
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
performance->set_navigation_process_time(USEC_TO_SEC(navigation_process_max));
Rename MainLoop methods to match Node methods
2020-12-22 09:50:29 +00:00
process_max = 0;
Renamed fixed_process to physics_process
2017-09-30 14:19:07 +00:00
physics_process_max = 0;
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
navigation_process_max = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Revert "Make the performance reporting update frequency customizable"
2018-05-28 11:47:09 +00:00
frame %= 1000000;
frames = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
Make recursive nature of iteration not fail.
2019-01-24 16:09:05 +00:00
iterating--;
Avoid cyclic iteration check, fixes #24969
2019-01-22 16:17:39 +00:00
Add input buffering framework Input buffering is implicitly used by event accumulation, but this commit makes it more generic so it can be enabled for other uses. For desktop OSs it's currently not feasible given main and UI threads are the same).
2021-08-12 22:38:41 +00:00
// Needed for OSs using input buffering regardless accumulation (like Android)
Add project setting for agile input event flushing If enabled, key/touch/joystick events will be flushed just before every idle and physics frame. Enabling this can greatly improve the responsiveness to input, specially in devices that need to run multiple physics frames per each idle frame, because of not being powerful enough to run at the target frame rate. This will only work for platforms using input buffering (regardless event accumulation). Currenly, only Android does so, but could be implemented for iOS in an upcoming PR.
2020-09-20 23:35:20 +00:00
if (Input::get_singleton()->is_using_input_buffering() && !agile_input_event_flushing) {
Add input buffering framework Input buffering is implicitly used by event accumulation, but this commit makes it more generic so it can be enabled for other uses. For desktop OSs it's currently not feasible given main and UI threads are the same).
2021-08-12 22:38:41 +00:00
Input::get_singleton()->flush_buffered_events();
}
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
if (movie_writer) {
RID main_vp_rid = RenderingServer::get_singleton()->viewport_find_from_screen_attachment(DisplayServer::MAIN_WINDOW_ID);
RID main_vp_texture = RenderingServer::get_singleton()->viewport_get_texture(main_vp_rid);
Ref<Image> vp_tex = RenderingServer::get_singleton()->texture_2d_get(main_vp_texture);
movie_writer->add_frame(vp_tex);
}
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (fixed_fps != -1) {
Renderer/Simulator flags Now hopefully with correct code style
2017-08-30 10:40:35 +00:00
return exit;
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Renderer/Simulator flags Now hopefully with correct code style
2017-08-30 10:40:35 +00:00
Move frame delaying functions from Main to OS. Will allow specific platforms to override it and avoid blocking on the main/GUI thread.
2020-06-29 18:46:21 +00:00
OS::get_singleton()->add_frame_delay(DisplayServer::get_singleton()->window_can_draw());
Add possibility to limit frame to main loop (application/target_fps) target-fps working, and use fixed physics step before adding physics-fps in project setting Complete implementation of framelimit Conflicts: main/main.cpp
2014-02-19 15:35:39 +00:00
Added an auto quit and auto build flag to the command line options.
2018-02-14 15:23:04 +00:00
#ifdef TOOLS_ENABLED
if (auto_build_solutions) {
auto_build_solutions = false;
Ignore command line --build-solutions when not editing project This option is meant to use together with `--path` or from a project folder. Otherwise the project manager is opened and the option triggers a crash. Fixes #25589.
2020-01-13 12:55:54 +00:00
// Only relevant when running the editor.
if (!editor) {
set exit code EXIT_FAILURE when --build-solutions fails
2022-10-28 20:59:25 +00:00
OS::get_singleton()->set_exit_code(EXIT_FAILURE);
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
ERR_FAIL_V_MSG(true,
"Command line option --build-solutions was passed, but no project is being edited. Aborting.");
Ignore command line --build-solutions when not editing project This option is meant to use together with `--path` or from a project folder. Otherwise the project manager is opened and the option triggers a crash. Fixes #25589.
2020-01-13 12:55:54 +00:00
}
Added an auto quit and auto build flag to the command line options.
2018-02-14 15:23:04 +00:00
if (!EditorNode::get_singleton()->call_build()) {
set exit code EXIT_FAILURE when --build-solutions fails
2022-10-28 20:59:25 +00:00
OS::get_singleton()->set_exit_code(EXIT_FAILURE);
t Add unit testing to Godot using DocTest and added to GitHub Actions CI Implements exit codes into the engine so tests can return their statuses. Ideally we don't do this, and we use FIXUP logic to 'begin' and 'end' the engine execution for tests specifically. Since realistically we're initialising the engine here we don't want to do that, since String should not require an engine startup to test a single header. This lowers the complexity of running the unit tests and even for physics should be possible to implement such a fix.
2020-07-20 16:35:34 +00:00
ERR_FAIL_V_MSG(true,
"Command line option --build-solutions was passed, but the build callback failed. Aborting.");
Added an auto quit and auto build flag to the command line options.
2018-02-14 15:23:04 +00:00
}
}
#endif
return exit || auto_quit;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
}
void Main::force_redraw() {
force_redraw_requested = true;
Main: Group static members and add some docs
2018-09-20 09:45:05 +00:00
}
/* 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.
*/
Make glue generation shutdown more graceful
2021-02-22 10:06:33 +00:00
void Main::cleanup(bool p_force) {
if (!p_force) {
ERR_FAIL_COND(!_start_success);
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Use system fonts as fallback and improve system font handling. Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-21 13:04:01 +00:00
for (int i = 0; i < TextServerManager::get_singleton()->get_interface_count(); i++) {
TextServerManager::get_singleton()->get_interface(i)->cleanup();
}
Implement Running Godot as Movie Writer * Allows running the game in "movie writer" mode. * It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time). * If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult. * Implements a simple, default MJPEG writer. This new features has two main use cases, which have high demand: * Saving game videos in high quality and ensuring the frame rate is *completely* stable, always. * Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this). **Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly). Usage: $ godot --write-movie movie.avi [scene_file.tscn] Missing: * Options for configuring video writing via GLOBAL_DEF * UI Menu for launching with this mode from the editor. * Add to list of command line options. * Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
if (movie_writer) {
movie_writer->end();
}
Added basic support for custom resource savers and loaders
2018-06-11 00:59:53 +00:00
ResourceLoader::remove_custom_loaders();
ResourceSaver::remove_custom_savers();
Main::cleanup: Move MessageQueue deletion further down where it's safer Partial revert of #15702 which triggered the issue. Fixes #39786.
2020-06-24 14:57:37 +00:00
// Flush before uninitializing the scene, but delete the MessageQueue as late as possible.
Fix crash when closing the editor
2018-01-14 12:50:52 +00:00
message_queue->flush();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->delete_main_loop();
OS::get_singleton()->_cmdline.clear();
Add support for command-line user arguments. Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-29 13:30:52 +00:00
OS::get_singleton()->_user_args.clear();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->_execpath = "";
OS::get_singleton()->_local_clipboard = "";
GDScript files are converted to binary on export now.
2017-12-14 18:33:54 +00:00
ResourceLoader::clear_translation_remaps();
ResourceLoader::clear_path_remaps();
Fix `ResourceLoader::thread_load_tasks` crash
2022-12-06 18:51:06 +00:00
ResourceLoader::clear_thread_load_tasks();
Script languges are uninitialized properly now.
2017-07-22 19:11:04 +00:00
ScriptServer::finish_languages();
Oops! Audio engine has vanished :D
2017-01-15 19:06:14 +00:00
Sync pending VisualServer commands after ScriptServer finalization This is needed as C# may free resources from the finalizer thread during CSharpLanguage::finish(). Previously this would result in RIDs not being freed.
2020-01-13 20:46:41 +00:00
// Sync pending commands that may have been queued from a different thread during ScriptServer finalization
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
RenderingServer::get_singleton()->sync();
Sync pending VisualServer commands after ScriptServer finalization This is needed as C# may free resources from the finalizer thread during CSharpLanguage::finish(). Previously this would result in RIDs not being freed.
2020-01-13 20:46:41 +00:00
Fixes small typos and grammar correction
2021-03-12 13:35:16 +00:00
//clear global shader variables before scene and other graphics stuff are deinitialized.
Rename `uniform` to `parameter` across the engine
2022-08-27 09:22:43 +00:00
rendering_server->global_shader_parameters_clear();
Implement global and per instance shader uniforms. Adds two keywords to shader language for uniforms: -'global' -'instance' This allows them to reference values outside the material.
2020-04-17 02:52:00 +00:00
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
if (xr_server) {
Improve unregistering XR interfaces so we don't get crashes in GDExtensions by destroying the XRServer too early
2021-09-28 02:15:00 +00:00
// Now that we're unregistering properly in plugins we need to keep access to xr_server for a little longer
// We do however unset our primary interface
xr_server->set_primary_interface(Ref<XRInterface>());
Redoing the ARVR GDNative interface as module and tighter implementation
2017-10-07 13:51:17 +00:00
}
Add driver types to GD extension initialisation levels
2021-09-11 02:08:12 +00:00
#ifdef TOOLS_ENABLED
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->deinitialize_extensions(GDExtension::INITIALIZATION_LEVEL_EDITOR);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_EDITOR);
Move editor class and plugin registrations to a dedicated file
2022-05-01 09:57:36 +00:00
unregister_editor_types();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
Add driver types to GD extension initialisation levels
2021-09-11 02:08:12 +00:00
#endif
Improved support for custom image loaders
2018-09-03 04:36:35 +00:00
ImageLoader::cleanup();
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->deinitialize_extensions(GDExtension::INITIALIZATION_LEVEL_SCENE);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_SCENE);
Facilitate exposing platform-exclusive interfaces to all platforms This makes the interfaces available, without implementation, in other platforms and the editor, which facilitates documenting platform-exclusive classes. Platform-exclusive APIs must be set up in platform/<platform>/api/api.cpp. Provide noop method-implementations where necessary. Also setup and document the HTML5 platform's JavaScript singleton.
2017-11-16 00:33:48 +00:00
unregister_platform_apis();
Reorder native extension types initialization, initializing editor last
2022-02-28 13:50:43 +00:00
unregister_driver_types();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
unregister_scene_types();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
finalize_theme_db();
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
// Before deinitializing server extensions, finalize servers which may be loaded as extensions.
Move navigation server finalize before physics server
2022-12-08 17:23:42 +00:00
finalize_navigation_server();
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
finalize_physics();
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 11:11:28 +00:00
GDExtensionManager::get_singleton()->deinitialize_extensions(GDExtension::INITIALIZATION_LEVEL_SERVERS);
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_SERVERS);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
unregister_server_types();
[Debugger] Move most profilers to ServersDebugger. Also splits bandwidth/rpc profiler (RPCProfiler is now in SceneDebugger).
2022-02-06 01:29:08 +00:00
EngineDebugger::deinitialize();
Improve unregistering XR interfaces so we don't get crashes in GDExtensions by destroying the XRServer too early
2021-09-28 02:15:00 +00:00
if (xr_server) {
memdelete(xr_server);
}
Destroy AudioServer after other non-core types are unregistered This is important for some GDNative bindings and probably for Mono. They may keep references to audio objects which are freed when they are unregistered. If AudioServer is already deleted at that point, it causes segfaults.
2018-01-11 10:01:35 +00:00
if (audio_server) {
audio_server->finish();
memdelete(audio_server);
}
iOS modular build and export implementation.
2019-11-29 06:54:39 +00:00
if (camera_server) {
memdelete(camera_server);
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OS::get_singleton()->finalize();
Effective DisplayServer separation, rename X11 -> LinuxBSD
2020-03-03 13:36:29 +00:00
finalize_display();
if (input) {
memdelete(input);
}
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (packed_data) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(packed_data);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (file_access_network_client) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(file_access_network_client);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (performance) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(performance);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (input_map) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(input_map);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Add Time singleton
2021-05-24 11:54:05 +00:00
if (time_singleton) {
memdelete(time_singleton);
}
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (translation_server) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(translation_server);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-27 21:19:51 +00:00
if (tsman) {
memdelete(tsman);
}
Expose registration of physics servers to GDExtension This exposes PhysicsServer2DManager and PhysicsServer3DManager.
2022-09-06 13:35:33 +00:00
if (physics_server_3d_manager) {
memdelete(physics_server_3d_manager);
}
if (physics_server_2d_manager) {
memdelete(physics_server_2d_manager);
}
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (globals) {
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
memdelete(globals);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
if (engine) {
Created new Engine singleton, and moved engine related OS functions to it.
2017-01-13 15:51:14 +00:00
memdelete(engine);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
-Project/Editor settings now use new inspector -Project/Editor settings now show tooltips properly -Settings thar require restart now will show a restart warning -Video driver is now visible all the time, can be changed easily -Added function to request current video driver
2018-07-19 21:58:15 +00:00
if (OS::get_singleton()->is_restart_on_exit_set()) {
//attempt to restart with arguments
Fix build issues and typos after c69de2ba4
2018-07-20 06:37:10 +00:00
List<String> args = OS::get_singleton()->get_restart_on_exit_arguments();
[macOS] Add `create_instance` function to spawn editor copies. [macOS] Modify `create_project` function to detect and run app bundles using NSWorkspace to ensure app window is registered and activated correctly.
2021-11-01 09:12:52 +00:00
OS::get_singleton()->create_instance(args);
-Project/Editor settings now use new inspector -Project/Editor settings now show tooltips properly -Settings thar require restart now will show a restart warning -Video driver is now visible all the time, can be changed easily -Added function to request current video driver
2018-07-19 21:58:15 +00:00
OS::get_singleton()->set_restart_on_exit(false, List<String>()); //clear list (uses memory)
}
Main::cleanup: Move MessageQueue deletion further down where it's safer Partial revert of #15702 which triggered the issue. Fixes #39786.
2020-06-24 14:57:37 +00:00
// Now should be safe to delete MessageQueue (famous last words).
message_queue->flush();
memdelete(message_queue);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
unregister_core_driver_types();
Fix extension registration order.
2022-02-16 17:02:38 +00:00
unregister_core_extensions();
Refactor module initialization * Changed to use the same stages as extensions. * Makes the initialization more coherent, helping solve problems due to lack of stages. * Makes it easier to port between module and extension. * removed the DRIVER initialization level (no longer needed).
2022-05-03 09:56:08 +00:00
uninitialize_modules(MODULE_INITIALIZATION_LEVEL_CORE);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
unregister_core_types();
OS::get_singleton()->finalize_core();
}