Commit Graph

7983 Commits

Author SHA1 Message Date
Hugo Locurcio
53cb88554a Document the database for Input.get_joy_name() and Input.get_joy_guid()
(cherry picked from commit 922d2b7034)
2023-06-16 15:13:00 +02:00
Raul Santos
c99f67105f C#: Fix dictionary key lookup documentation
The method to check if a key exists in the dictionary is called `ContainsKey`.

(cherry picked from commit 6723b4e8c3)
2023-06-16 15:13:00 +02:00
Violet Johnson
4c34531499 Update C# code example to fix an error
Update doc/classes/AnimationNodeStateMachinePlayback.xml

Co-authored-by: Raul Santos <raulsntos@gmail.com>
(cherry picked from commit cb7fdad3b4)
2023-06-16 15:13:00 +02:00
rainlizard
8df97cf368 Specify how to use the global animation library in gdscript
(cherry picked from commit bf7adc8670)
2023-06-16 15:13:00 +02:00
Max Hilbrunner
1a1095f986 Docs: Add FileAccess.close, remove dupl. example
(cherry picked from commit aaf43a260e)
2023-06-16 15:12:59 +02:00
TechnicalSoup
62d7797cbf Update HTTPRequest Class Documentation
Reword the timeout member definition to indicate that example timeout values are suggestions.
Add definition for timeout constant.

Apply suggestions from code review

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
(cherry picked from commit d185220b32)
2023-06-16 15:12:59 +02:00
Ninni Pipping
0e697e102b Add more info on the nature of NAN
(cherry picked from commit 5e3c625e24)
2023-06-16 15:12:59 +02:00
mara
a44409bf54 Clarify doc for Color.hex and C# Color()
The "alpha channel first" seems misleading to me. It doesn't match with
the examples, so remove it. Add a more detailed specification of the
expected number format in hex.

(cherry picked from commit 779ac20bb9)
2023-06-16 15:12:59 +02:00
Hugo Locurcio
484a39c34d Document seamless caveats on small textures in NoiseTexture2D and NoiseTexture3D
This also harmonizes "normal map" spelling across the class reference.

(cherry picked from commit 9e21647578)
2023-06-16 15:12:36 +02:00
PoolloverNathan
e72e24b3cc Update outdated syntax in JavaScriptBridge doc
According to `JavaScriptBridge`, thus takes a Callable, not an object/string pair.

(cherry picked from commit 04480f196a)
2023-06-16 15:12:20 +02:00
archsolar
3c2e30b319 Docs: Fix SurfaceTool example caps typo
(cherry picked from commit 6719fea8dc)
2023-06-16 15:12:20 +02:00
Devin
412d947dc3 Updated Object's class reference documentation for set_meta to indicate metadata's name must be a valid identifier
(cherry picked from commit cdc2e6d872)
2023-06-16 15:12:20 +02:00
VolTer
b118d89eed Overhaul the top sections of the class reference (Core classes)
(cherry picked from commit 04562662d3)
2023-06-16 15:12:10 +02:00
VolTer
2792b520a7 Overhaul the top sections of the class reference (GUI classes)
(cherry picked from commit 151a4ba6a5)
2023-06-16 14:56:34 +02:00
Rindbee
fd08e35cd3 Add instructions for configuring CheckBox as a radio button
(cherry picked from commit 3dc487b450)
2023-06-16 14:56:16 +02:00
Ninni Pipping
465f363c77 Minor grammar fixes to documentation
(cherry picked from commit 17fb77223c)
2023-06-16 14:44:53 +02:00
Haoyu Qiu
605b6e568f Fix code tag typo in class reference
(cherry picked from commit 85f137912d)
2023-06-16 14:44:53 +02:00
Silc Lizard (Tokage) Renew
c5c27e64ea Remove out-dated lines from class reference of Skeleton3D
(cherry picked from commit 26cc4bbd82)
2023-06-16 14:44:52 +02:00
VolTer
a4e8ba9b5d Overhaul the top sections of the class reference (Animation classes)
(cherry picked from commit 4af3fc7e26)
2023-06-16 14:44:52 +02:00
Yuri Sizov
0934545d23 Validate code tags in documentation for potential params
Adds a check to make_rst to look for matches
between the text inside of the [code][/code] tag
and known param identifiers.
Fixes most of what was revealed.

(cherry picked from commit 391eccca76)
2023-06-16 14:44:52 +02:00
Dipal Zambare
3aea815a05 Fix typo in CS notification example of the Object class
(cherry picked from commit 41ac5a406e)
2023-06-16 14:37:53 +02:00
Ninni Pipping
41b10f1222 Clarify range of various ID values are 32 bit
(cherry picked from commit 8cf98dda23)
2023-06-16 14:37:53 +02:00
skyace65
a7ba5e9939 Fix incorrect Polygon2D description
(cherry picked from commit 7d9a0f1fe7)
2023-06-16 14:37:53 +02:00
FranckRJ
d6e73cabad Replaced "mirror" by "repeat" in doc of ParallaxLayer::motion_mirroring
Also added a warning explaining that despite its name the texture isn't mirrored.

(cherry picked from commit 4e06f611b8)
2023-06-16 14:37:52 +02:00
jess3jane
3fbf460a9f Accurately document StringName comparisons
(cherry picked from commit 2f9121dea6)
2023-06-16 14:37:52 +02:00
Rémi Verschelde
da3f725206
i18n: Sync translations with Weblate
Last 4.0 sync before switching Weblate to track 4.1 strings.
2023-06-12 14:35:33 +02:00
Max Hilbrunner
75e5bf789d Small docs syntax fixes
(cherry picked from commit a521b85976)
2023-05-19 16:15:36 +02:00
Rémi Verschelde
acc82a1d05
i18n: Sync translations with Weblate 2023-05-19 08:55:54 +02:00
Yuri Sizov
eced93a3f5 Revert "Improve the UX of ViewportTexture in the editor"
This reverts commit b91b8fce43.
2023-05-18 21:46:40 +02:00
voidshine
9a88b47cb1 Document MIDI zero velocity quirk
(cherry picked from commit 06d02928b7)
2023-05-18 19:22:23 +02:00
kleonc
945d669da0 Fix property usage docs referring to removed network flag
(cherry picked from commit fc92ee6bf4)
2023-05-18 19:22:22 +02:00
Ninni Pipping
1f7a5f6144 Document limitations of placeholder textures
(cherry picked from commit bd2e377007)
2023-05-18 19:22:22 +02:00
VolTer
c37259b181 Add WorkerThreadPool documentation
(cherry picked from commit bd257092da)
2023-05-18 19:22:22 +02:00
Rémi Verschelde
9cd9a07c27
i18n: Sync translations with Weblate 2023-05-12 14:14:05 +02:00
Rémi Verschelde
47b3f95874
CI: Make codespell checks blocking, but only check changed files
(cherry picked from commit b226f7e587)
2023-05-12 13:56:49 +02:00
Hugo Locurcio
7d0af7d10f
Document high performance cost of turbulence in ParticleProcessMaterial
- Mention that GPUParticlesAttractorVectorField3D can be used as an
  alternative to turbulence in 3D.

(cherry picked from commit f10759489d)
2023-05-12 12:31:58 +02:00
lawnjelly
efbb28d09a
Make acos and asin safe
A common bug with using acos and asin is that input outside -1 to 1 range will result in Nan output. This can occur due to floating point error in the input.

The standard solution is to provide safe_acos function with clamped input. For Godot it may make more sense to make the standard functions safe.

(cherry picked from commit 50c5ed4876)
2023-05-12 12:31:23 +02:00
Rindbee
b91b8fce43
Improve the UX of ViewportTexture in the editor
The associated `ViewportTexture`s will update the `viewport_path`
in time when the `Viewport`'s nodepath is changed (caused by renaming
the node names or moving in the SceneTree dock).

If the target `Viewport` is changed by resetting the `viewport_path`,
the `ViewportTexture`s will be re-setup and emit `changed` signal in
time.

(cherry picked from commit af58f1e854)
2023-05-12 12:31:22 +02:00
kobewi
1146172b30
Prevent errors when using ViewportTexture
(cherry picked from commit 1b9802fa8c)
2023-05-12 12:31:22 +02:00
David Snopek
2a8501e1a2
Add missing documentation for MultiplayerPeerExtension
(cherry picked from commit 4d13be3c5e)
2023-05-12 12:31:22 +02:00
stmSi
25ab61f82a
Added note to used set_deferred while setting scroll values in _ready function.
(cherry picked from commit 83626ab90d)
2023-05-12 12:31:21 +02:00
Hugo Locurcio
35fa05fa51
Document caveats related to exported project binary resource conversion
(cherry picked from commit febc674f48)
2023-05-12 12:31:21 +02:00
Hugo Locurcio
2d7228251d
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation
This brings the overall class reference completion percentage from 87% to 92%.

(cherry picked from commit 5056c427d3)
2023-05-12 12:31:19 +02:00
Ninni Pipping
9a5af8e793
Clarify that event handling does not affect Input
(cherry picked from commit 732ad382a6)
2023-05-12 12:14:45 +02:00
Michael Alexsander
b7206e25bf
Improve some descriptions in the OS docs
(cherry picked from commit 6db12c5e50)
2023-05-12 12:11:23 +02:00
Aaron Franke
f49c69a1e7
Fix small mistake in docs, "antecedents" -> "ancestors"
(cherry picked from commit 740b0713a2)
2023-05-12 12:07:02 +02:00
VolTer
78c190f4f5
Add an example for how to use AudioStreamGenerator
(cherry picked from commit 9d77caaf95)
2023-05-12 12:07:02 +02:00
VolTer
e530168fb8
Document TextServerDummy
(cherry picked from commit c8e06fe838)
2023-05-12 12:07:02 +02:00
UltraBIF
4b63ce83d2
Fixed various typos across the docs
(cherry picked from commit 8106d33d0f)
2023-05-12 12:07:02 +02:00
Bastiaan Olij
a5cb7a5eb5
Expose viewports render targer RID
(cherry picked from commit ab60d3b65c)
2023-05-12 12:07:01 +02:00