Commit graph

3593 commits

Author SHA1 Message Date
Max Hilbrunner
7fae8f6828
Merge pull request #56152 from belzecue/patch-4
Update CharFXTransform: explain "relative index"/"absolute index"
2022-01-04 13:56:07 +01:00
Max Hilbrunner
5083901561
Merge pull request #56378 from Calinou/doc-spatialmaterial-flowmap-format
Document the expected format of anisotropy flowmaps in SpatialMaterial
2022-01-04 13:48:37 +01:00
Yuri Roubinsky
5b0fe7880e [3.x] Add hints and default values to the uniform nodes in visual shader 2022-01-03 22:59:10 +03:00
Max Hilbrunner
08ce24a3c4
Merge pull request #56234 from timothyqiu/3.x-at-tool-script
Use `tool` instead of `@tool` in 3.x documentation
2022-01-02 03:09:09 +01:00
Max Hilbrunner
40f7dcbc7e
Merge pull request #56241 from KoBeWi/r3gist3r_b3for3_us3
[3.x] Improve docs about plugin registration
2022-01-02 03:08:02 +01:00
Hugo Locurcio
9937f7f50d
Document the expected format of anisotropy flowmaps in SpatialMaterial 2021-12-31 17:29:03 +01:00
Wilson E. Alvarez
d03b82cde7
Expose String::join over to GDScript 2021-12-30 21:27:18 -05:00
Yuri Sizov
d9bf3e5e35 Fix return type for the exposed EditorResourcePicker method 2021-12-29 21:57:14 +03:00
kobewi
4fc795194b Improve docs about plugin registration 2021-12-25 16:55:03 +01:00
Haoyu Qiu
7b83b5ea3c Use tool instead of at-tool in 3.x documentation 2021-12-25 10:56:34 +08:00
Haoyu Qiu
bb1eb84da4 Alpha channel indicates opacity, not transparency 2021-12-24 16:52:32 +08:00
belzecue
89cebd79e8
Update CharFXTransform: explain "relative index"/"absolute index" (previously identical)
Confusingly, these two properties had identical descriptions even though they measure different things.

"relative_index" measures character count from the custom effect's bbcode opening tag.
"absolute_index" measures character count from the start of the bbcode text that includes the custom effect.

See the code author's own explanation here: https://github.com/godotengine/godot/pull/23658

NOTE: Doco for CharFXTransform.xml has changed significantly in 4.0, where terminology has changed to "glyph".  Therefore, proposing this change for 3.x branch only.
2021-12-22 14:17:47 +08:00
snailrhymer
73f4531c97
Fix descriptions of set_cell and set_cellv in TileMap.xml
Swap the first lines of the descriptions for set_cell and set_cellv to correctly describe which accepts x and y as separate arguments and which accepts a Vector2.

Fix not relevant to master branch due to changes to TileMap.
2021-12-22 02:37:12 +00:00
Rémi Verschelde
f2ddafd860
i18n: Add --lang option to make_rst.py to write translated headings
Add a few missing headings to the translation templates.

(cherry picked from commit b98785309f)
2021-12-21 14:40:13 +01:00
Rémi Verschelde
aac4e36149
i18n: Sync classref translations with 3.x branch (3.5-beta)
This is the new base branch for the classref translations to prepare them
for the 3.5 release.

This means that the 3.4 class ref translations will likely no longer get
updates, as we can't easily maintain two slightly different branches on
Weblate.
2021-12-21 12:33:57 +01:00
Rémi Verschelde
8ed5192f74
i18n: Sync classref translations with Weblate
(cherry picked from commit eb4816ee13)
2021-12-21 12:33:57 +01:00
Rémi Verschelde
05faadab2d
i18n: Remove line numbers from classref PO files
It's useful context for translators but it generates very spammy diffs whenever
a line is added or removed, changing the comments for hundreds or thousands of
msgids needlessly.

We still have the file names so it's relatively easy to search in file to find
the location of the source string.

(cherry picked from commit dbfe36728e)
2021-12-21 12:33:56 +01:00
Haoyu Qiu
e40bb68c05
Add / to the unix shortcut drive list
Also made `get_current_drive()` to pick the longest match on Unix.

(cherry picked from commit 67f04b381b)
2021-12-21 12:11:14 +01:00
cdemirer
8e29a37800
Clarify that replace_by keeps child nodes in tree
(cherry picked from commit 98a3948bf9)
2021-12-21 12:11:14 +01:00
kobewi
4f284893a6
Document get_minimum_size not called in some nodes
(cherry picked from commit 7d5ee8f694)
2021-12-21 12:11:14 +01:00
Micky
9fc2bc6cf2
Various improvements to Camera2D's documentation
A summary of the tweaked descriptions:
* "get_camera_position()" is explains what the camera position is, and mitigates the confusion between this method and Node2D.position;
* "get_camera_screen_center()" links to the "get_camera_position" method;
* "reset_smoothing()" links to the "smoothing_enabled" propriety;

* "drag_horizontal_offset" and "drag_vertical_offset" link to their respective _enabled_ properties;
* "limit_smoothed" links to the "smoothing_enabled" propriety;
* "rotating" clarifies that the camera _view_ rotates when enabled.

Partially closes https://github.com/godotengine/godot-docs/issues/5417, as some of the issues described are no longer present in 4.0, or are not fully solved in this PR.

Further tweaks are welcome, as I'm afraid this could be a too verbose. A few of these could be split into their PR if necessary.

(cherry picked from commit 6cf2623a20)
2021-12-21 12:11:14 +01:00
Haoyu Qiu
36642738e0 Update make_rst.py for non-latin texts 2021-12-21 16:36:53 +08:00
bruvzg
59085d5051
[Windows] Improve console handling and execute.
Always build with the GUI subsystem.
Redirect stdout and stderr output to the parent process console.
Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with non-blocking calls).
Add `open_console` argument to the `execute` to open a new console window (for both blocking and non-blocking calls).
Remove `interface/editor/hide_console_window` editor setting.
Remove `Toggle System Console` menu option.
Remove `set_console_visible` and `is_console_visible` functions.
2021-12-18 10:13:27 +02:00
Haoyu Qiu
d99a313fd3 Fix font preview text color on light background 2021-12-18 00:34:54 +08:00
kobewi
bf99f09e14
Mention what happens if find_node() fails
(cherry picked from commit e7722a9a7b)
2021-12-17 00:14:50 +01:00
Rémi Verschelde
d32a763c17
i18n: Sync classref translations with current docs
(cherry picked from commit f8b4412b51)
2021-12-16 17:05:49 +01:00
Rémi Verschelde
754fc89d28
i18n: Sync classref translations with Weblate
(cherry picked from commit 9f838dbece)
2021-12-16 15:15:46 +01:00
Rémi Verschelde
a90cac7ba4
Merge pull request #55988 from timothyqiu/http-proxy-3.x 2021-12-16 13:09:07 +01:00
Haoyu Qiu
1cada6bfa9 Add proxy support for HTTPClient and the editor
* Adds proxy related methods for `HTTPClient` and `HTTPRequest`
* Adds `network/http_proxy/{host,port}` editor settings
* Makes AssetLib and Export Template Manager proxy aware
2021-12-16 19:38:53 +08:00
Haoyu Qiu
c11b1850c4 Make --doctool locale aware
* Adds `indent(prefix)` to `String`
* Moves the loading of tool/doc translation into
  `editor/editor_translation.{h,cpp}`
* 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-16 18:27:32 +08:00
Haoyu Qiu
b225fec1de Fix indentations in class reference XMLs 2021-12-15 22:40:19 +08:00
Max Hilbrunner
97ea2ba78c
Merge pull request #55668 from Calinou/doc-physics-ticks-per-rendered-frame-3.x
Document physics simulation being limited to 8 ticks per rendered frame
2021-12-15 03:44:49 +01:00
Max Hilbrunner
ee3e3df539
Merge pull request #55772 from Calinou/doc-texturearray-srgb
Document sampling a TextureArray with sRGB -> linear conversion
2021-12-15 03:42:16 +01:00
Max Hilbrunner
1fd0f69050
Merge pull request #55832 from Calinou/doc-reflectionprobe-3.x
Improve the ReflectionProbe class documentation (3.x)
2021-12-15 03:23:51 +01:00
Rémi Verschelde
4d709b71de
Merge pull request #55690 from akien-mga/3.x-scene-tree-doc-font-oversampling 2021-12-14 17:33:00 +01:00
Ryan Roden-Corrent
22fb04bddf
Document how to autoscroll ScrollContainer.
It is not uncommon to want to scroll to the most recently added child of
a ScrollContainer (e.g. a chat box or activity log). This is a little
tricky, since `ensure_control_visible` will not work on a node on the
same frame as you add it. Let's at least document that you need to wait
until the next frame.

Relates to https://github.com/godotengine/godot-proposals/issues/3629.

Backport of https://github.com/godotengine/godot/pull/55609.

Co-authored-by: Yuri Sizov <pycbouh@users.noreply.github.com>
2021-12-14 06:51:05 -05:00
Rémi Verschelde
dd122e2971
Merge pull request #55827 from Calinou/doc-viewport-upside-down 2021-12-12 21:04:55 +01:00
lawnjelly
b8d3d97b6a Visibility Notifier / Enabler classref mention Portals
Fixes the classref to show that these do not take account of occlusion except when using Portals.
2021-12-11 18:50:01 +00:00
Hugo Locurcio
2fbf880912
Improve the ReflectionProbe class documentation 2021-12-11 19:10:30 +01:00
Hugo Locurcio
6b26012284
Document Viewports rendering upside-down by default
This was fixed in `master`, but the default behavior can't be changed
in `3.x` for compatibility reasons.
2021-12-11 16:56:44 +01:00
Steve Szilágyi
285b816f1f
VehicleWheel can now return the surface it's colliding with.
Fixed PR issues.

Update vehicle_body_3d.cpp

Apply suggestions from code review

Co-authored-by: Camille Mohr-Daurat <pouleyKetchoup@gmail.com>
(cherry picked from commit 0c352407d8)
2021-12-10 19:01:06 +01:00
Anilforextra
9351bc4b1c
Fixed awkwardly named AnimatedSprite Setters.
(cherry picked from commit 0c06ed98fb)
2021-12-10 17:57:39 +01:00
Rémi Verschelde
fc7528b366
Merge pull request #55788 from RPicster/3.x-particles-random-start-color 2021-12-10 16:52:19 +01:00
Raffaele Picca
6dd593d579 Random initial color for all Particle Nodes 2021-12-10 16:35:25 +01:00
Rémi Verschelde
c6a9a384a0
Merge pull request #55783 from timothyqiu/broken-doc-link
[3.x] Fix broken links in Class Reference
2021-12-10 15:51:17 +01:00
Haoyu Qiu
b1153f8829 Fix broken links in Class Reference 2021-12-10 21:07:21 +08:00
Rémi Verschelde
eac0d90c39
Merge pull request #55560 from pycbouh/docs-overridden-cross-linked-3.x
[3.x] Make overridden properties link to parent definition
2021-12-10 12:42:09 +01:00
Rémi Verschelde
95f895f087
i18n: Remove deleted translations from PO files
Since we bundle the whole files in the editor binary, they actual impact the
binary size needlessly.

Automate it via `make merge`.

(cherry picked from commit 6fb47a271f)
2021-12-10 11:52:45 +01:00
Rémi Verschelde
213f7cb719
i18n: Sync classref translations with Weblate
(cherry picked from commit f4b3c3ff09)
2021-12-10 11:52:41 +01:00
Hugo Locurcio
491acf346d
Document sampling a TextureArray with sRGB -> linear conversion
This is required when sampling an albedo map from a texture array
in 3D. Otherwise, colors will look washed out.
2021-12-10 01:02:48 +01:00
Raul Santos
229489f7b7
Expose ScriptEditor::edit to scripting
Exposes a method in `EditorInterface` to open scripts on a specified
line and column. This method handles if the internal or the external
editor should be used.

(cherry picked from commit 9535831866)
2021-12-09 12:05:14 +01:00
bruvzg
eb54676e0f
Add DynamicFontData oversampling override property. 2021-12-08 11:34:56 +02:00
Hugo Locurcio
bfe77b8fab
Document physics simulation being limited to 8 ticks per rendered frame 2021-12-08 00:22:03 +01:00
Hugo Locurcio
2fe15124de
Document that RigidBody angular velocity is in degrees per second
This will be changed to radians per second in Godot 4.0, but it can't
be changed in 3.x to preserve compatibility with existing projects.
2021-12-07 18:38:03 +01:00
Rémi Verschelde
35b79284cc
SceneTree: Document font oversampling, remove warnings 2021-12-07 14:15:09 +01:00
Rémi Verschelde
643a9a3420
Merge pull request #55526 from pycbouh/docs-sort-group-newline-theme-and-enums-3.x 2021-12-07 12:14:48 +01:00
Rémi Verschelde
0845f20784
Merge pull request #55614 from Calinou/add-os-crash-method-3.x 2021-12-06 17:04:14 +01:00
Manolis Papadeas
3be071f8c6
Fix link to the supported image formats in the Image class
It previously linked to this page which doesn't exist. https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_images.html#supported-image-formats

Now, it should link here: https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html#supported-image-formats

(cherry picked from commit c01c4c687b)
2021-12-06 16:52:00 +01:00
kobewi
9776241ce6
Bind column_titles_visible as property
(cherry picked from commit 7f6ab0006d)
2021-12-06 16:52:00 +01:00
Aaron Franke
d75e580765
Warn when using an AABB or Rect2 with a negative size
(cherry picked from commit 9687f6fca3)
2021-12-06 16:51:59 +01:00
Hugo Locurcio
796ea60d11
Document SceneTreeTimer being freed automatically when elapsed
The note was present in the SceneTree `create_timer()` class
documentation, but not in the SceneTreeTimer class documentation.
2021-12-05 18:39:10 +01:00
Hugo Locurcio
58296c7e21
Add an OS.crash() method for testing system crash handler
This makes it possible to test the system's crash handler without
having to modify engine code or exploit an engine bug.
2021-12-04 01:40:56 +01:00
Rémi Verschelde
ade0e700f1
Merge pull request #55591 from RPicster/3.x-particlemat-ring-axis-fix
Fix Ring-Axis parameter being always visible
2021-12-03 21:38:16 +01:00
Raffaele Picca
2f69caaff3 Fix Ring-Axis parameter being always visible 2021-12-03 21:16:32 +01:00
Yuri Sizov
1cf6d21f69 Make overridden properties link to parent definition
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:48:49 +03:00
kobewi
ad5cb8ef5e
Improve store_string() description
(cherry picked from commit 09b1fc1956)
2021-12-03 12:19:47 +01:00
Marcel Admiraal
e0729b9c79 Allow any kind of Mesh to be added to an EditorSpatialGizmo 2021-12-03 08:51:38 +00:00
Haoyu Qiu
144e3cd31f
Fix various misused code tag in classref
(cherry picked from commit 85c136bd07)
2021-12-02 17:31:16 +01:00
Rémi Verschelde
6f1fcdee0d
Merge pull request #49662 from kleonc/transforms-xform_inv-docs 2021-12-02 12:54:44 +01:00
Yuri Sizov
ebd8101546 Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 22:48:17 +03:00
janglee
0b327eb46e VCS: Add push, pull, fetch and improved diff view to VCS UI
This commit was created by merging the commits presented in #39255 for
the GSoC 2020 VCS Improvement project

VCS: Make EditorVCSInterface store less amount of internal state

VCS: Add force push checkbox + more frequent VCS updates

Add force push checkbox in the Commit dock. Also add some missing
opportunities for checking the VCS state again on from UI inputs

VCS: Fix script contents not being updated on merge conflict

VCS: Add branch creation VCS interface calls

VCS: Add VCS remote creation and remote selection menus

VCS: Show more commit information + Fix truncated commit offsets

VCS: Make VCS less noisy + Fix diff view refreshes

VCS: Fix mismatched argument names in VCS helpers

VCS: Add SSH transport support for remote operations

Also, moves the editor's VCS settings registrations to
project_settings.cpp and editor_settings.cpp

VCS: Change TTR() to vformat() for branch and remote removal text

VCS: Add VCS branch icon instead of using Tree node icon

Co-authored-by: @ChronicallySerious
2021-12-01 22:52:07 +05:30
Rémi Verschelde
6cf77f80b5
doc: Fixup Tabs reference after cherry-pick 2021-11-30 14:46:11 +01:00
zacryol
86190dd909
Clarify usage of TabContainer
Makes it more clear that TabBar is separate from TabContainer, and that the container draws the tabs itself.

(cherry picked from commit 5c645d510f)
2021-11-30 10:58:37 +01:00
Aaron Franke
035a84fe92
[3.x] Add a Time singleton 2021-11-29 11:00:06 -06:00
zacryol
dd94440509
Fix description of Viewport find_world_2d() method.
The doc now states that the method searches for a World2D among ancestor Viewports as well, differentiating it from the get_world_2d() getter.

and also find_world_3d()

(cherry picked from commit 81c1d5197e)
2021-11-29 16:13:19 +01:00
Rémi Verschelde
0bf78feb46
Merge pull request #55416 from pycbouh/textedit-position-from-linecol-3.x 2021-11-29 14:28:35 +01:00
Yuri Sizov
ba747e2a26 Add methods to get position from column and line in TextEdit 2021-11-29 00:06:16 +03:00
Aaron Franke
1d8cef8236
[3.x] Backport some APIs in math structs 2021-11-27 01:19:45 -06:00
kobewi
de365200bb
Clarify get_indexed in relation to Nodes
(cherry picked from commit 4ea6709558)
2021-11-25 22:48:20 +01:00
Hugo Locurcio
f6725f8089
Document the engine's use of internal groups in Node
(cherry picked from commit f8d9e4afdb)
2021-11-25 22:24:12 +01:00
kobewi
a7d950ab8e
Mention that replace_by doesn't free the node
(cherry picked from commit 58a3ea5453)
2021-11-25 22:20:27 +01:00
bruvzg
2ef2879d7b
Add Input.is_physical_key_pressed method.
(cherry picked from commit 9877d91c4a)
2021-11-25 22:19:33 +01:00
Rémi Verschelde
888f8cea9f
Merge pull request #52457 from kleonc/image-fill-rect-3x 2021-11-24 16:34:15 +01:00
Hugo Locurcio
e5593212e2
Add a project setting to disable the boot splash image
This allows disabling the boot splash image while keeping the
background color.
2021-11-23 19:06:54 +01:00
kleonc
4f446c8b9e Add Image::fill_rect method 2021-11-23 17:59:08 +01:00
Camille Mohr-Daurat
3970f28f67
Merge pull request #55096 from lawnjelly/bvh_expanded_leaf
BVH - add option for expanded AABBs in leaves
2021-11-22 09:37:16 -07:00
Haoyu Qiu
eb6f74855f Allow toggle TextEdit bookmark gutter 2021-11-21 21:34:30 +08:00
Brian Semrau
04846156c3
Expose Thread::get_main_id in core bindings
(cherry picked from commit c558263d84)
2021-11-20 11:48:09 +01:00
lawnjelly
211dc8cd2d BVH - add option for expanded AABBs in leaves
This PR adds a define BVH_EXPAND_LEAF_AABBS which is set, which stores expanded AABBs in the tree instead of exact AABBs.

This makes the logic less error prone when considering reciprocal collisions in the pairing, as all collision detect is now taking place between expanded AABB against expanded AABB, rather than expanded AABB against exact AABB.

The flip side of this is that the intersection tests will now be less exact when expanded margins are set.

All margins are now user customizable via project settings, and take account of collision pairing density to adjust the margin dynamically.
2021-11-20 06:45:12 +00:00
Rémi Verschelde
54490e9ebb
i18n: Sync classref translations with Weblate
(cherry picked from commit f737ed4da0)
2021-11-19 09:54:45 +01:00
kobewi
70d25bbfbb
Mention how to add margins to Button's icon
(cherry picked from commit 2341c7bbd9)
2021-11-17 15:56:23 +01:00
Rémi Verschelde
4103b0b7d8
Merge pull request #50823 from fbcosentino/3d-material-overlay 2021-11-16 08:21:18 +01:00
Fernando Cosentino
cc8846bef6 Added material_overlay property to MeshInstance
Applying overlay materials into multi-surface meshes currently
requires adding a next pass material to all the surfaces, which
might be cumbersome when the material is to be applied to a range
of different geometries. This also makes it not trivial to use
AnimationPlayer to control the material in case of visual effects.
The material_override property is not an option as it works
replacing the active material for the surfaces, not adding a new pass.

This commit adds the material_overlay property to GeometryInstance
(and therefore MeshInstance), having the same reach as
material_override (that is, all surfaces) but adding a new material
pass on top of the active materials, instead of replacing them.

Implemented in rasterizer of both GLES2 and GLES3.
2021-11-15 23:50:34 +00:00
Rémi Verschelde
ca61752a8c
Merge pull request #54982 from Calinou/doc-surfacetool-append-from-thread 2021-11-15 22:47:14 +01:00
Rémi Verschelde
89792e5c49
Merge pull request #54921 from lawnjelly/portals_roaming_margin 2021-11-15 22:45:46 +01:00
Rémi Verschelde
3ac2999f22
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
Rémi Verschelde
0cdcf1154f
Allow dehardcoding documentation branch and URL in docs links
This makes it possible to change the branch of the documentation that
URLs are pointing to without having to modify all class reference
files.

In the XML class reference, the `$DOCS_URL` placeholder should be used,
and will be replaced automatically in the editor and when generating
the RST class reference.

The documentation branch string is set in `version.py`.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit 5341e6010e)
2021-11-15 17:22:47 +01:00
kobewi
7f91cbc397
Expose String.get_slice
(cherry picked from commit e5725c7deb)
2021-11-15 17:22:46 +01:00
Benjamin Armstrong
77add76a16
Clarify how 'audio/driver/output_latency' project setting works
(cherry picked from commit 1e485a7da8)
2021-11-15 16:10:00 +01:00
Rémi Verschelde
9ef3fec87f
Rect2: Clarify docs for has_point excluding bottom and right borders
Improve tests, as well as documentation for `expand`.

(cherry picked from commit 36c4451a7b)
2021-11-15 16:10:00 +01:00