1
0
Fork 0
Commit Graph

8440 Commits

Author SHA1 Message Date
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
Yuri Sizov d9c980f1cf Fix a property reference in EditorSpinSlider 2023-11-10 15:30:16 +01:00
Rémi Verschelde 7f49389c4b
Merge pull request #84698 from RandomShaper/fix_doccy
Fix link in the docs about ResourceImporterTextureAtlas
2023-11-10 10:46:30 +01:00
Rémi Verschelde 4eae6f8028
Merge pull request #84669 from akien-mga/doc-displayserver-dont-mess-with-windows
doc: Clarify that `DisplayServer.window_set_*_callback` aren't supported on Window nodes
2023-11-10 10:46:06 +01:00
Rémi Verschelde 804c1926c9
Merge pull request #84648 from NiftyHat/patch-1
Add C# example for the AudioStreamGenerator code snippet
2023-11-10 10:45:20 +01:00
Rémi Verschelde dfe2df989d
Merge pull request #84493 from bruvzg/gde_ios_static_fix
[iOS, GDExtension] Fix loading and exporting static libraries and xcframeworks.
2023-11-10 10:44:56 +01:00
Pedro J. Estébanez 29a4707fa5 Fix link in the docs about ResourceImporterTextureAtlas 2023-11-10 09:51:11 +01:00
Duncan "NiftyHat" Saunders 496eaafe49
Add C# example for the AudioStreamGenerator code snippet 2023-11-10 09:28:35 +01:00
bruvzg 173b84127b
[Windows] Add some AMD GPUs to the OpenGL blocklist. 2023-11-09 20:11:04 +02:00
bruvzg d4d5d68eda
[iOS, GDExtension] Fix loading and exporting static libraries and xcframeworks. 2023-11-09 20:04:40 +02:00
Rémi Verschelde 02e52da774
Merge pull request #84667 from timothyqiu/semi-redundant
Remove a redundant semicolon from `max_fps` documentation
2023-11-09 18:10:11 +01:00
Rémi Verschelde d36cc7313e
Merge pull request #84547 from kitbdev/mouse-notif-3
Make Mouse Enter/Exit notifications match Mouse Events
2023-11-09 18:08:37 +01:00
Rémi Verschelde 25e650ab61
Merge pull request #83388 from jsjtxietian/document-resource-saver-uid
Document UID behavior in ResourceSaver's save function
2023-11-09 18:07:41 +01:00
Rémi Verschelde 9ff5ee79b8
Merge pull request #82991 from jsjtxietian/update-doc-for-draw-poly-line
Update `draw_polyline` documentation to clarify negative width behavior
2023-11-09 18:07:16 +01:00
Rémi Verschelde 95a42aeb96
Merge pull request #82092 from jitspoe/master.pr_physical_keycode_doc_fix
Fix documentation on how to get the keycode string from a `physical_keycode`
2023-11-09 18:06:51 +01:00
kobewi aff49d3a76 Fix missing arrows in integer vector properties 2023-11-09 17:35:15 +01:00
Rémi Verschelde 354c622aa7
doc: Clarify that `DisplayServer.window_set_*_callback` aren't supported on Window nodes 2023-11-09 17:23:38 +01:00
Haoyu Qiu d6bd0e1289 Remove a redundant semicolon from max_fps documentation 2023-11-09 22:18:01 +08:00
kit d24d73ba31 Make mouse-enter/exit notifications match mouse event propagation
`NOTIFICATION_MOUSE_ENTER` and `NOTIFICATION_MOUSE_EXIT` now includes
the areas of children control nodes if the mouse filters allow it.

In order to check if a Control node itself was entered/exited, the newly
introduced `NOTIFICATION_MOUSE_ENTER_SELF` and
`NOTIFICATION_MOUSE_EXIT_SELF` can be used.

Co-authored-by: Markus Sauermann <6299227+Sauermann@users.noreply.github.com>
2023-11-09 09:11:59 -05:00
jitspoe 1e01fcd038
Fix documentation on how to get the keycode string from a `physical_keycode`
Fixes #82091.

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2023-11-09 13:03:29 +01:00
Rémi Verschelde 26f1c503ec
Merge pull request #84617 from YuriSizov/editor-this-one-is-for-all-my-subs
Fix node names of submenu items across the editor
2023-11-09 11:47:24 +01:00
Rémi Verschelde b153f4868a
Merge pull request #84567 from timothyqiu/shapecast-doc
Sync changes between ShapeCast and RayCast class references
2023-11-09 11:47:00 +01:00
Rémi Verschelde aaafc69132
Merge pull request #84513 from bruvzg/x11_fallback_and_spam
[X11] Add fallback from desktop GL to GLES, suppress PRIME detector error spam.
2023-11-09 11:46:36 +01:00
Yuri Sizov b04b546092 Fix node names of submenu items across the editor
Also removes some programmer remarks and fixes some docs.
2023-11-08 14:42:42 +01:00
clayjohn a74cfc2629 Use default samplers in base uniform set when rendering to reflection probes 2023-11-07 17:46:05 +01:00
Yuri Sizov 326899226f Merge pull request #84408 from m4gr3d/update_input_event_magnify_gesture_android_description
Update the description for the `InputEventMagnifyGesture` and `InputEventPanGesture` gestures
2023-11-07 12:54:17 +01:00
Haoyu Qiu aca6855ef2 Sync changes between ShapeCast and RayCast class references 2023-11-07 16:49:51 +08:00
Fredia Huya-Kouadio b737ac1e1d Update the description for the `InputEventMagnifyGesture` and `InputEventPanGesture` gestures
Mention the requirement to enable those gestures on Android
2023-11-06 11:02:39 -08:00
Yuri Sizov d3e9033868 Merge pull request #83931 from clayjohn/DOCS-material
Fill out Material documentation and clarify `render_priority` and `next_pass` sorting
2023-11-06 15:43:25 +01:00
Yuri Sizov b7449a3d1a Merge pull request #84419 from YuriSizov/core-remove-orphan-notification
Remove unused `NOTIFICATION_NODE_RECACHE_REQUESTED` notification
2023-11-06 13:23:21 +01:00
Yuri Sizov e5f1cbfe2a Merge pull request #84376 from YuriSizov/animation-unexpose-internal-property
Unexpose internal data property of `AnimationLibrary`
2023-11-06 13:23:15 +01:00
Yuri Sizov 623b905d2e Remove unused `NOTIFICATION_NODE_RECACHE_REQUESTED` notification 2023-11-06 12:16:32 +01:00
bruvzg f3d4f5a77e
[X11] Add fallback from desktop GL to GLES, suppress PRIME detector error spam. 2023-11-06 12:40:44 +02:00
Yuri Sizov e7c3a0540a Merge pull request #83435 from trevyn/get_skips
Document `AudioStreamGeneratorPlayback.get_skips()`
2023-11-03 12:52:12 +01:00
trevyn 7c2e37e5dd Document `AudioStreamGeneratorPlayback.get_skips()`
Co-Authored-By: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2023-11-02 21:54:07 +02:00
Yuri Sizov 0b2f8ee036 Merge pull request #84283 from jsjtxietian/update-add_submenu-doc
Update `add_submenu_item` doc to mention that submenu should already exist
2023-11-02 20:34:11 +01:00
Yuri Sizov f2de1137d9 Unexpose internal data property of `AnimationLibrary` 2023-11-02 18:57:39 +01:00
jsjtxietian 34c27021e0 Update `add_submenu` doc to mention that submenu should already exist 2023-11-02 11:02:13 +08:00
curious-broccoli 385f4cb572
Fix sentence in RandomNumberGenerator.xml 2023-11-01 21:37:01 +01:00
Rémi Verschelde 1267c58422
Merge pull request #84301 from jsjtxietian/improve-get_time_zone_from_system-doc
Clarify that `get_time_zone_from_system` will return a localized timezone name
2023-11-01 15:12:54 +01:00
Rémi Verschelde 1ea46ad4c3
Merge pull request #84276 from Chubercik/velocity_pivot_desc
Add a description for the `velocity_pivot` parameter
2023-11-01 15:10:56 +01:00
Rémi Verschelde 8ce31989ff
Merge pull request #84226 from Agaanii/patch-1
Fix documentation in MultiplayerAPIExtension
2023-11-01 15:10:33 +01:00
jsjtxietian fd751f9b21 Clarify get_time_zone_from_system will return a localized timezone name 2023-11-01 19:47:30 +08:00
Boris The Brave a390996a61
Document that `resource_name` is not always supported
Closes #82333.

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2023-11-01 10:43:41 +01:00
Jakub Marcowski 201e5bab35
Add a description for the `velocity_pivot` parameter 2023-11-01 03:15:05 +01:00
Matt Loesby c10921b5d1 Fix documentation in MultiplayerAPIExtension
Fix documentation in MultiplayerAPIExtension.xml

In implementing a MultiplayerAPIExtension, I found that the example from documentation did not function even in the Multiplayer tutorial example.

Eventually, I found that the issue was that base_multiplayer will not poll unless told to by the LogMultiplayer implementation.

I also corrected a spelling issue and a few out-of-date return types.
2023-10-31 18:39:45 -06:00
Rémi Verschelde 799d30c306
Merge pull request #83753 from bruvzg/mac_angle_fb
[macOS] Fallback to native OpenGL renderer if ANGLE initialization failed.
2023-10-31 20:14:42 +01:00
Rémi Verschelde c942297410
Merge pull request #84224 from ershn/patch-1
Add missing word in `NOTIFICATION_POST_ENTER_TREE` documentation
2023-10-31 13:47:25 +01:00
Rémi Verschelde cf16c69e7d
Merge pull request #82609 from jsjtxietian/document-localized-timezone-name
Document `get_time_zone_from_system` will return a localized timezone name
2023-10-31 13:46:14 +01:00
Rémi Verschelde a4efb5a974
Merge pull request #81622 from Calinou/doc-dictionary-merge
Add an example for `Dictionary.merge()`, mention lack of recursion
2023-10-31 13:45:47 +01:00
Hugo Locurcio 0396e12a47
Add an example for `Dictionary.merge()`, mention lack of recursion 2023-10-31 10:16:11 +01:00
jsjtxietian 5eeb1518a8 Document get_time_zone_from_system will return a localized timezone name 2023-10-31 12:29:10 +08:00
Steven Le Boëdec 47258411da
Add missing word in `NOTIFICATION_POST_ENTER_TREE` documentation 2023-10-31 09:07:00 +09:00
Rémi Verschelde 17a575625e
Merge pull request #84159 from clayjohn/uv-compression
Fix multiple issues with UV compression
2023-10-30 23:19:45 +01:00
Rémi Verschelde 608226a097
Merge pull request #82801 from allenwp/82587-untyped-declaration-usability
Add a recommendation to turn on type hints with untyped declaration warning
2023-10-30 23:18:10 +01:00
Rémi Verschelde be8761a801
Merge pull request #81176 from Jordyfel/integer-scaling-docs
Document integer scaling functionality and limitation
2023-10-30 23:17:21 +01:00
Rémi Verschelde fa54bc3eca
Merge pull request #79571 from Calinou/doc-richtextlabel-padding
Clarify the purpose of RichTextLabel text highlight padding
2023-10-30 23:16:24 +01:00
clayjohn 3f5c16dd9e Fix multiple issues with UV compression 2023-10-30 23:11:34 +01:00
Allen Pestaluky ede91c9f89 Added recommendation to turn on Add Type Hints with Untyped Declaration warning
Fixes #82587 by improving usability of the untyped_declaration warning. This adds a note to the documentation that recommends turning on EditorSettings.text_editor/completion/add_type_hints when the untyped declaration warning is set to warn or error.

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2023-10-30 15:46:57 -04:00
Rémi Verschelde acbc341a58
OpenGL: Fix uninitialized memory usage for GPUPartciles `interp_to_end`
Fixes #84072.
2023-10-30 15:08:24 +01:00
Rémi Verschelde 6fe7a5e8d7
Merge pull request #84111 from EgeYildir/patch-1
doc: Fix typo in ConcavePolygonShape2D/3D description
2023-10-30 10:19:20 +01:00