Commit Graph

4008 Commits

Author SHA1 Message Date
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
Rémi Verschelde c9ae52f32e
i18n: Sync classref translations with Weblate (3.5 branch) 2023-01-20 12:30:46 +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
Pedro J. Estébanez d088cfba10
Let make_rst.py be forward compatible with 4.0's
(cherry picked from commit 373e545f55)
2023-01-20 12:14:07 +01:00
Rémi Verschelde 16f6a5b139
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".

Backported from #70885.
2023-01-10 15:32:59 +01:00
Rémi Verschelde f5f0543aec
i18n: Sync classref translations with Weblate (3.5 branch) 2022-12-13 14:36:30 +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
Rémi Verschelde 8dbd40db65 i18n: Sync classref translations with Weblate (3.5 branch) 2022-09-27 23:50:14 +02: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
Voylin f3d1629061 Fixes doc/Makefile fails if path contains spaces
(cherry picked from commit 0fd29f76a2)
2022-09-20 10:28:05 +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
Rémi Verschelde 26a28d6bbd i18n: Sync classref translations with Weblate (3.5 branch) 2022-09-09 14:46:33 +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
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