Commit Graph

7926 Commits

Author SHA1 Message Date
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