Commit Graph

4026 Commits

Author SHA1 Message Date
Hugo Locurcio c6461d31d2 Improve documentation related to audio input permissions
(cherry picked from commit ac31fac9a5)
2022-09-05 15:47:43 +02:00
BenniKane 6d9904f1a9 doc: Clarifying NavigationAgent and NavigationAgent2D velocity_computed requires avoidance_enabled to be true to emit
(cherry picked from commit ed5b832a81)
2022-09-05 15:47:14 +02:00
Michael Alexsander a65247a405 Fix some corner cases in the `Menu/OptionButton` item auto-highlight
(cherry picked from commit 1e80b17a8d)
2022-09-05 15:46:06 +02:00
kobewi 5c9ced191b Mention that grab_focus is more reliable deferred
(cherry picked from commit 188d5593e1)
2022-09-05 15:44:04 +02:00
Yuri Sizov d92b207189 Backport fixes to documentation for paths, curves and navigation servers
(cherry picked from commit 39f46613bb)
2022-08-30 11:20:03 +02:00
Andy Maloney e85c5dba23 [doc 3.x] Clarify that AnimationNode virtual methods need to be implemented rather than called directly
Backport of #64344

Fixes #35272

(cherry picked from commit 4ee4c7954a)
2022-08-30 11:19:09 +02:00
Hugo Locurcio 2ac25fbcc7 Document run-time SceneTree debug property changes not working correctly
(cherry picked from commit 3396f45eef)
2022-08-30 11:18:58 +02:00
Aaron Franke e3745de02d [3.x] Fix incorrect Camera3D size documentation
(cherry picked from commit cac69ea132)
2022-08-30 11:17:33 +02:00
Michael Alexsander 682428279a Expose `set/get_tab_button_icon()` to scripting
(cherry picked from commit 73470e1b16)
2022-08-30 11:16:01 +02:00
Haoyu Qiu 9f4bb53a87 Improve documentation for `get_animation()`
(cherry picked from commit fed2879463)
2022-08-30 11:15:24 +02:00
Atlinx d3a86d6829 Add missing parameters for signal in docs
(cherry picked from commit 0e3097c023)
(cherry picked from commit f624acef42)
2022-08-30 11:14:50 +02:00
Haoyu Qiu 5d30d77fd7 Fix missing URL text in the classref
(cherry picked from commit a90c348a86)
2022-08-30 11:07:29 +02:00
Micky 179a16a67c Improve documentation of CanvasItem's draw logic
(cherry picked from commit 953c78eaff)
2022-08-29 17:14:38 +02:00
kobewi 503fddc0fe Mention the stretching behavior of PopupPanel
(cherry picked from commit a2b088b1c1)
2022-08-29 17:14:20 +02:00
Dan Boorstein 9a037a0727 Add note about using AudioListener2D
There was no mention of the effect of AudioListener2D in this documentation, making it unclear if there was a relationship. The new text is copied and modified from the AudioStreamPlayer3D documentation.

Use 'an' as article before 'AudioListener3D'

(cherry picked from commit a7ebc6fb18)
2022-08-29 17:13:03 +02:00
Marlin Watts-Woods 98074e1861 Added to Sprite3D Documentation
(cherry picked from commit f8f665b03e)
2022-08-29 17:12:25 +02:00
Hugo Locurcio f93f583c42 Improve InstancePlaceholder documentation
(cherry picked from commit 5acf30b538)
2022-08-29 17:12:01 +02:00
Hugo Locurcio e237bdf37c Improve documentation related to anisotropic filtering
(cherry picked from commit d2ef3bf8a6)
2022-08-29 17:11:13 +02:00
Olivier Bombardier cd6764611c Fix has_filter of AnimationNode not being called in scripts
(cherry picked from commit c988deb3b1)
2022-08-29 17:09:40 +02:00
Haoyu Qiu 59061dc619 Document `outline` parameter of `Font.draw_char()`
(cherry picked from commit 93493843b0)
2022-08-29 17:06:52 +02:00
Haoyu Qiu 1ea8b9d2b7 Fix Time.get_unix_time_from_system() not including msecs
(cherry picked from commit 1be078ebcb)
2022-08-08 16:32:16 +02:00
Hugo Locurcio 96d3b8d866 Improve Shape2D's `custom_solver_bias` description
(cherry picked from commit 373e3dffb4)
2022-08-08 13:35:55 +02:00
Cristiano Simao b00758fe18 doc: Clarify `MultiMesh.set_instance_color` re: white albedo color
If the user does not set the albedo color to pure white, then the
multiplication with a value different from 1 will produce modulated colors.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit 1f6709d6e3)
2022-08-08 13:19:43 +02:00
Hugo Locurcio aa26828f76 Fix broken rST reference in HTTPClient documentation
References in reStructuredText cannot be located within bold/italic
text. This caused the online class reference to have the `:ref:`
text written as-is.

(cherry picked from commit 9709205112)
2022-08-08 13:17:03 +02:00
Tom 3b3721262c updated the String class with info about the 'allow_empty' optional argument
(cherry picked from commit 39233c299c)
2022-08-08 13:16:27 +02:00
Hugo Locurcio 2ed3818277 Improve `range_lerp()` and related methods documentation
(cherry picked from commit bd19c9a95c)
2022-08-08 13:16:09 +02:00
Rémi Verschelde b671ea88fb i18n: Sync classref translations with Weblate 2022-08-05 03:12:25 +02:00
Matt eba8ce7d8c adds null case to weakref docs
(cherry picked from commit dc4e72a3fc)
2022-08-03 15:01:30 +02:00
Hugo Locurcio 8543c5599c
Document Camera's frustum offset property requiring Frustum projection 2022-08-03 02:45:05 +02:00
Rémi Verschelde 751b16a285 File: Re-add support to skip CR (`\r`) in `File::get_as_text`
This was removed in #63481, and we confirmed that it's better like this,
but we add back the possibility to strip CR as an option, to optionally
restore the previous behavior.

For performance this is done directly in `String::parse_utf8`.

Also fixes Android `FileAccess::get_line()` as this one _should_ strip CR.

Supersedes #63717.

(cherry picked from commit 1418f97c70)
2022-08-01 00:40:55 +02:00
Rémi Verschelde 284dbef733
Merge pull request #63639 from twobitadder/scenetree_docs_how_do_i_rebase
updated SceneTree docs to include information on passing in null
2022-07-30 11:22:40 +02:00
Rémi Verschelde 4a8d3bf129
Merge pull request #63649 from snailrhymer/meshinstance-fix
Fix typo in MeshInstance.xml
2022-07-30 09:21:51 +02:00
SnailRhymer eb7ce02239 Fix typo in MeshInstance.xml 2022-07-29 22:21:22 +01:00
twobit 359205f7d7 updated scenetree docs to include information on passing in null 2022-07-29 15:47:53 -04:00
David Snopek 5eaf83f2d7 Add error messages and docs to explain restrictions when calling NetworkedMultiplayerCustom.initialize() 2022-07-29 13:51:44 -05:00
David Snopek 738e76b710 Add error messages and docs to explain allowed transitions in NetworkedMultiplayerCustom.set_connection_status() 2022-07-29 09:02:53 -05:00
pattlebass fb7ecc748f [3.x] HTML5: Add support for `Input.vibrate_handheld()` 2022-07-28 13:20:05 +03:00
Rémi Verschelde 516d6b6bad i18n: Sync classref translations with Weblate 2022-07-27 15:55:38 +02:00
Rémi Verschelde 76440fe1aa doc: Fix relative paths in `make_rst.py` generated comment
Follow-up to #63495.

(cherry picked from commit f66527ddc3)
2022-07-27 15:29:28 +02:00
Yuri Sizov ff7554413b Improve the autogenerated note in RST docs for class reference
(cherry picked from commit f3561696da)
2022-07-27 15:29:27 +02:00
Andy Maloney 7c06b9b670 Add missing Python type hints in tools/make_rst.py
(cherry picked from commit 4b3d6f04a8)
2022-07-27 15:24:15 +02:00
Rémi Verschelde d3e9ed10e0 doc: Fixup reference to Camera 2022-07-25 14:53:22 +02:00
Zak Grumbles 967755980f Improve documentation for Camera3D's `current` member
* Added additional information to the camera documentation to explain
  how the 'current' attribute behaves when multiple cameras are in a
  scene.

(cherry picked from commit 349c750b18)
2022-07-25 11:44:09 +02:00
Derwent Ready (drentsoft) 12968f3107 Clarified usage of TreeItem get_next*() and get_prev*() functions.
(cherry picked from commit df5a922880)
2022-07-25 11:43:41 +02:00
Hugo Locurcio ed4976d1d5
Expose `VisualServer.viewport_set_use_32_bpc_depth()` to the scripting API
Previously, only the Viewport methods/properties were exposed to the
scripting API.
2022-07-23 03:52:38 +02:00
Rémi Verschelde 4ef99b409d
Merge pull request #63163 from dsnopek/multiplayer-peer-custom-3.x 2022-07-20 22:41:15 +02:00
David Snopek 8ad5889c1a Add NetworkedMultiplayerCustom so high-level multiplayer backends can be added from GDScript 2022-07-19 09:16:41 -05:00
Hugo Locurcio b03ceaba2f
Document support limitations for OmniLight cubemap shadows in GLES2 2022-07-18 22:18:56 +02:00
Rémi Verschelde 7379f2c76a i18n: Sync classref translations with Weblate 2022-07-18 10:21:37 +02:00
Rémi Verschelde 5aa22a21be
Merge pull request #63058 from AaronRecord/backport-global-position-rotation 2022-07-18 09:33:23 +02:00
Rémi Verschelde 1995e1fb8d
Merge pull request #62850 from Calinou/doc-httprequest-timeout-3.x 2022-07-18 09:19:38 +02:00
foxydevloper 5238740fef Add global_translation and global_rotation to Spatial 2022-07-15 21:39:35 -06:00
Rémi Verschelde 101cbe5d5b
Merge pull request #62723 from hansemro/eraser-detect-3.x 2022-07-15 00:13:15 +02:00
Hugo Locurcio 28b9e376cf
Improve documentation for HTTPRequest's `timeout` property 2022-07-08 23:25:06 +02:00
Rémi Verschelde 685cecbd5f AudioStreamPlayer: Clarify that no validation is made on 'bus' name
Supersedes #39605.
Fixes #39585.

(cherry picked from commit eedb729771)
2022-07-08 16:41:41 +02:00
Rémi Verschelde f05cecdc43
Merge pull request #55650 from kdiduk/pooled-arrays 2022-07-08 00:15:44 +02:00
Kirill Diduk 7b8b91f505 [GDScript][GDNative] Add 'sort' and 'has' methods to pooled arrays
This is a backport from 4.0 to 3.x that adds 'sort' and 'has' methods
to the following types:
- PoolByteArray
- PoolIntArray
- PoolRealArray
- PoolStringArray
- PoolVector2Array
- PoolVector3Array
- PoolColorArray

For all the types above, the methods 'sort' and 'has' have been
exposed to the GDNative API (v. 1.3)

Since the method 'has' was already implemented in GDScript before,
in this commit it has been only exposed to GDNative API.

The classes documentation is updated.

The method 'sort' uses the exisging class "Sorter".

Pooled arrays in 4.0 are rewritten, that's why this backport is not
completely indentical to the original PR made for 4.0 (see #32144).
2022-07-07 23:24:31 +02:00
Rémi Verschelde d6bcdd18c3 Input: Re-enable input accumulation disabled by error in 3.4
Input accumulation was implemented and enabled by default in 3.1, and
I don't recall major complaints around it (or bugs were fixed).

In 3.4, #42220 added input buffering and apparently toggled input
accumulation off by mistake.

This led to multiple bug reports about degraded performance on Windows,
or simply unexpected behavior change (see linked issues in #55037).

Fixes #55037.
2022-07-07 23:04:51 +02:00
Haoyu Qiu e170ddadef Fix cherry-pick mistakes in SceneTreeTween doc 2022-07-07 00:51:50 +08:00
Rémi Verschelde 417f20f06c i18n: Sync classref translations with Weblate 2022-07-06 15:04:01 +02:00
Jean-Marc Pelletier ee227b9d09 StyleBox: Document correct methods to draw with a RID
(cherry picked from commit 63d5f31561)
2022-07-06 11:43:04 +02:00
Hansem Ro 193d5c11f3 [3.x, macOS, Windows, X11] Add stylus inverted/eraser support to InputEventMouseMotion event 2022-07-04 16:12:11 -07:00
Rémi Verschelde 7de45b6203 Input: Document that accumulated input is disabled by default
This was actually disabled by mistake in 3.4 causing a regression, but since
this issue survived the whole 3.4.x series and it's now very close to 3.5,
it's too late to change it again.

We might consider it for 3.6 after some beta testing.

Fixes #55037.
2022-07-03 12:00:26 +02:00
Rémi Verschelde df70aa1772
Merge pull request #57566 from Calinou/viewport-shadow-atlas-clamp-sizes 2022-07-03 03:08:03 +02:00
Rémi Verschelde 3d19f21576
Merge pull request #49967 from Calinou/viewport-2d-hdr-print-warning 2022-07-03 02:41:26 +02:00
Rémi Verschelde 86229d0b03
Merge pull request #54239 from Calinou/editor-directionallight-3d-only-show-relevant-properties-3.x
Only show relevant properties in the DirectionalLight inspector (3.x)
2022-07-03 02:02:10 +02:00
saneery cb94797ce4 Add process_mode property to InterpolatedCamera 2022-07-03 01:47:10 +02:00
Haoyu Qiu 4834525242 Improve String.format() documentation
(cherry picked from commit 25c7f567dd)
2022-07-02 00:07:48 +02:00
smix8 5e1063bd0e [3.5] Remove documentation that mentions 2D navigation baking
Cherrypick mentions 2D navigation mesh baking which does only exist very hidden in Godot 3.5.
2022-07-01 22:18:13 +02:00
ConteZero a13b3028a2 Add an option to drag'n'drop selected text in TextEdit
(cherry picked from commit 5d56efcaa4)
2022-06-30 19:23:01 +02:00
Rémi Verschelde c93ccb5d1d i18n: Sync classref translations with Weblate 2022-06-29 12:12:11 +02:00
snailrhymer 28d387f721 Fix typos and improve clarity in Tween docs
(cherry picked from commit aff30b649e)
2022-06-28 16:41:26 +02:00
smix8 7aff541538 Clarify NavigationAgent radius property
Documents Navigation radius property, especially that it affects avoidance only.

(cherry picked from commit e1a4d1d08c)
2022-06-28 16:32:23 +02:00
Pedro J. Estébanez f971c886fa Add safe defaults for async shader compilation 2022-06-28 11:50:38 +02:00
smix8 928c488888 Document limits of using meshes to obstruct navigation mesh baking
Recast (the library used for baking) has no concept of a geometry "inside" and this is intentional. ReCast will add navigation mesh to areas as soon as the area inside a source geometry mesh is large enough to fit a navigation mesh polygon with current baking parameters.

(cherry picked from commit 85cdb1144d)
2022-06-25 12:41:37 +02:00
Haoyu Qiu 6fb76ba266 Fix code example of String.is_valid_integer() 2022-06-25 10:10:27 +08:00
Rémi Verschelde f428bfd456
Merge pull request #62370 from timothyqiu/http-request-doc-3.x
[3.x] Make code example in HTTPRequest classref working
2022-06-24 23:21:10 +02:00
smix8 721c99a530 Add NavigationServer map_force_update() function
Adds map_force_update() function to NavigationServer. This function immediately flushes the Navigationserver command queue and recalculates all navigationmeshes and region connections for a specific map.

(cherry picked from commit fdea269805)
2022-06-24 10:19:00 +02:00
smix8 f0069cc1e9 Add NavigationServer.region_owns_point() helper function
Adds a helper function to check if a world space position is currently owned by a navigation region.

(cherry picked from commit e57360d8df)
2022-06-24 10:19:00 +02:00
Haoyu Qiu c31ce5be02 Make code example in HTTPRequest classref working 2022-06-24 12:05:21 +08:00
smix8 38ee593b76 Add Navigation function to get all navigation maps
Added new function that returns all created navigation map RIDs from the NavigationServer. The function returns both 2D and 3D created navigation maps as technically there is no distinction between them.

(cherry picked from commit c0fed1d4e8)
2022-06-23 16:29:11 +02:00
smix8 fcff804844 Implement NavigationMesh bake area
Adds two new properties to NavigationMesh resources to restrict the navmesh baking to an area enclosed by an AABB with volume.

(cherry picked from commit 0c4d99f4fd)
2022-06-23 16:17:43 +02:00
salamandars 22881a6923 Clarify that MeshInstance surface methods only apply to override materials 2022-06-23 22:58:52 +10:00
Rémi Verschelde 3c35617c50
Merge pull request #62187 from smix8/nav_nodes_depr_3.5 2022-06-20 18:36:17 +02:00
smix8 693aeaf799 [3.5] Mark Navigation/Navigation2D nodes as deprecated
Mark Navigation/Navigation2D nodes as deprecated. They already just redirect calls to the NavigationServer and have no longer a real purpose. In Godot 4.0 both nodes are already removed for good reasons.
2022-06-20 17:37:55 +02:00
smix8 88e42b2915 Add NavigationAgent desired path distance
Add NavigationAgent desired path distance

(cherry picked from commit 07740302f3)
2022-06-20 15:11:09 +02:00
Rémi Verschelde 0cb897421a Node: Rename `child_exited_tree` to `child_exiting_tree`
The name was confusing as this signal is emitted around the same time as
`tree_exiting` and `NOTIFICATION_EXIT_TREE`, i.e. while the child node is
still in tree.

Fixes #59210.

(cherry picked from commit 3e6de687b8)
2022-06-20 15:00:09 +02:00
Hugo Locurcio 8ad483e2d8 Document incremental search support in ItemList, PopupMenu and Tree
(cherry picked from commit 466bd7ce39)
2022-06-20 14:58:15 +02:00
Rémi Verschelde e4d6a4d005
Merge pull request #60799 from Calinou/doc-os-cmdline-args-3.x 2022-06-19 14:09:23 +02:00
Rémi Verschelde 5478afdb1e i18n: Sync classref translations with Weblate 2022-06-19 13:59:41 +02:00
Rémi Verschelde 4137578369 Fix typos with codespell
Using codespell 2.2-dev from current git.

Fix a couple incorrect uses of gendered pronouns.
2022-06-19 13:48:15 +02:00
Rémi Verschelde acd4a01b8c ProjectSettings: Ensure 'editor/' settings aren't nested
Having a mix of settings with and without subcategory makes the 'Editor'
section stand out with a weird UX, as instead of simply being a foldable
section like the others, it also holds its own top-level settings and is
therefore selectable.

This wasn't the case in 3.4, and is fixed in 4.0 by refactoring, so for
3.5 we should preserve the 3.4 UX, even if it's not the best.
2022-06-19 11:47:19 +02:00
Haoyu Qiu b43fdea0d5 Classref typo fixes and improvements 2022-06-17 15:19:31 +08:00
Rémi Verschelde e047c50068 i18n: Sync classref translations with Weblate 2022-06-16 21:06:56 +02:00
Theraot 69653a4b9d Updating AStar2D documentation to mention the new bidirectional paramter
(cherry picked from commit b18a018ad2)
2022-06-16 20:49:04 +02:00
smix8 c6f9627c74 [3.5] Add NavigationAgent2D/3D set_navigation_map() function
Add NavigationAgent2D/3D set_navigation_map() function. Also fixes some bugs from leftover code before the backport update.
2022-06-16 19:25:52 +02:00
Hugo Locurcio bec892c010 Tweak default crash handler message in exported projects
When an exported project crashes, the crash handler message
shouldn't reference the Godot issue tracker, as not all crashes
are Godot's fault.

Reporting crashes that only occur on exported projects is still allowed,
but it should not be done by people who aren't working on the project
in question.

(cherry picked from commit c850ccb7c0)
2022-06-16 10:16:32 +02:00
Aaron Franke fca4af0e58 Document limitations of negative scales in 2D and 3D
(cherry picked from commit 3398fb77a9)
2022-06-16 10:15:41 +02:00
smix8 96e865dfb3 Document NavigationServer API navigation agent callbacks
Document NavigationServer API navigation agent callbacks.

(cherry picked from commit 10c400ca82)
2022-06-16 10:03:47 +02:00
Rémi Verschelde 4e7363cac7
Merge pull request #61996 from smix8/navigation_bp_update_3.x
[3.5] Update NavigationServer backport
2022-06-16 00:17:16 +02:00