Commit Graph

8400 Commits

Author SHA1 Message Date
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
Micky c89cf8476c Add missing descriptions to TextServer's constants
(cherry picked from commit d3150c9c8f)
2024-01-24 15:57:59 +01:00
Quincy Wofford 59b50775dd corrected tooltip information Roll Influence property of VehicleWheel3D
(cherry picked from commit c979d02db2)
2024-01-24 15:57:59 +01:00
Hugo Locurcio a35a0935fb Improve RichTextLabel `install_effect()` documentation
(cherry picked from commit 78fff7292c)
2024-01-24 15:57:58 +01:00
Michael Macha 6bed401499 Remove pointer to deprecated class page, from Skeleton3D
SkeletonIK3D is now deprecated, but Skeleton3D is recommending looking into its use for complicated inverse kinematics. What's worse, the removed line is not perfectly clear for non-developers and people less experienced with the engine, and could still stand to be improved.

(cherry picked from commit 0e52ffeb69)
2024-01-24 15:57:58 +01:00
ShirenY 045b1d5990 Transform mesh's AABB to skeleton's space when calculate mesh's bounds.
(cherry picked from commit 27f71c4e78)
2024-01-24 15:56:50 +01:00
Frying☆Pan 83d3ccc108
fix documentation for `icon_and_font_color` editor setting
(cherry picked from commit de59872db8)
2023-12-07 10:27:09 +01:00
addmix 1d5f6ed84e
Improve documentation for `CameraAttributesPhysical.exposure_shutter_speed`
(cherry picked from commit b7b0022c7a)
2023-12-07 10:27:07 +01:00
Rémi Verschelde e4aec48bea
VideoPlayer: Fix reloading translation remapped stream
Fixes #43917.

(cherry picked from commit 7d0c561e02)
2023-12-07 10:27:03 +01:00
smix8 fc7cc46b02
Fix missing NavigationLink property updates in constructor
Fixes missing NavigationLink property updates in constructor.

(cherry picked from commit 2f1668804c)
2023-12-07 10:27:02 +01:00
smix8 dfcfc79e3f
Fix missing NavigationRegion property updates in constructor
Fixes missing NavigationRegion property updates in constructor.

(cherry picked from commit 25bf20d7a5)
2023-12-07 10:27:02 +01:00
Hugo Locurcio 54c799f1ca
Improve and clarify texture filtering documentation
- Mention the Use Nearest Mipmap Filter project setting.
- Fix nearest mipmap claiming to always use bilinear filtering
  (it uses trilinear filtering by default, like linear mipmap).

(cherry picked from commit 47cadda3ad)
2023-12-07 10:27:02 +01:00
Pedro J. Estébanez ab01dc5a48 Enhance SceneTree.change_scene*() methods' docs 2023-11-24 11:25:21 +01:00
Markus Sauermann 8ac2e2ac20 Mark `SubViewportContainer::_propagate_input_event` experimental
The function got introduced during 4.2-dev and it was discussed, if it
could be implemented in a way that also allows InputEvent filtering
during `Node._process`. Let's keep this function experimental for the
moment, in case we implement a general solution.
2023-11-14 21:34:46 +01:00
Rémi Verschelde 70ec97aadf
Merge pull request #84844 from Calinou/doc-runtime-loading-image
Link to runtime loading/saving tutorial and improve Image documentation
2023-11-14 12:17:31 +01:00
Hugo Locurcio e5270c0db2
Link to runtime loading/saving tutorial and improve Image documentation 2023-11-14 12:05:54 +01:00
kobewi 4296f0a771 Fill remaining global scope constant descriptions 2023-11-13 15:17:10 +01:00
Rémi Verschelde 5abeb043d0
Merge pull request #84784 from timothyqiu/recturns
Fix typo in `TextureServer.font_get_face_index()` description
2023-11-12 12:16:18 +01:00
Hugo Locurcio a63556212d
Don't apply frame delay project setting to the editor
This appears to already be the case for the Max FPS project setting.
2023-11-12 12:09:39 +01:00
Haoyu Qiu 2717fc6c0f Fix typo in TextureServer.font_get_face_index description 2023-11-12 17:07:09 +08:00
Rémi Verschelde 8179ad558a
Merge pull request #82942 from timothyqiu/circulation
Explain circular references and how to break them
2023-11-11 23:05:11 +01:00
Anutrix 3c82f4a371 Added docs for DRAW_ORDER_REVERSE_LIFETIME constant and minor XR log improvement 2023-11-11 21:17:19 +05:30
Haoyu Qiu b2dcef4928 Explain circular references and how to break them
Also improves the documentation of `weakref`.
2023-11-11 10:07:48 +08:00
Rémi Verschelde 76d9521801
Merge pull request #82863 from HexagonNico/docs_get_tree
Specify the behaviour of `get_tree()` when the node is not in the scene tree
2023-11-10 21:54:56 +01:00
Rémi Verschelde 60e46cfeed
Merge pull request #81697 from nathanjf/master
Add missing documentation for `Skeleton3D` methods
2023-11-10 21:53:14 +01:00
Markus Sauermann 0baebed41a
Document that `Input.is_action_*` should not be used during input-handling
In most cases `InputEvent.is_action*` is more appropriate during input-handling.
2023-11-10 21:34:50 +01:00
Nico ee9c8cb296 Specify the behaviour of get_tree when the node is not in the scene tree 2023-11-10 20:24:53 +01:00
Nathan Frank 13e2e4e5d8 Add missing documentation for Skeleton3D methods
Adds description for get/set pose position/rotation/scale.
2023-11-10 19:07:04 +01:00