godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
53,157 Commits 15 Branches 59 Tags 2.2 GiB
Commit Graph

7991 Commits

Author SHA1 Message Date
Hugo Locurcio 2d7228251d
Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentation 
This brings the overall class reference completion percentage from 87% to 92%.

(cherry picked from commit 5056c427d3)
 2023-05-12 12:31:19 +02:00
Ninni Pipping 9a5af8e793
Clarify that event handling does not affect `Input` 
(cherry picked from commit 732ad382a6)
 2023-05-12 12:14:45 +02:00
Michael Alexsander b7206e25bf
Improve some descriptions in the OS docs 
(cherry picked from commit 6db12c5e50)
 2023-05-12 12:11:23 +02:00
Aaron Franke f49c69a1e7
Fix small mistake in docs, "antecedents" -> "ancestors" 
(cherry picked from commit 740b0713a2)
 2023-05-12 12:07:02 +02:00
VolTer 78c190f4f5
Add an example for how to use AudioStreamGenerator 
(cherry picked from commit 9d77caaf95)
 2023-05-12 12:07:02 +02:00
VolTer e530168fb8
Document TextServerDummy 
(cherry picked from commit c8e06fe838)
 2023-05-12 12:07:02 +02:00
UltraBIF 4b63ce83d2
Fixed various typos across the docs 
(cherry picked from commit 8106d33d0f)
 2023-05-12 12:07:02 +02:00
Bastiaan Olij a5cb7a5eb5
Expose viewports render targer RID 
(cherry picked from commit ab60d3b65c)
 2023-05-12 12:07:01 +02:00
kobewi 0277f57b6f
Some clarifications on screen-space coordinates 
(cherry picked from commit 33b9be27d3)
 2023-05-12 12:07:01 +02:00
Pedro J. Estébanez 908325c29e
Fix unsupported sampler filter used for voxel GI 
(cherry picked from commit 09aa1bbdb3)
 2023-04-27 08:43:30 +02:00
Devin 1b74572377
Updated GDScript example to use clear_surfaces() and C Sharp example to use ClearSurfaces() instead of non-existent surface_remove() and SurfaceRemove() 
(cherry picked from commit 3b615ed789)
 2023-04-27 08:41:23 +02:00
VolTer 7f09c3d2fc Provide an example on how to use ImmediateMesh 
(cherry picked from commit 4eabad6c26)
 2023-04-26 14:51:01 +02:00
Winston b9e75e50dc Document automatic center mode using shape origins 
(cherry picked from commit 7b30d7da51)
 2023-04-26 14:51:01 +02:00
Ninni Pipping 08ec4a82bd Add information about how `Engine.time_scale` affects Timers 
(cherry picked from commit 16a1465380)
 2023-04-26 14:51:00 +02:00
VolTer 7b59361637 Document why Gradient.reverse() doesn't reverse constant gradients 
(cherry picked from commit f21d13600e)
 2023-04-26 14:50:59 +02:00
Yuri Sizov 289d551fbb Create an "Editor-only" section in the online class reference 
This helps to find such classes without digging
through the rest of the class reference.
Editor-only classes can still be found under
your normal "Node" and "Resource" types.

This also fixes a typo and a missed case from the recent platform docs PR.

(cherry picked from commit 3ae282b452)
 2023-04-26 14:47:56 +02:00
Hugo Locurcio f5721ca61a Document custom mouse cursors larger than 128×128 potentially having issues 
(cherry picked from commit 92730fb07d)
 2023-04-26 14:29:27 +02:00
Hugo Locurcio 39c0392a64 Document using AnimatableBody when needed in StaticBody description 
(cherry picked from commit 68117d2fc7)
 2023-04-26 14:14:05 +02:00
Haoyu Qiu 2eb29d0684 Fix various typos in the classref 
(cherry picked from commit 766807506c)
 2023-04-24 17:08:56 +02:00
Paweł 32dc3b66ab Remove double thes from documentation 
(cherry picked from commit 4431cdd154)
 2023-04-24 17:08:56 +02:00
David Giardi 75f3ce618e Fix blurry borders on antialiased FlatStyleBox 
This is a fix of the antialiasing logic of FlatStyleBox.
It is now possible to have smooth rounded corners while keeping
the edges sharp on the pixels.

The antialiasing gradient positioning is ajusted so that the "hard"
border corresponds to the middle of that gradient instead of one end.
Checked against rendering of rounded rectangles in a vector graphics
software.

(cherry picked from commit 2ef20045b1)
 2023-04-24 17:08:55 +02:00
Ninni Pipping 13f368067f Improve description of `Callable.bind/unbind` 
(cherry picked from commit 0332fd5e8f)
 2023-04-24 17:03:58 +02:00
VolTer 10d8a67267 Fix Quaternion's brief description 
(cherry picked from commit 5c0e3b26a6)
 2023-04-24 17:03:57 +02:00
Hugo Locurcio 83c3963235 Improve `print_rich()` documentation 
- List all supported colors.
- Mention URL tag support limitations.
- Fix and tweak code example to do what it says.
- Remove outdated notice about lack of Windows support (but mention
  that only Windows 10 and later support ANSI code conversion).

(cherry picked from commit ec277d804e)
 2023-04-24 17:03:57 +02:00
Evgeniy Vasilyev d46cb8e65c Fixed typo in DisplayServer.ScreenOrientation docs 
(cherry picked from commit 5ba98e59f0)
 2023-04-24 17:03:56 +02:00
Haoyu Qiu c6297f46fe Unify descriptions of vector methods 
* is_equal_approx
* normalize
* length_squared
* posmod
* posmodv

(cherry picked from commit 6cd8e706fa)
 2023-04-24 17:03:56 +02:00
Rattle22 12da78cf30 Fix Typo in NavigationServer2D 
(cherry picked from commit 5c387cbdb3)
 2023-04-24 17:03:55 +02:00
Tae Hong Ahn a27b427b1f update set_smooth_group description 
fixes https://github.com/godotengine/godot/issues/74452

(cherry picked from commit 5a775ac08c)
 2023-04-24 17:03:55 +02:00
Ninni Pipping 3fcaffc96b Fix `Image.compress` description 
Description mentioned `mode` instead of `source`

(cherry picked from commit 6312fe2fae)
 2023-04-24 16:52:25 +02:00
Ninni Pipping 3445fa7dbc Expose more compression formats in Image and fix compress check 
Check for compressing ASTC checked if the function for BPTC was present

(cherry picked from commit cf64e2fa47)
 2023-04-24 16:28:30 +02:00
bruvzg e071fb2263 [TextServer] Use dedicated flag for object replacement characters. 
(cherry picked from commit d904516e55)
 2023-04-24 16:28:28 +02:00
Mallardbro e801fe83d1 Correct the side mentioned with focus_neighbor_right and focus_neighbor_top. 
A small typo with the definitions of `focus_neighbor_right` and `focus_neighbor_top`. Both use "bottom" rather than the correct side for each.

(cherry picked from commit c25d015d06)
 2023-04-24 16:28:25 +02:00
mara a6e15e2f15 Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in remaining docs 
The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in
the documentation in some places. Replace it with the new name
`to_utf8_buffer`. Same for ascii. Same for C#.

(cherry picked from commit 57dca93718)
 2023-04-24 14:16:36 +02:00
Ninni Pipping 9902d07966 Document how to make custom min/max for Array 
(cherry picked from commit 96ab31a711)
 2023-04-24 14:04:20 +02:00
Dimitri A ce7fd66896 docs/FileDialog: Use clickable references 
This replaces two [code][/code] blocks with clickable refs to [enum Access] and [member file_mode] respectively.

(cherry picked from commit a5778da55b)
 2023-04-24 14:04:20 +02:00
Rémi Verschelde 90b4ca2e50
i18n: Sync translations with Weblate 2023-04-20 13:26:36 +02:00
Hugo Locurcio 66a8ddf61c Fix CompressedTextureLayered description in the class reference 
This also updates the list of compression modes available for textures.

(cherry picked from commit 0d24016db0)
 2023-04-07 17:44:40 +02:00
smix8 cc6ce6977d Expose NavigationAgent path postprocessing and pathfinding algorithm options 
Exposes the path postprocessing and pathfinding algorithm options of the NavigationAgent internal NavigationPathQueryParameters object.

(cherry picked from commit 6e324bb341)
 2023-04-07 17:44:37 +02:00
kleonc a5572ba5a3 C# Truncate instead of round in Vector2/3/4 to Vector2I/3I/4I conversion 
(cherry picked from commit f53d3382af)
 2023-04-07 17:44:36 +02:00
Rémi Verschelde 9099ac39cf
i18n: Sync translations with Weblate 2023-04-04 00:33:24 +02:00
kobewi ed1eb1e18f Update UndoRedo description 
(cherry picked from commit 3a06e6af76)
 2023-04-03 18:41:05 +02:00
kobewi 1c66b24325 Fill random docs 
(cherry picked from commit eac65fd0a8)
 2023-04-03 18:40:24 +02:00
kleonc 103d23539f Improve CanvasItem.self_modulate docs 
(cherry picked from commit 4fb9aa2294)
 2023-04-03 18:39:37 +02:00
skyace65 c114a7bab4 Remove reference to clipboard in OS class doc 
(cherry picked from commit a65d99b541)
 2023-04-03 18:38:27 +02:00
kobewi 87929d9ab0 Add _get_configuration_warnings() example 
(cherry picked from commit c4e08a4e1a)
 2023-04-03 18:37:09 +02:00
Chris Hutchinson 4323c8b78b Replaced operating system alert dialog with a warning log message, 
toggled by a project setting.
Fixes #73141

(cherry picked from commit cb8e919243)
 2023-03-30 19:28:57 +02:00
Ninni Pipping 1e94881484 Exposing more project settings for documentation 
(cherry picked from commit bd30847e59)
 2023-03-30 19:26:05 +02:00
Haoyu Qiu ae0a98ef9b Hide internal settings from the classref 
Default actions are no longer internal since we want to document them.
They are still hidden from the Project Setting dialog because we hid the
whole `input/` group manually.

(cherry picked from commit 1e0b8d6240)
 2023-03-30 19:23:04 +02:00
fabriceci bafc6372b2 Exposes the apply_floor_snap function to allow a snap to be made regardless of velocity. 
(cherry picked from commit 1381e6da4f)
 2023-03-30 19:10:45 +02:00
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
Rémi Verschelde d23922ffeb
i18n: Sync translations with Weblate 2023-03-15 02:29:27 +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
kobewi 4bd16e6493 Safeguard Makefile commands 
(cherry picked from commit d29030fdd0)
 2023-03-13 14:29:23 +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 2f34a35722
i18n: Sync translations with Weblate 2023-03-01 00:11:39 +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