Commit Graph

7121 Commits

Author SHA1 Message Date
VolTer 843f5adbc5 Improve documentation of int
(cherry picked from commit 0f3197501e)
2023-03-27 18:06:47 +02:00
Haoyu Qiu 4750b77d2d Fix typos and inconsistencies in classref
* Typo fixes.
* Navigation agent's `velocity_computed` signal is not emitted by
  `set_velocity`, but at the end of that frame if `set_velocity` is
  called.
* Simplify link in navigation agent's `avoidance_enabled` description.
* Unify `navigation_layers` description across `NavigationAgent{2,3}D`.
* Unify `is_normalized()` description across `Vector2`, `Vector3`, and
  `Vector4`

(cherry picked from commit ff97c481d3)
2023-03-27 18:02:28 +02:00
Ninni Pipping 7de181f524 Fix `NodePath` subname index range documentation
(cherry picked from commit c75870f798)
2023-03-27 17:59:43 +02:00
Hugo Locurcio b85cead4b9 Document how to use logarithm of base 10 with `log()`
(cherry picked from commit 3c4f0ca9c6)
2023-03-27 17:57:14 +02:00
Ricardo Buring 58d8368481 Fix collide_shape return type
Fix PhysicsDirectSpaceState3D::_collide_shape return type.
Also PhysicsDirectSpaceState2D::_collide_shape.

(cherry picked from commit 61429a5f49)
2023-03-27 17:50:35 +02:00
Ninni Pipping 9a4a0d042c Improve documentation for Area monitor callbacks in `PhysicsServer3D`
(cherry picked from commit 4124271241)
2023-03-27 17:49:05 +02:00
Rindbee ce4ab71957 Fix some wrong descriptions in the docs
(cherry picked from commit f29a7c0404)
2023-03-27 17:44:02 +02:00
Mikael Hermansson 465be40e10 Change documentation of `Shape3D.margin` to reflect current situation
(cherry picked from commit 33a6c80abb)
2023-03-27 17:34:59 +02:00
Dipal Zambare 47c3f44c0a Fix typo in the type-safe examples
Fix type in the type-safe examples of snapped, lerp and sign function.

(cherry picked from commit 8901986d56)
2023-03-27 17:33:49 +02:00
Ricardo Buring 68e6234595 Fix concave/convex polygon shape documentation
Removes some outdated/incorrect/duplicated info, adds correct info.
Also removes no longer applicable "editor-only helper" statements.

(cherry picked from commit e61a127042)
2023-03-27 17:10:03 +02:00
Bastiaan Olij a94a2062af Add XRServer.world_origin property
(cherry picked from commit fd8f26f26e)
2023-03-27 16:56:22 +02:00
bruvzg db3fadc560 Improve layout direction/locale automatic selection.
(cherry picked from commit 82d7923c65)
2023-03-27 16:36:53 +02:00
bruvzg 24c4b5e8ad [macOS] Re-add support for the _sc_ inside app bundle. Update docs.
(cherry picked from commit 174e0837e0)
2023-03-27 16:34:57 +02:00
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