Commit Graph

7158 Commits

Author SHA1 Message Date
lawnjelly c0e5879b41 Improve Vector2 / 3 / 4 normalized() classref.
Mention that the results will be unreliable with initial vector near zero.

(cherry picked from commit cca01afd82)
2023-03-16 16:46:18 +01:00
smix8 bea2da94da Allow negative NavigationAgent2D path debug line_width for thin lines
Allows the line_width for NavigationAgent2D path debug to go negativ for thin line rendering.

(cherry picked from commit f6a10c0565)
2023-03-16 16:45:07 +01:00
Haoyu Qiu c6a704af2c Fix typos and inconsistencies in classref
(cherry picked from commit 57d4272984)
2023-03-16 16:43:31 +01:00
Brett Chalupa 1507bea80c Fix CharacterBody2D get_slide_collision docs
The indentation was off and the code usage was incorrect for Godot 4.0 GDScript.

(cherry picked from commit 2b6e1550ff)
2023-03-16 16:39:23 +01:00
David Snopek 1c7bd972e4 Documents the "arc-based" Quaternion constructor
(cherry picked from commit 2d6deb10b0)
2023-03-16 16:38:47 +01:00
pcamp 0cf5de8f19 Fix typo in Window class.
"event as" -> "events will be"

(cherry picked from commit 112977be26)
2023-03-14 13:59:05 +01:00
Hugo Locurcio e79477a4b5 Document using `String.uri_encode()` with `OS.shell_open()`
(cherry picked from commit 81ac3c3e71)
2023-03-14 13:59:04 +01:00
Danil Alexeev f4ea9df0f4 Fix GDScript code style regarding colon
(cherry picked from commit ea5fd3d732)
2023-03-13 14:42:27 +01:00
Isaac Clerencia acdb1bdbd7 Clarify Thread documentation
The current documentation uses the term "running" for two different things.

In the description of get_id() it claims "it will return empty string if the thread is not running", but it actually will return the thread id until wait_to_finish is called.

In the description of is_alive() it claims "it will return true if the thread is running", but in this case it means "the provided function hasn't finished running yet".

Updated the functions documentation slighly to make this clear.

(cherry picked from commit 2a4f38d54f)
2023-03-13 14:41:26 +01:00
BrunoSXS 3aa3fb8771 Fix for AABB methods with wrong description
(cherry picked from commit df0de07494)
2023-03-13 14:38:17 +01:00
kobewi 9997250051 Discourage reusing Tweens
(cherry picked from commit 9785b23a0a)
2023-03-13 14:34:08 +01:00
themancalledjakob e043484d36 improve documentation for Font and FontVariation
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit fb5c2d9f75)
2023-03-13 14:33:24 +01:00
Andreas Raddau a026669cc5 Fixed minor typo in turbulence documentation
(cherry picked from commit c618f9fce2)
2023-03-13 14:30:21 +01:00
JustKoi ed139593bf Fix small mistake in Window.xml
Fix small mistake in Window.xml

(cherry picked from commit 7f8425d6fb)
2023-03-13 14:28:35 +01:00
George Marques b880bde10f Remove outdated note about const in Dictionary and Array docs
(cherry picked from commit d2b1d6e69b)
2023-03-13 14:27:48 +01:00
Haoyu Qiu 80cde341d4 Fix various typos in the classref
(cherry picked from commit 03fcac3aa5)
2023-03-13 14:27:06 +01:00
titus125 8732a8af47 Fixed typos in the Transform2D and Transform3D class reference
(cherry picked from commit 36270d39d2)
2023-03-13 14:26:29 +01:00
Ninni Pipping 8dca093d97 Document `editor/naming/scene_name_casing` setting
Moved definitions of editor related project settings to `editor/register_editor_types.cpp` to make documentation work.

(cherry picked from commit 3de5332fcb)
2023-03-13 14:25:46 +01:00
Nicholas Huelin f55c61d601 Modify the default theme GraphNode close_h_offset
Modifies the close_h_offset to be 12 instead of 22. This better aligns the default position.

(cherry picked from commit 961d6763fb)
2023-03-13 14:06:08 +01:00
Rémi Verschelde 491ded1898
Minor typo and docs URL fixes 2023-02-28 13:38:01 +01:00
Rémi Verschelde 2fcd1885f2
Merge pull request #73890 from jtnicholl/mesh_docs
Update documentation for Mesh and MeshInstance3D
2023-02-27 21:36:22 +01:00
kobewi 24589d7ca3 Improve documentation of EditorExportPlugin 2023-02-27 11:54:01 +01:00
Rémi Verschelde 417ed3da29
Merge pull request #74024 from sarice8/update-tween-doc
Document default values for transition type and ease type.
2023-02-27 10:40:42 +01:00
Rémi Verschelde ec8475af5e
Merge pull request #74028 from voidedWarranties/scriptlanguage_unused
Remove unused `ScriptLanguage` methods
2023-02-27 08:31:01 +01:00
voidedWarranties bd5ab9f9b4 Remove unused `ScriptLanguage` methods 2023-02-26 22:30:56 -08:00
Stephen Rice c4de2d433a Document default values for transition type and ease type. 2023-02-26 21:42:49 -08:00
Bastiaan Olij 12120985c3 Steering on VehicleBody is in radians while interface is in degrees. Improved documentation to clear this up. 2023-02-27 10:56:07 +11:00
Rémi Verschelde 0cd1483132
Merge pull request #73959 from clayjohn/GL-mobile-warnings
Add warnings for unsupported features in mobile and gl_compatibility backends
2023-02-26 21:39:06 +01:00
Rémi Verschelde 93b80f17dc
Merge pull request #73995 from samsface/update-expresion-doc
Clarify when Expression `get_error_text()` is updated
2023-02-26 21:38:42 +01:00
clayjohn c69b14e96e Add warnings for unsupported features in mobile and gl_compatibility backends 2023-02-26 12:28:02 -08:00
Sam 8c6e561fc9
Clarify when Expression `get_error_text()` is updated 2023-02-26 20:48:53 +01:00
Yuri Sizov e5fce139d9 Sync tutorial paths for GI classes with online documentation changes 2023-02-26 17:29:00 +01:00
Hakim 6e86afb487
Document VisualInstance3D offset unit 2023-02-26 14:05:34 +01:00
Jonathan Nicholl 208700ce41 Update documentation for Mesh and MeshInstance3D
Add missing descriptions for Mesh's virtual methods, and
MeshInstance3D's methods relating to blend shapes. Slight tweaks to
several MeshInstance3D method descriptions.
2023-02-24 16:16:06 -05:00
George Marques ed81b165eb
Make max() and min() global functions only accept numbers
The behavior for those are not well defined for non-numeric arguments.
To avoid confusion the other types are forbidden.
2023-02-24 14:06:11 -03:00
Rémi Verschelde 34e6b859e0
Merge pull request #73853 from Calinou/doc-max-clustered-elements
Document the Max Clustered Elements project setting
2023-02-24 14:01:59 +01:00
Rémi Verschelde 0515843f90
Merge pull request #73856 from timothyqiu/classref-fixes
More class reference fixes
2023-02-24 13:31:00 +01:00
Haoyu Qiu 43f62a588b More class reference fixes
Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 10:42:44 +08:00
Hugo Locurcio aea88270d5
Document the Max Clustered Elements project setting 2023-02-24 02:39:44 +01:00
smix8 5d1a6e9b12 Fix ShapeCast3D add and remove exception functions
Fixes that ShapeCast3D would accept any parameter object and silently return when it was not a CollisionObject3D.
2023-02-23 23:45:16 +01:00
bruvzg 4593ad23fd
Add some missing EditorFileDialog methods and properties. 2023-02-22 11:55:08 +02:00
Rémi Verschelde 0a15f51617
Merge pull request #73741 from dalexeev/fix-sprite-frames-convert
Fix `SpriteFrames` data loss on 3-to-4 conversion
2023-02-22 10:13:57 +01:00
Rémi Verschelde 91aed4b9b5
Merge pull request #73694 from m4gr3d/update_touchscreen_editor_settings_main
Enable granular control of touchscreen related settings
2023-02-22 10:12:42 +01:00
Danil Alexeev d49ac0466f
Fix `SpriteFrames` data loss on 3-to-4 conversion 2023-02-22 11:17:10 +03:00
Fredia Huya-Kouadio 445053a62d Enable granular control of touchscreen related settings 2023-02-22 00:16:39 -08:00
Hana f4b2231cd0 update outdated references and examples 2023-02-21 19:28:43 +01:00
Aaron Franke 5ebc0541d2
Fix incorrect Time documentation in get_datetime_dict_from_unix_time 2023-02-21 02:55:44 -06:00
kobewi d76356c4d5 Clarify rotation degrees 2023-02-20 23:26:02 +01:00
bruvzg b3c64675cc
[macOS] Replace all `Alt/Option+Letter/Number` default shortcuts to avoid conflicts with special character input. 2023-02-20 22:02:47 +02:00
Rémi Verschelde e10ab0c8c3
Merge pull request #73610 from timothyqiu/classref-typos
Various classref typo fixes
2023-02-20 11:29:01 +01:00
Rémi Verschelde dcad6fbf9c
Merge pull request #73408 from nightblade9/patch-1
Elaborate text-to-speech requirements on Linux
2023-02-20 11:28:29 +01:00
Haoyu Qiu 0c92c92891 Various classref typo fixes 2023-02-20 14:47:37 +08:00
nightblade9 8e9b923425 Elaborate on text-to-speech requirements on Linux 2023-02-19 17:07:07 -05:00
nobbele d6c4e40feb
Clarify return value for InputEvent.is_echo() 2023-02-19 00:28:46 +01:00
Yuri Sizov b0200c1c46
Merge pull request #73535 from clayjohn/docs-keep-scale 2023-02-18 12:33:24 +03:00
clayjohn 8314cf125a Correct docs for keep_scale in BaseMaterial3D 2023-02-17 15:27:29 -08:00
Yuri Sizov b2f63bbb43 Remove deprecated methods from Bone2D
- also add them to the project convertor
2023-02-17 18:05:52 +01:00
Yuri Sizov e57aeb49e9
Merge pull request #73507 from YuriSizov/docs-are-neat
Remove extra spaces and correct crosslinks in some documentation
2023-02-17 20:04:58 +03:00
Yuri Sizov dd5acde285 Remove extra spaces and correct crosslinks in some documentation 2023-02-17 17:31:19 +01:00
randompast d2b5da16f9 Improve BoxMesh documentation about UV scaling for vertex shader
Added comment that translates the UV scaling from the standard shader properties
to how that's being done in the godot vertex shader.
2023-02-17 17:10:57 +01:00
Rémi Verschelde 7c7ba88d19
Merge pull request #66121 from Zylann/plugin_handles_edit_object_argument
Change `_can_handle` and `_edit` virtual methods to take `Object*`
2023-02-17 15:19:12 +01:00
Yuri Sizov a93d7af90f
Merge pull request #73456 from Calinou/doc-popupmenu-displayserver-accelerators
Improve documentation on PopupMenu and DisplayServer accelerators
2023-02-17 16:15:11 +03:00
Marc Gilleron d2b4e30058
Change `_can_handle` and `_edit` virtual methods to take `Object*` 2023-02-17 14:10:38 +01:00
Rémi Verschelde 1075931c64
Remove unexposed ProxyTexture, mark AnimatedTexture as deprecated
According to reduz:

> [AnimatedTexture] should be removed together with ProxyTexture, its just
> not efficient at all in Vulkan and causes invalidation of all descriptor
> sets depending on it
> it was needed mostly for animated tilemaps, but nowadays there is not a lot
> of reason for it

Marking AnimatedTexture as deprecated accordingly, until we reach consensus
for removing it completely.
2023-02-17 12:32:26 +01:00
Rémi Verschelde db9007aef4
Merge pull request #73428 from smix8/navigation_tweak_agent3d_4.x
Tweak NavigationAgent3D defaults
2023-02-17 09:56:49 +01:00
Rémi Verschelde b2584629c8
Merge pull request #73195 from timothyqiu/weblate-comments
Improvements and fixes based on Weblate comments
2023-02-17 09:55:39 +01:00
Tecelli Akıntuğ 1ba05b4b3a
Fix AnimatedTexture inconsistency when setting frame 2023-02-16 22:34:10 +01:00
Yuri Sizov 15a97a2e84
Merge pull request #56490 from Calinou/light-3d-high-attenuation-warning
Document caveats of high attenuation in OmniLight3D and SpotLight3D
2023-02-16 23:41:08 +03:00
Hugo Locurcio c3365ace4f
Improve documentation on PopupMenu and DisplayServer accelerators
The name "accelerator" is actually misleading (at least in PopupMenu),
as these are really keyboard shortcuts and not a key you press after
pressing Alt (with the corresponding letter in the option's name
being underlined after pressing Alt).
2023-02-16 20:26:07 +01:00
Rémi Verschelde ec2f9a78f7
Merge pull request #73435 from bruvzg/file_close
Restore FileAccess.close method.
2023-02-16 18:34:48 +01:00
Rémi Verschelde 2d845ee3d1
Merge pull request #73437 from bruvzg/docs_ignore_import_v
Exclude platform dependent `rendering/textures/vram_compression/import_*` default values from documentation.
2023-02-16 18:34:44 +01:00
Rémi Verschelde 25da47edd6
Merge pull request #73396 from KoBeWi/sorry
Fix crash with AspectRatioContainer and TextureRect
2023-02-16 18:34:41 +01:00
Rémi Verschelde 6b7c0a1f2a
Merge pull request #73250 from smix8/fix_navigation_debug_script_toggle_4.x
Fix navigation debug not toggleable in scripts
2023-02-16 18:32:39 +01:00
bruvzg 041f559da1
Exclude platform dependent `rendering/textures/vram_compression/import_*` default values from documentation. 2023-02-16 15:48:09 +02:00
kobewi a12921ca2c Fix crash with AspectRatioContainer and TextureRect 2023-02-16 14:35:09 +01:00
bruvzg bc95b0b171
Restore FileAccess.close method. 2023-02-16 15:34:20 +02:00
smix8 8be4af38e4 Tweak NavigationAgent3D defaults
Tweaks default values for NavigationAgent3D to work better out of the box within a new 3D project.
2023-02-16 14:26:39 +01:00
smix8 aecad7bb25 Fix navigation debug not toggleable in scripts
Fixes that navigation debug was not toggleable in script while even the docs mentioned it.
2023-02-16 11:12:48 +01:00
Rémi Verschelde 953383328a
Merge pull request #73229 from smix8/navlink_global_positions_4.x
Add NavigationLink helper functions for global positions
2023-02-16 11:02:17 +01:00
Rémi Verschelde d844fbba3b
Merge pull request #73409 from voidedWarranties/scriptextension_add_bind
Add missing virtual bind for `ScriptExtension::_get_global_name`
2023-02-16 11:02:09 +01:00
Rémi Verschelde ddb1876cf7
Merge pull request #73412 from timothyqiu/doc-fixes
Fix a few typos in the class reference
2023-02-16 11:02:04 +01:00
Rémi Verschelde 43c9ac82bb
Merge pull request #69201 from tbveralrud/ios-touch-leak-fix-master
iOS: Fix memory leak on touch input
2023-02-16 11:01:58 +01:00
Haoyu Qiu 431a0f20a4 Fix a few typos in the class reference 2023-02-16 13:26:17 +08:00
voidedWarranties 0a58025e40 Add missing virtual bind for `ScriptExtension::_get_global_name` 2023-02-15 19:48:01 -08:00
Yuri Sizov d2b1474da7
Merge pull request #73293 from RedMser/rich-text-label-fixes
RichTextLabel: Unexpose internal ItemType enum, improve `push_meta` docs
2023-02-15 12:58:23 +03:00
Travis Veralrud 10be2c343f
iOS: Fix memory leak on touch input
Replace incomplete iOS gesture with touch implementation.

Fixes #66422.
2023-02-15 09:45:38 +01:00
smix8 d87f124768 Add NavigationLink helper functions for global positions
Adds helper functions to set the links start and end position with global positions or get them as global positions.

Adds global start and end position for the navigation link to the 'link_reached' signal of NavigationAgent. That signal gets emitted when a navigation link waypoint is reached. Requires that 'owner' meta data is enabled on the NavigationAgent.
2023-02-14 21:56:58 +01:00
smix8 f1026450bf Unbind NavigationServer3D.process()
Unbinds NavigationServer3D.process().
2023-02-14 21:21:36 +01:00
RedMser 22dd621cf9 RichTextLabel fixes
- Unexpose ItemType enum, since it is not used in public API.
- Fix documentation for meta tag, since it has no BBCode equivalent.
2023-02-14 17:20:05 +01:00
Rémi Verschelde 93d1cfe525
Merge pull request #73253 from Mickeon/doc-stringname-oops
Add missing documentation for String & StringName
2023-02-14 15:57:47 +01:00
Rémi Verschelde f9b043aad7
Merge pull request #73281 from Mickeon/doc-misc-oops
Slightly tweak `@GlobalScope` & `GDScript`'s documentation
2023-02-14 13:37:43 +01:00
Micky 436bbfebe2 Tweak `@GlobalScope` & `GDScript`'s documentation 2023-02-14 13:26:18 +01:00
Micky 8d0078873a Fix incorrect format in Color documentation 2023-02-14 10:27:43 +01:00
Micky edb78840c0 Add missing documentation for String & StringName
Also fixes typos brought up in #69821's replies.
2023-02-14 10:15:44 +01:00
Rémi Verschelde 4848877b80
Merge pull request #72659 from Calinou/doc-rendering-method-support
Document unsupported features in Mobile and Compatibility rendering methods
2023-02-13 23:45:12 +01:00
Rémi Verschelde 9721d557d0
Merge pull request #73248 from constantitus/characterbody2d-csharp-doc
fixed c# example in CharacterBody2D doc
2023-02-13 23:44:48 +01:00
Hugo Locurcio 42b7739321
Document unsupported features in Mobile and Compatibility rendering methods 2023-02-13 22:17:02 +01:00
constantitus 6951574265 fixed c# example in CharacterBody2D doc 2023-02-13 23:14:48 +02:00
Hugo Locurcio 8b1de103a8
Clamp Decal size to positive values
This prevents using negative size, while also preventing
error messages from being spammed if one of the decal's dimensions
is set to exactly 0.
2023-02-13 22:01:49 +01:00
Rémi Verschelde c2e1be66c8
Merge pull request #72870 from Calinou/doc-directionallight2d-no-cull-mask
Document DirectionalLight2D not supporting cull masks
2023-02-13 21:06:33 +01:00