Commit Graph

8427 Commits

Author SHA1 Message Date
Dalton aca96eb406
Fix function description for Font.get_char_size()
Removed description implying you can pass a second char in order to account for kerning

(cherry picked from commit c9bc54637b)
2024-03-11 15:14:42 +01:00
Hugo Locurcio 48f0e5f12b
Document using RichTextLabel's `meta_clicked` to handle clickable URLs
(cherry picked from commit ea03154a27)
2024-03-11 15:14:10 +01:00
Hugo Locurcio fb55840d92
Document initial position project settings not affecting run from editor
(cherry picked from commit d3df15f823)
2024-03-11 15:13:42 +01:00
Allen Pestaluky 002028ea40
Fix docs for Color class regarding bits per component.
This fixes godot-docs#8906 ( https://github.com/godotengine/godot-docs/issues/8906 )

(cherry picked from commit 0e977e087c)
2024-03-11 15:12:55 +01:00
Hugo Locurcio 5a0f95edd2
Document `OS.execute()` limitations on Android
(cherry picked from commit d94ee14123)
2024-03-11 15:12:22 +01:00
Florian Grabmeier 5b63622726
Remove duplicate reference of CUSTOM_ARRAY_RBGA8_URNOM in docs
(cherry picked from commit 02faccd14f)
2024-03-11 15:11:17 +01:00
A Thousand Ships c3d9191f33
Fix inverted link in docs
Title and url were swapped

(cherry picked from commit 17000bf8c3)
2024-03-11 15:10:39 +01:00
Emmanouil Papadeas 263616aab0
Minor fix in DisplayServer.xml to include Linux & Windows in FEATURE_NATIVE_DIALOG
(cherry picked from commit 2ba6066d5d)
2024-03-11 15:10:11 +01:00
Micky 84b8c3275d
Mention and deprecate InputEventJoypadButton's pressure
(cherry picked from commit 25c0c95960)
2024-03-11 15:09:01 +01:00
Micky 2bbd4aabdb
Tweak XROrigin3D documentation
(cherry picked from commit 552403d581)
2024-03-11 15:07:42 +01:00
Micky 968f592984
Overhaul Transform3D documentation
(cherry picked from commit 64ba22a9a7)
2024-03-11 15:06:22 +01:00
Micky f2abdd143e
Add missing documentation for AudioStream & AudioStreamPlayback
(cherry picked from commit 8f4598bad4)
2024-03-11 15:04:48 +01:00
Micky 316d3d8a0d
Add a few notes to Sprite3D's documentation
(cherry picked from commit 8ca47c981d)
2024-03-11 15:04:25 +01:00
Micky 90871bc800
Overhaul documentation about MIDI support
(cherry picked from commit 8723d116c4)
2024-03-11 15:03:28 +01:00
20kdc 0f38f50e97
Fix the documentation of Bone2D::apply_rest (squashed)
Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>
(cherry picked from commit f16f8bf39b)
2024-03-11 15:03:07 +01:00
Hugo Locurcio 755620e364
Document Bounce = 1.0 not being sufficient for infinite energy conservation
(cherry picked from commit 7ff1704b1b)
2024-03-11 15:02:49 +01:00
Lucas Clemente Vella 41648610cc
Improve docs on how ParallaxLayer mirroring works.
I wrote everything I wish was written when I tried to make an
infinite scrolling background, addressing every point of every
mistake I made.

(cherry picked from commit 40813b68f0)
2024-03-11 15:02:16 +01:00
kobewi 5960a15a46
Clarify Tween.set_parallel()
(cherry picked from commit 207bd34aa5)
2024-03-11 15:00:50 +01:00
A Thousand Ships 36e611fa83
Prevent threading problems in `TileMap` 2024-02-27 16:02:54 +01:00
Ekaterina Vaartis 71a6870c06 Clarify that LightmapGI is not supported in compatibility renderer 2024-02-17 13:07:20 +03:00
Mika Viskari c2d38b4388 Fix invalid frame index when Sprite2D's hframes or vframes has been changed
(cherry picked from commit 484c5b5aff)
2024-01-25 18:32:37 +01:00
DevPoodle 50eaeec2f7 Add descriptions to the remaining properties of RDPipelineDepthStencilState
(cherry picked from commit 0bb744e555)
2024-01-25 17:40:45 +01:00
Micky f7f86cf5db Add missing descriptions to remaining signals.
(cherry picked from commit 8f10d7dd19)
2024-01-25 17:40:45 +01:00
A Thousand Ships b6d78d8eb7 Clarify that `Callable` will not be encoded with `var_to_bytes`
(cherry picked from commit c909354396)
2024-01-25 17:40:45 +01:00
Septian 6b3e4bb0ec Fix various typos in documentation
(cherry picked from commit d3e7b8c8a8)
2024-01-25 17:40:45 +01:00
Micky 93fd2f7768 Replace some "uncommon" words in class reference
(cherry picked from commit 61bdbdd9ee)
2024-01-25 17:40:45 +01:00
MewPurPur 06ccf2bbb5 Add performance note to Array.resize()
(cherry picked from commit 80b636069a)
2024-01-25 17:40:45 +01:00
jsjtxietian 7e33c6bf22 Update get_image doc to mention that it will return an empty image with invalid texture
(cherry picked from commit d73312d5e9)
2024-01-25 17:40:44 +01:00
Alex Drozd 58dd33e3d0 Add note that a large value for outline_size is not recommended
(cherry picked from commit daa8942f41)
2024-01-25 17:40:44 +01:00
Micky b0318cfb3d Overhaul AABB's documentation
(cherry picked from commit 8467245526)
2024-01-25 17:40:44 +01:00
Micky 4f60f850f7 Specify how CanvasTexture does not work in 3D
(cherry picked from commit 52d062560b)
2024-01-25 17:40:44 +01:00
Steven Schoen e19f2c6b76 Clarify Node doc: get_child returns null for invalid index
(cherry picked from commit 3c416f3a64)
2024-01-25 17:40:44 +01:00
Micky 3b2cdc2cc5 Overhaul Node Documentation
(cherry picked from commit b5ca06c9ca)
2024-01-25 17:40:44 +01:00
Gwen 27d08e2d87 Correct C# syntax in _validate_property example for the Object class
(cherry picked from commit e40b23c619)
2024-01-25 17:38:16 +01:00
Nico 49cec88ff9 Complete the docs for Quaternion
(cherry picked from commit d67e7f8729)
2024-01-25 17:38:15 +01:00
Markus Sauermann bb8b208ede Explain which nodes receive `NOTIFICATION_WM_SIZE_CHANGED`
(cherry picked from commit 361aa909da)
2024-01-25 17:38:15 +01:00
A Thousand Ships cc90979f35 Clarify that `@GlobalScope.clamp` does not do component-wise clamping
(cherry picked from commit e7dbb7a267)
2024-01-25 17:38:15 +01:00
Septian e35bbb2f85 Fix various typos in documentation
(cherry picked from commit d83cad6d9b)
2024-01-25 17:38:15 +01:00
Micky e00f2e598a Link to the "article" in the docs instead of saying "article"
(cherry picked from commit 78c9e2c53a)
2024-01-25 17:38:15 +01:00
ZeferinoI d4114f1631 Update the description of the method get_connection_line in GraphEdit.xml
The form should be like { from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }

(cherry picked from commit 53ab38a34e)
2024-01-25 17:38:15 +01:00
jsjtxietian 2ba4a7dd3d Add thread guard for force_draw and update relared doc
force_draw must be called from main thread

(cherry picked from commit b88b84ce18)
2024-01-25 17:38:15 +01:00
A Thousand Ships 04207a87b8 Clarify `PackedByteArray.decompress*` limitations with external data
(cherry picked from commit 4850b866e8)
2024-01-24 16:38:29 +01:00
CardboardCarl d11ef2d908 Clarified behavior of RayCast objects when get_collision_point() is used inside a collision shape
(cherry picked from commit 6dfec4f70d)
2024-01-24 16:38:28 +01:00
Erik Johnson 837aeeac89 Add descpription for rendering/limits/spatial_indexer/threaded_cull_minimum_instances
(cherry picked from commit 498f46063d)
2024-01-24 16:38:28 +01:00
31 853b505228 Include animation.length in Animation example
The length of an Animation isn't automatically set by adding keys, and
it must be set manually. The existing example only has keys up to 0.5s,
so the default value of 1.0s may be acceptable. However, this results in
unexpected behavior for anyone who makes an animation longer than 1.0s.
Include animation.length in the example because it's important.

Also, increase the key position to 2.0s so it won't be confusing that
the assignment is somewhat redundant.

(cherry picked from commit 698c67d540)
2024-01-24 16:38:28 +01:00
Micky 55baf9fc58 Add missing descriptions to PrimitiveMesh and SoftBody3D
(cherry picked from commit a33777d49d)
2024-01-24 16:38:27 +01:00
Hugo Locurcio 4ee5b33875 Document changing the window's resizable status at runtime
(cherry picked from commit d6768a17fa)
2024-01-24 16:01:59 +01:00
Micky 02e95d5a08 Fixing some reports to String's documentation
Closes https://github.com/godotengine/godot-docs/issues/8043
Closes https://github.com/godotengine/godot-docs/issues/8044
Mitigates https://github.com/godotengine/godot-docs/issues/8190
Closes https://github.com/godotengine/godot/issues/86734

(cherry picked from commit 46b0f3e9d6)
2024-01-24 16:01:59 +01:00
jsjtxietian 5f9ed5418d Mention CollisionPolygon2D.polygon is local to the given CollisionPolygon2D
(cherry picked from commit f5409dc132)
2024-01-24 16:01:58 +01:00
Micky a327fb14fb Add missing descriptions for Image's documentation
(cherry picked from commit e01b91777a)
2024-01-24 16:01:58 +01:00