Commit Graph

3345 Commits

Author SHA1 Message Date
Hugo Locurcio bcfc01f471
Mark debugger limits settings as requiring a restart
These settings are only read once on engine initialization.

(cherry picked from commit f84a202235)
2023-09-24 14:11:11 +02:00
Yuri Sizov e21c8fdd35 Update make_rst.py to match the master version
This does not include master-specific concepts, like
constructors, operators, annotations, and bitfields.

(cherry picked from commit 0f24d6ecf7)
2023-08-31 14:21:58 +02:00
Hugo Locurcio a5ba0a2977
Document the database for `Input.get_joy_name()` and `Input.get_joy_guid()`
(cherry picked from commit 922d2b7034)
2023-08-28 16:53:04 +02:00
stmSi 15fabc77ee
Added note to used set_deferred while setting scroll values in _ready function.
(cherry picked from commit 83626ab90d)
2023-08-28 16:48:34 +02:00
Ninni Pipping 596aeb975f
Add information about how `Engine.time_scale` affects Timers
(cherry picked from commit 16a1465380)
2023-08-28 16:42:14 +02:00
Hugo Locurcio ff8c53d9eb
Document custom mouse cursors larger than 128×128 potentially having issues
(cherry picked from commit 92730fb07d)
2023-08-28 16:40:31 +02:00
Rémi Verschelde 42bf1ef3fe
Merge pull request #80370 from broquaint/fix-tween-cheatsheet-url
[3.5] Fix Tween cheatsheet URL
2023-08-21 08:09:29 +02:00
Ninni Pipping 528221fb63
[3.x] Add example for `NodePath` to grandparent
(cherry picked from commit b3ebc80feb)
2023-08-19 00:38:18 +02:00
Ninni Pipping 1cc210d1e9
[3.x] Clarify `String.get_slice` behavior
Clarify that the function returns the whole string if there is no
instances of the delimiter in the string.

(cherry picked from commit dec7cb5548)
2023-08-19 00:37:52 +02:00
MJacred e12f95b80d
[3.x] Warn against using non-uniform scale for 3D physics (in class reference only)
partial backport of #67847
fixes #56824

(cherry picked from commit 1c63c54ab3)
2023-08-19 00:36:14 +02:00
Ninni Pipping eff9feb4a6
[3.x] Clarify range of various ID values are 32 bit
(cherry picked from commit 96ad972dc5)
2023-08-19 00:36:14 +02:00
Hugo Locurcio f5525d9e1e
Document 3D particle color properties requiring vertex color as albedo
(cherry picked from commit c65967c17f)
2023-08-19 00:36:14 +02:00
Aaron Franke bdc8049651
[3.x] Fix small mistake in docs, "antecedents" -> "ancestors"
(cherry picked from commit 92f0c9272f)
2023-08-19 00:36:13 +02:00
Hugo Locurcio 85b6cc1af7
Improve documentation related to ubershaders in ProjectSettings
(cherry picked from commit d20305a718)
2023-08-19 00:36:13 +02:00
Ninni Pipping 1297045a8c
[3.x] Fix `NodePath` subname index range documentation
(cherry picked from commit ff61feaf4e)
2023-08-19 00:36:13 +02:00
Markus Sauermann c6e0ed298c
Include the follow-viewport-transform into CanvasLayer transform calculations
The follow-viewport-transform was missing from several calculations

3.x version of #59682

(cherry picked from commit 608cbd8296)
2023-08-18 21:20:42 +02:00
Dan Brook 5bfecf1921 Correct URL pointing to tween cheatsheet
The cheatsheet doesn't exist in the same place on `master` so the URL
has been changed to point to the same file in the `3.5` branch of the
`godot-docs` repo.
2023-08-07 18:25:49 +07:00
Hugo Locurcio 88e39bf5a7
Document using `String.percent_encode()` with `OS.shell_open()`
(cherry picked from commit 1a6343729b)
2023-03-06 13:32:03 +01:00
Aaron Franke b0070454ac
[3.x] Improve the clarity of Viewport's documentation
(cherry picked from commit 1949b7c652)
2023-03-06 13:32:02 +01:00
Hugo Locurcio 0193107e1a
Mention `String.match()` is also called "glob"/"globbing"
This is mostly for Ctrl + F purposes, in case someone is looking
how to perform globbing on a string.

(cherry picked from commit 64906bd1f7)
2023-03-06 13:05:47 +01:00
Hugo Locurcio fcc4516c11
Document Environment's `background_energy` property affecting lighting
Godot 4.0 allows controlling ambient and specular light intensity
separately, but 3.x doesn't.

(cherry picked from commit 646a2d9d94)
2023-03-06 13:03:24 +01:00
Hugo Locurcio 6a0bb1ef9d
Document image size restrictions for custom mouse cursors in HTML5
(cherry picked from commit 296b8f299a)
2023-01-20 12:15:02 +01:00
Hugo Locurcio eb100cbddb
Only support XDG directory path configuration on Linux
This also harmonizes the server code to be consistent with Linux desktop
(with warnings printed for relative XDG paths).

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit 06c266f231)
2022-12-12 14:43:22 +01:00
Hugo Locurcio 5dc2a60c64
Document debanding only affecting 3D rendering by default
(cherry picked from commit 4475a93736)
2022-12-12 14:43:07 +01:00
Jordan Schidlowsky 894e302d9a
expose additional global enums in 3.x which are available in master
(cherry picked from commit dc5226ecfd)
2022-12-12 14:42:05 +01:00
Steve Cotton 9e6f9a451e doc: link GPUParticles2D to the 2D Particles demo
Add a comment in the link to the Dodge The Creeps demo too. That demo only uses
particles for one thing (to leave a trail when the player moves), they're not
interacting with anything else in the demo; it took me a bit of searching to
find where they were used.

(cherry picked from commit 6db9752f23)
2022-12-12 14:16:16 +08:00
Haoyu Qiu 7decec181c Add note about GROUP_CALL_UNIQUE not considering arguments
(cherry picked from commit 3f2d6f5f6c)
2022-12-12 14:14:00 +08:00
Hugo Locurcio bacda47336 Fix BackBufferCopy `rect` property appearing when not relevant in inspector
The `rect` property is only effective if `copy_mode` is Rect.

(cherry picked from commit 5115db63aa)
2022-12-12 13:39:10 +08:00
QbieShay a945538eae added options for sorting transparent objects
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
(cherry picked from commit acdcbefa4e)
2022-12-12 13:33:52 +08:00
Zak Grumbles c703029a28 Add note regarding RefCounted to EditorScript docs
(cherry picked from commit e5dc2ed982)
2022-12-12 13:25:19 +08:00
Hugo Locurcio ad97db2da4 Document `Array.sort()` and `sort_custom()` using unstable sorting
(cherry picked from commit 85b617a6a3)
2022-12-12 13:24:51 +08:00
Fireflash 4bf7695671 Update AudioStreamGeneratorPlayback.xml
Fixed incorrect method description for `get_frames_available`.
According to [The AudioStreamGenerator source](https://github.com/godotengine/godot/blob/master/servers/audio/effects/audio_stream_generator.cpp#L132), the `get_frames_available` method should return the space remaining in the sample buffer.

(cherry picked from commit 7823ca1367)
2022-12-05 10:00:34 +08:00
kleonc ac40d19ac5 Docs Clarify Array.fill behavior when reference type is passed in
(cherry picked from commit 5f01413774)
2022-12-05 09:33:25 +08:00
Hugo Locurcio d7ae42dc8d Document known issues with CylinderShape
(cherry picked from commit 14391ef344)
2022-12-05 09:29:25 +08:00
Hugo Locurcio d08b312984 Document (Omni/Spot)Light ignoring Spatial's scale property
(cherry picked from commit d17d6d6cc4)
2022-12-05 09:22:57 +08:00
smix8 945991e020 Fix avoidance calculation on NO_THREADS build
(cherry picked from commit f15cb16b14)
2022-12-05 09:19:56 +08:00
Hugo Locurcio 1a385e1bad Document Mesh vertex color compression clamping overbright/HDR colors
(cherry picked from commit 811f814f45)
2022-09-22 20:37:29 +02:00
Ricardo Buring 553c9aba6f Document behavior of areas with concave shapes
(cherry picked from commit be5d18163d)
2022-09-21 13:35:17 +02:00
kobewi 92f1f815c6 Add more clarifications about Tween processing
(cherry picked from commit 038cb677cb)
2022-09-20 10:26:56 +02:00
Haoyu Qiu 46f81a5997 Fix typo in CollisionObject documentation
(cherry picked from commit 4bc1ea0ac4)
2022-09-20 10:24:44 +02:00
lawnjelly 0a216bfec0 Portals - clarify docs VisualInstances only
Makes it more clear in the documentation that some debugger features are expected not to show when portals are active.

(cherry picked from commit dcf52103a6)
2022-09-20 10:23:18 +02:00
Yuri Sizov 3d97e97be8 Fix parameter references in Theme documentation
(cherry picked from commit 9496254737)
2022-09-20 10:22:44 +02:00
kobewi 96f8177b42 Improve the description of follow_viewport_enabled
(cherry picked from commit 229e764290)
2022-09-09 14:31:55 +02:00
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