diff options
Diffstat (limited to 'doc/classes/EditorSettings.xml')
| -rw-r--r-- | doc/classes/EditorSettings.xml | 56 |
1 files changed, 42 insertions, 14 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 7e1bba202d..4b1ff0b2ae 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -9,7 +9,7 @@ Accessing the settings can be done using the following methods, such as: [codeblocks] [gdscript] - var settings = EditorInterface.get_editor_settings() + var settings = get_editor_interface().get_editor_settings() # `settings.set("some/property", 10)` also works as this class overrides `_set()` internally. settings.set_setting("some/property", 10) # `settings.get("some/property")` also works as this class overrides `_get()` internally. @@ -241,9 +241,6 @@ <member name="editors/2d/bone_width" type="int" setter="" getter=""> The bone width in the 2D skeleton editor (in pixels). See also [member editors/2d/bone_outline_size]. </member> - <member name="editors/2d/constrain_editor_view" type="bool" setter="" getter=""> - If [code]true[/code], prevents the 2D editor viewport from leaving the scene. Limits are calculated dynamically based on nodes present in the current scene. If [code]false[/code], the 2D editor viewport will be able to move freely, but you risk getting lost when zooming out too far. You can refocus on the scene by selecting a node then pressing [kbd]F[/kbd]. - </member> <member name="editors/2d/grid_color" type="Color" setter="" getter=""> The grid color to use in the 2D editor. </member> @@ -308,7 +305,7 @@ If [code]true[/code], render the grid on an XZ plane. </member> <member name="editors/3d/grid_yz_plane" type="bool" setter="" getter=""> - If [code]true[/code], render the grid on an YZ plane. This can be useful for 3D side-scrolling games. + If [code]true[/code], render the grid on a YZ plane. This can be useful for 3D side-scrolling games. </member> <member name="editors/3d/navigation/emulate_3_button_mouse" type="bool" setter="" getter=""> If [code]true[/code], enables 3-button mouse emulation mode. This is useful on laptops when using a trackpad. @@ -342,7 +339,7 @@ [b]Note:[/b] On certain window managers on Linux, the [kbd]Alt[/kbd] key will be intercepted by the window manager when clicking a mouse button at the same time. This means Godot will not see the modifier key as being pressed. </member> <member name="editors/3d/navigation/warped_mouse_panning" type="bool" setter="" getter=""> - If [code]true[/code], warps the mouse around the 3D viewport while panning in the 3D editor. This makes it possible to pan over a large area without having to exit panning then mouse the mouse back constantly. + If [code]true[/code], warps the mouse around the 3D viewport while panning in the 3D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. </member> <member name="editors/3d/navigation/zoom_modifier" type="int" setter="" getter=""> The modifier key that must be held to zoom in the 3D editor. @@ -421,7 +418,7 @@ Controls whether the mouse wheel scroll zooms or pans in subeditors. The list of affected subeditors is: animation blend tree editor, [Polygon2D] editor, tileset editor, texture region editor and visual shader editor. See also [member editors/panning/2d_editor_panning_scheme] and [member editors/panning/animation_editors_panning_scheme]. </member> <member name="editors/panning/warped_mouse_panning" type="bool" setter="" getter=""> - If [code]true[/code], warps the mouse around the 2D viewport while panning in the 2D editor. This makes it possible to pan over a large area without having to exit panning then mouse the mouse back constantly. + If [code]true[/code], warps the mouse around the 2D viewport while panning in the 2D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor. </member> <member name="editors/polygon_editor/point_grab_radius" type="int" setter="" getter=""> The radius in which points can be selected in the [Polygon2D] and [CollisionPolygon2D] editors (in pixels). Higher values make it easier to select points quickly, but can make it more difficult to select the expected point when several points are located close to each other. @@ -429,6 +426,9 @@ <member name="editors/polygon_editor/show_previous_outline" type="bool" setter="" getter=""> If [code]true[/code], displays the polygon's previous shape in the 2D polygon editors with an opaque gray outline. This outline is displayed while dragging a point until the left mouse button is released. </member> + <member name="editors/shader_editor/behavior/files/restore_shaders_on_load" type="bool" setter="" getter=""> + If [code]true[/code], reopens shader files that were open in the shader editor when the project was last closed. + </member> <member name="editors/tiles_editor/display_grid" type="bool" setter="" getter=""> If [code]true[/code], displays a grid while the TileMap editor is active. See also [member editors/tiles_editor/grid_color]. </member> @@ -526,6 +526,9 @@ The language to use for the editor interface. Translations are provided by the community. If you spot a mistake, [url=$DOCS_URL/contributing/documentation/editor_and_docs_localization.html]contribute to editor translations on Weblate![/url] </member> + <member name="interface/editor/editor_screen" type="int" setter="" getter=""> + The preferred monitor to display the editor. + </member> <member name="interface/editor/expand_to_title" type="bool" setter="" getter=""> Expanding main editor window content to the title, if supported by [DisplayServer]. See [constant DisplayServer.WINDOW_FLAG_EXTEND_TO_TITLE]. Specific to the macOS platform. @@ -558,8 +561,11 @@ <member name="interface/editor/mouse_extra_buttons_navigate_history" type="bool" setter="" getter=""> If [code]true[/code], the mouse's additional side buttons will be usable to navigate in the script editor's file history. Set this to [code]false[/code] if you're using the side buttons for other purposes (such as a push-to-talk button in a VoIP program). </member> + <member name="interface/editor/project_manager_screen" type="int" setter="" getter=""> + The preferred monitor to display the project manager. + </member> <member name="interface/editor/save_each_scene_on_quit" type="bool" setter="" getter=""> - If [code]true[/code], the editor will save all scenes when confirming the [b]Save[/b] action when quitting the editor or quitting to the project list. If [code]false[/code], the editor will ask to save each scene individually. + If [code]false[/code], the editor will save all scenes when confirming the [b]Save[/b] action when quitting the editor or quitting to the project list. If [code]true[/code], the editor will ask to save each scene individually. </member> <member name="interface/editor/separate_distraction_mode" type="bool" setter="" getter=""> If [code]true[/code], the editor's Script tab will have a separate distraction mode setting from the 2D/3D/AssetLib tabs. If [code]false[/code], the distraction-free mode toggle is shared between all tabs. @@ -578,12 +584,26 @@ If [code]true[/code], editor main menu is using embedded [MenuBar] instead of system global menu. Specific to the macOS platform. </member> + <member name="interface/inspector/float_drag_speed" type="float" setter="" getter=""> + Base speed for increasing/decreasing float values by dragging them in the inspector. + </member> <member name="interface/inspector/max_array_dictionary_items_per_page" type="int" setter="" getter=""> The number of [Array] or [Dictionary] items to display on each "page" in the inspector. Higher values allow viewing more values per page, but take more time to load. This increased load time is noticeable when selecting nodes that have array or dictionary properties in the editor. </member> <member name="interface/inspector/show_low_level_opentype_features" type="bool" setter="" getter=""> If [code]true[/code], display OpenType features marked as [code]hidden[/code] by the font file in the [Font] editor. </member> + <member name="interface/multi_window/enable" type="bool" setter="" getter=""> + If [code]true[/code], the multi window support in editor is enabled. The following panels can become dedicated windows (made floating): Docks, Script editor, and Shader editor. + [b]Note:[/b] When [member interface/editor/single_window_mode] is [code]true[/code], the multi window support is always disabled. + </member> + <member name="interface/multi_window/maximize_window" type="bool" setter="" getter=""> + If [code]true[/code], when panels are made floating they will be maximized. + If [code]false[/code], when panels are made floating their position and size will match the ones when they are attached (excluding window border) to the editor window. + </member> + <member name="interface/multi_window/restore_windows_on_load" type="bool" setter="" getter=""> + If [code]true[/code], the floating panel position, size, and screen will be saved on editor exit. On next launch the panels that were floating will be made floating in the saved positions, sizes and screens, if possible. + </member> <member name="interface/scene_tabs/display_close_button" type="int" setter="" getter=""> Controls when the Close (X) button is displayed on scene tabs at the top of the editor. </member> @@ -648,6 +668,10 @@ If [code]true[/code], increases the scrollbar touch area to improve usability on touchscreen devices. [b]Note:[/b] Defaults to [code]true[/code] on touchscreen devices. </member> + <member name="interface/touchscreen/scale_gizmo_handles" type="float" setter="" getter=""> + Specify the multiplier to apply to the scale for the editor gizmo handles to improve usability on touchscreen devices. + [b]Note:[/b] Defaults to [code]1[/code] on non-touchscreen devices. + </member> <member name="network/debug/remote_host" type="String" setter="" getter=""> The address to listen to when starting the remote debugger. This can be set to [code]0.0.0.0[/code] to allow external clients to connect to the remote debugger (instead of restricting the remote debugger to connections from [code]localhost[/code]). </member> @@ -686,6 +710,10 @@ <member name="run/output/font_size" type="int" setter="" getter=""> The size of the font in the [b]Output[/b] panel at the bottom of the editor. This setting does not impact the font size of the script editor (see [member interface/editor/code_font_size]). </member> + <member name="run/window_placement/android_window" type="int" setter="" getter=""> + The Android window to display the project on when starting the project from the editor. + [b]Note:[/b] Only available in the Android editor. + </member> <member name="run/window_placement/rect" type="int" setter="" getter=""> The window mode to use to display the project when starting the project from the editor. </member> @@ -699,7 +727,7 @@ If [code]true[/code], makes the caret blink according to [member text_editor/appearance/caret/caret_blink_interval]. Disabling this setting can improve battery life on laptops if you spend long amounts of time in the script editor, since it will reduce the frequency at which the editor needs to be redrawn. </member> <member name="text_editor/appearance/caret/caret_blink_interval" type="float" setter="" getter=""> - The interval at which to blink the caret (in seconds). See also [member text_editor/appearance/caret/caret_blink]. + The interval at which the caret will blink (in seconds). See also [member text_editor/appearance/caret/caret_blink]. </member> <member name="text_editor/appearance/caret/highlight_all_occurrences" type="bool" setter="" getter=""> If [code]true[/code], highlights all occurrences of the currently selected text in the script editor. See also [member text_editor/theme/highlighting/word_highlighted_color]. @@ -708,7 +736,7 @@ If [code]true[/code], colors the background of the line the caret is currently on with [member text_editor/theme/highlighting/current_line_color]. </member> <member name="text_editor/appearance/caret/type" type="int" setter="" getter=""> - The shape of the caret to use in the script editor. [b]Line[/b] displays a vertical line to the left of the current character, whereas [b]Block[/b] displays a outline over the current character. + The shape of the caret to use in the script editor. [b]Line[/b] displays a vertical line to the left of the current character, whereas [b]Block[/b] displays an outline over the current character. </member> <member name="text_editor/appearance/guidelines/line_length_guideline_hard_column" type="int" setter="" getter=""> The column at which to display a subtle line as a line length guideline for scripts. This should generally be greater than [member text_editor/appearance/guidelines/line_length_guideline_soft_column]. @@ -725,15 +753,15 @@ <member name="text_editor/appearance/gutters/line_numbers_zero_padded" type="bool" setter="" getter=""> If [code]true[/code], displays line numbers with zero padding (e.g. [code]007[/code] instead of [code]7[/code]). </member> - <member name="text_editor/appearance/gutters/show_bookmark_gutter" type="bool" setter="" getter=""> - If [code]true[/code], displays icons for bookmarks in a gutter at the left. Bookmarks remain functional when this setting is disabled. - </member> <member name="text_editor/appearance/gutters/show_info_gutter" type="bool" setter="" getter=""> - If [code]true[/code], displays a gutter at the left containing icons for methods with signal connections. + If [code]true[/code], displays a gutter at the left containing icons for methods with signal connections and for overridden methods. </member> <member name="text_editor/appearance/gutters/show_line_numbers" type="bool" setter="" getter=""> If [code]true[/code], displays line numbers in a gutter at the left. </member> + <member name="text_editor/appearance/lines/autowrap_mode" type="int" setter="" getter=""> + If [member text_editor/appearance/lines/word_wrap] is set to [code]1[/code], sets text wrapping mode. To see how each mode behaves, see [enum TextServer.AutowrapMode]. + </member> <member name="text_editor/appearance/lines/code_folding" type="bool" setter="" getter=""> If [code]true[/code], displays the folding arrows next to indented code sections and allows code folding. If [code]false[/code], hides the folding arrows next to indented code sections and disallows code folding. </member> |