Commit graph

3553 commits

Author SHA1 Message Date
Rémi Verschelde
8f17a4037b
Merge pull request #56466 from Chaosus/vs_uniform_hints_3.x 2022-01-06 09:39:27 +01:00
Wilson E. Alvarez
4106f95f30
Expose autotile_coord parameter in TileMap.set_cellv 2022-01-05 21:24:35 -05:00
kobewi
2dc30888bf
Fix get_v_scroll() desctiption in ItemList
(cherry picked from commit f97ab4a0e4)
2022-01-06 00:28:05 +01:00
Lertsenem
942f15fa4e
Fix error in Vector2.reflect() description
The description was probably copied from Vector3.reflect(), and
unfortunately did not match the 2D behaviour (where n is apparently the
direction vector of the symmetry line, not the normal).

(cherry picked from commit e1bf428cdc)
2022-01-06 00:23:59 +01:00
Hugo Locurcio
8d3e16676d
Document keyboard ghosting caveats in Input and InputEvent
This also adds recommendations for choosing between
`is_physical_key_pressed()` and `is_key_pressed()`.

(cherry picked from commit d01e22f187)
2022-01-06 00:21:37 +01:00
skyace65
098a8dab0d
Add warning to only use convex hull points when setting the point property for convex polygon shape
(cherry picked from commit 6b18614de7)
2022-01-06 00:21:36 +01:00
skyace65
ea637f641e
State that get static memory usage only works in debug
(cherry picked from commit 32b4edbe4e)
2022-01-06 00:21:36 +01:00
skyace65
97695d3796
Improve mouse input event class reference
(cherry picked from commit 37dfe5c706)
2022-01-06 00:21:36 +01:00
Rémi Verschelde
91c5a336e8
Merge pull request #55718 from bruvzg/oversampling_override 2022-01-06 00:07:48 +01:00
Jake Young
09bc9eb101
Backport NavigationServer with RVO2 to 3.x
Change the entire navigation system.
Remove editor prefix from nav mesh generator class. It is now used for baking
at runtime as well.
Navigation supports obstacle avoidance now with the RVO2 library.
Nav system will also automatically link all nav meshes together to form one
overall complete nav map.
2022-01-05 16:00:56 +01:00
Hugo Locurcio
ccd8cdc363
Improve the CanvasItem class documentation 2022-01-05 02:04:44 +01:00
Hugo Locurcio
73ec2c6ece
Improve the CameraServer and CameraFeed class documentations
This closes https://github.com/godotengine/godot-docs/issues/3255.
2022-01-04 19:25:50 +01:00
Max Hilbrunner
c44de001de
Merge pull request #56395 from aaronfranke/3.x-doc-midi
[3.x] Document InputEventMIDI and add some missing 0xF MIDI messages
2022-01-04 18:28:16 +01:00
Rémi Verschelde
25369acff9
Merge pull request #51708 from Calinou/viewport-add-32bpc-color-depth 2022-01-04 14:30:24 +01:00
Aaron Franke
da88e42f16
[3.x] Document InputEventMIDI and add some missing 0xF MIDI messages 2022-01-04 05:30:15 -08:00
Max Hilbrunner
1ffcd7b92a
Merge pull request #56150 from snailrhymer/patch-2
[3.x] Fix descriptions of `set_cell` and `set_cellv` in TileMap.xml
2022-01-04 14:04:48 +01:00
Max Hilbrunner
7fae8f6828
Merge pull request #56152 from belzecue/patch-4
Update CharFXTransform: explain "relative index"/"absolute index"
2022-01-04 13:56:07 +01:00
Max Hilbrunner
5083901561
Merge pull request #56378 from Calinou/doc-spatialmaterial-flowmap-format
Document the expected format of anisotropy flowmaps in SpatialMaterial
2022-01-04 13:48:37 +01:00
Yuri Roubinsky
5b0fe7880e [3.x] Add hints and default values to the uniform nodes in visual shader 2022-01-03 22:59:10 +03:00
Max Hilbrunner
08ce24a3c4
Merge pull request #56234 from timothyqiu/3.x-at-tool-script
Use `tool` instead of `@tool` in 3.x documentation
2022-01-02 03:09:09 +01:00
Max Hilbrunner
40f7dcbc7e
Merge pull request #56241 from KoBeWi/r3gist3r_b3for3_us3
[3.x] Improve docs about plugin registration
2022-01-02 03:08:02 +01:00
Hugo Locurcio
9937f7f50d
Document the expected format of anisotropy flowmaps in SpatialMaterial 2021-12-31 17:29:03 +01:00
kobewi
4fc795194b Improve docs about plugin registration 2021-12-25 16:55:03 +01:00
Haoyu Qiu
7b83b5ea3c Use tool instead of at-tool in 3.x documentation 2021-12-25 10:56:34 +08:00
Haoyu Qiu
bb1eb84da4 Alpha channel indicates opacity, not transparency 2021-12-24 16:52:32 +08:00
belzecue
89cebd79e8
Update CharFXTransform: explain "relative index"/"absolute index" (previously identical)
Confusingly, these two properties had identical descriptions even though they measure different things.

"relative_index" measures character count from the custom effect's bbcode opening tag.
"absolute_index" measures character count from the start of the bbcode text that includes the custom effect.

See the code author's own explanation here: https://github.com/godotengine/godot/pull/23658

NOTE: Doco for CharFXTransform.xml has changed significantly in 4.0, where terminology has changed to "glyph".  Therefore, proposing this change for 3.x branch only.
2021-12-22 14:17:47 +08:00
snailrhymer
73f4531c97
Fix descriptions of set_cell and set_cellv in TileMap.xml
Swap the first lines of the descriptions for set_cell and set_cellv to correctly describe which accepts x and y as separate arguments and which accepts a Vector2.

Fix not relevant to master branch due to changes to TileMap.
2021-12-22 02:37:12 +00:00
Rémi Verschelde
f2ddafd860
i18n: Add --lang option to make_rst.py to write translated headings
Add a few missing headings to the translation templates.

(cherry picked from commit b98785309f)
2021-12-21 14:40:13 +01:00
Rémi Verschelde
aac4e36149
i18n: Sync classref translations with 3.x branch (3.5-beta)
This is the new base branch for the classref translations to prepare them
for the 3.5 release.

This means that the 3.4 class ref translations will likely no longer get
updates, as we can't easily maintain two slightly different branches on
Weblate.
2021-12-21 12:33:57 +01:00
Rémi Verschelde
8ed5192f74
i18n: Sync classref translations with Weblate
(cherry picked from commit eb4816ee13)
2021-12-21 12:33:57 +01:00
Rémi Verschelde
05faadab2d
i18n: Remove line numbers from classref PO files
It's useful context for translators but it generates very spammy diffs whenever
a line is added or removed, changing the comments for hundreds or thousands of
msgids needlessly.

We still have the file names so it's relatively easy to search in file to find
the location of the source string.

(cherry picked from commit dbfe36728e)
2021-12-21 12:33:56 +01:00
Haoyu Qiu
e40bb68c05
Add / to the unix shortcut drive list
Also made `get_current_drive()` to pick the longest match on Unix.

(cherry picked from commit 67f04b381b)
2021-12-21 12:11:14 +01:00
cdemirer
8e29a37800
Clarify that replace_by keeps child nodes in tree
(cherry picked from commit 98a3948bf9)
2021-12-21 12:11:14 +01:00
kobewi
4f284893a6
Document get_minimum_size not called in some nodes
(cherry picked from commit 7d5ee8f694)
2021-12-21 12:11:14 +01:00
Micky
9fc2bc6cf2
Various improvements to Camera2D's documentation
A summary of the tweaked descriptions:
* "get_camera_position()" is explains what the camera position is, and mitigates the confusion between this method and Node2D.position;
* "get_camera_screen_center()" links to the "get_camera_position" method;
* "reset_smoothing()" links to the "smoothing_enabled" propriety;

* "drag_horizontal_offset" and "drag_vertical_offset" link to their respective _enabled_ properties;
* "limit_smoothed" links to the "smoothing_enabled" propriety;
* "rotating" clarifies that the camera _view_ rotates when enabled.

Partially closes https://github.com/godotengine/godot-docs/issues/5417, as some of the issues described are no longer present in 4.0, or are not fully solved in this PR.

Further tweaks are welcome, as I'm afraid this could be a too verbose. A few of these could be split into their PR if necessary.

(cherry picked from commit 6cf2623a20)
2021-12-21 12:11:14 +01:00
Haoyu Qiu
36642738e0 Update make_rst.py for non-latin texts 2021-12-21 16:36:53 +08:00
Haoyu Qiu
d99a313fd3 Fix font preview text color on light background 2021-12-18 00:34:54 +08:00
kobewi
bf99f09e14
Mention what happens if find_node() fails
(cherry picked from commit e7722a9a7b)
2021-12-17 00:14:50 +01:00
Rémi Verschelde
d32a763c17
i18n: Sync classref translations with current docs
(cherry picked from commit f8b4412b51)
2021-12-16 17:05:49 +01:00
Rémi Verschelde
754fc89d28
i18n: Sync classref translations with Weblate
(cherry picked from commit 9f838dbece)
2021-12-16 15:15:46 +01:00
Rémi Verschelde
a90cac7ba4
Merge pull request #55988 from timothyqiu/http-proxy-3.x 2021-12-16 13:09:07 +01:00
Haoyu Qiu
1cada6bfa9 Add proxy support for HTTPClient and the editor
* Adds proxy related methods for `HTTPClient` and `HTTPRequest`
* Adds `network/http_proxy/{host,port}` editor settings
* Makes AssetLib and Export Template Manager proxy aware
2021-12-16 19:38:53 +08:00
Haoyu Qiu
c11b1850c4 Make --doctool locale aware
* Adds `indent(prefix)` to `String`
* Moves the loading of tool/doc translation into
  `editor/editor_translation.{h,cpp}`
* Makes use of doc translation when generating XML class references, and
  setup the translation locale based on `-l LOCALE` CLI parameter.

The XML class reference won't be translated if `-l LOCALE` parameter is
not given, or when it's `-l en`.
2021-12-16 18:27:32 +08:00
Haoyu Qiu
b225fec1de Fix indentations in class reference XMLs 2021-12-15 22:40:19 +08:00
Max Hilbrunner
97ea2ba78c
Merge pull request #55668 from Calinou/doc-physics-ticks-per-rendered-frame-3.x
Document physics simulation being limited to 8 ticks per rendered frame
2021-12-15 03:44:49 +01:00
Max Hilbrunner
ee3e3df539
Merge pull request #55772 from Calinou/doc-texturearray-srgb
Document sampling a TextureArray with sRGB -> linear conversion
2021-12-15 03:42:16 +01:00
Max Hilbrunner
1fd0f69050
Merge pull request #55832 from Calinou/doc-reflectionprobe-3.x
Improve the ReflectionProbe class documentation (3.x)
2021-12-15 03:23:51 +01:00
Rémi Verschelde
4d709b71de
Merge pull request #55690 from akien-mga/3.x-scene-tree-doc-font-oversampling 2021-12-14 17:33:00 +01:00
Ryan Roden-Corrent
22fb04bddf
Document how to autoscroll ScrollContainer.
It is not uncommon to want to scroll to the most recently added child of
a ScrollContainer (e.g. a chat box or activity log). This is a little
tricky, since `ensure_control_visible` will not work on a node on the
same frame as you add it. Let's at least document that you need to wait
until the next frame.

Relates to https://github.com/godotengine/godot-proposals/issues/3629.

Backport of https://github.com/godotengine/godot/pull/55609.

Co-authored-by: Yuri Sizov <pycbouh@users.noreply.github.com>
2021-12-14 06:51:05 -05:00
Rémi Verschelde
dd122e2971
Merge pull request #55827 from Calinou/doc-viewport-upside-down 2021-12-12 21:04:55 +01:00