Commit Graph

3470 Commits

Author SHA1 Message Date
Hugo Locurcio
08256e0e16
Improve the CanvasItem class documentation
(cherry picked from commit ccd8cdc363)
2022-01-06 00:58:29 +01:00
Rémi Verschelde
eb4816ee13
i18n: Sync classref translations with Weblate 2021-12-21 12:23:51 +01:00
Rémi Verschelde
dbfe36728e
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.
2021-12-21 12:23:45 +01:00
kobewi
563de4c6f4
Mention what happens if find_node() fails
(cherry picked from commit e7722a9a7b)
2021-12-16 23:00:28 +01:00
Haoyu Qiu
e28860d003
Fix indentations in class reference XMLs
(cherry picked from commit b225fec1de)
2021-12-16 22:59:04 +01:00
Hugo Locurcio
b8c1453f49
Improve the ReflectionProbe class documentation
(cherry picked from commit 2fbf880912)
2021-12-16 22:58:29 +01:00
Hugo Locurcio
ecdd46ff22
Document sampling a TextureArray with sRGB -> linear conversion
This is required when sampling an albedo map from a texture array
in 3D. Otherwise, colors will look washed out.

(cherry picked from commit 491acf346d)
2021-12-16 22:58:10 +01:00
Hugo Locurcio
e058748d06
Document physics simulation being limited to 8 ticks per rendered frame
(cherry picked from commit bfe77b8fab)
2021-12-16 22:57:53 +01:00
Haoyu Qiu
b90bec546d
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`.

(cherry picked from commit c11b1850c4)
2021-12-16 17:06:52 +01:00
Rémi Verschelde
f8b4412b51
i18n: Sync classref translations with current docs 2021-12-16 17:05:08 +01:00
Rémi Verschelde
9f838dbece
i18n: Sync classref translations with Weblate 2021-12-16 15:10:54 +01:00
Rémi Verschelde
69585b0516
SceneTree: Document font oversampling, remove warnings
(cherry picked from commit 35b79284cc)
2021-12-14 17:33:21 +01:00
Ryan Roden-Corrent
6a230c0cd3
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>
(cherry picked from commit 22fb04bddf)
2021-12-14 17:31:00 +01:00
lawnjelly
9d44a88e0b
Visibility Notifier / Enabler classref mention Portals
Fixes the classref to show that these do not take account of occlusion except when using Portals.

(cherry picked from commit b8d3d97b6a)
2021-12-14 17:30:50 +01:00
Hugo Locurcio
4dcce2cf30
Document Viewports rendering upside-down by default
This was fixed in `master`, but the default behavior can't be changed
in `3.x` for compatibility reasons.

(cherry picked from commit 6b26012284)
2021-12-14 17:30:27 +01:00
Haoyu Qiu
1230169ad1
Fix broken links in Class Reference
(cherry picked from commit b1153f8829)
2021-12-10 17:30:31 +01:00
Rémi Verschelde
6fb47a271f
i18n: Remove deleted translations from PO files
Since we bundle the whole files in the editor binary, they actual impact the
binary size needlessly.

Automate it via `make merge`.
2021-12-10 11:49:04 +01:00
Rémi Verschelde
f4b3c3ff09
i18n: Sync classref translations with Weblate 2021-12-10 11:46:57 +01:00
Hugo Locurcio
c089e687cf
Document that RigidBody angular velocity is in degrees per second
This will be changed to radians per second in Godot 4.0, but it can't
be changed in 3.x to preserve compatibility with existing projects.

(cherry picked from commit 2fe15124de)
2021-12-09 12:08:10 +01:00
Raul Santos
a10372fe9a
Expose ScriptEditor::edit to scripting
Exposes a method in `EditorInterface` to open scripts on a specified
line and column. This method handles if the internal or the external
editor should be used.

(cherry picked from commit 9535831866)
2021-12-09 12:06:12 +01:00
Yuri Sizov
e77c6aaba7
Sort and group theme properties in docs, improve formatting for theme and enums
(cherry picked from commit ebd8101546)
2021-12-07 12:14:59 +01:00
Manolis Papadeas
8c59dbda33
Fix link to the supported image formats in the Image class
It previously linked to this page which doesn't exist. https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_images.html#supported-image-formats

Now, it should link here: https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html#supported-image-formats

(cherry picked from commit c01c4c687b)
2021-12-07 09:14:31 +01:00
Hugo Locurcio
6ff6c503d0
Document SceneTreeTimer being freed automatically when elapsed
The note was present in the SceneTree `create_timer()` class
documentation, but not in the SceneTreeTimer class documentation.

(cherry picked from commit 796ea60d11)
2021-12-07 09:14:31 +01:00
Raffaele Picca
47f9a316ce
Fix Ring-Axis parameter being always visible
(cherry picked from commit 2f69caaff3)
2021-12-07 09:14:31 +01:00
Marcel Admiraal
ca3ab75697
Allow any kind of Mesh to be added to an EditorSpatialGizmo
(cherry picked from commit e0729b9c79)
2021-12-07 09:14:31 +01:00
kleonc
d3b0436cfb
Clarify Transform.xform_inv docs
(cherry picked from commit c20d097636)
2021-12-07 09:14:31 +01:00
kobewi
03bfedc67c
Improve store_string() description
(cherry picked from commit 09b1fc1956)
2021-12-07 09:14:27 +01:00
Rémi Verschelde
187530de7d
doc: Fixup Tabs reference after cherry-pick
(cherry picked from commit 6cf77f80b5)
2021-11-30 14:47:22 +01:00
zacryol
7a79ee014d
Clarify usage of TabContainer
Makes it more clear that TabBar is separate from TabContainer, and that the container draws the tabs itself.

(cherry picked from commit 5c645d510f)
2021-11-30 11:00:05 +01:00
Yuri Sizov
93fe9ecb97
Add methods to get position from column and line in TextEdit
(cherry picked from commit ba747e2a26)
2021-11-29 16:44:34 +01:00
zacryol
afa8844679
Fix description of Viewport find_world_2d() method.
The doc now states that the method searches for a World2D among ancestor Viewports as well, differentiating it from the get_world_2d() getter.

and also find_world_3d()

(cherry picked from commit 81c1d5197e)
2021-11-29 16:40:48 +01:00
kobewi
f5ea27e587
Mention that replace_by doesn't free the node
(cherry picked from commit 58a3ea5453)
2021-11-25 23:13:16 +01:00
bruvzg
b8f888a43b
Add Input.is_physical_key_pressed method.
(cherry picked from commit 9877d91c4a)
2021-11-25 23:13:15 +01:00
Hugo Locurcio
5555a69b5e
Document the engine's use of internal groups in Node
(cherry picked from commit f8d9e4afdb)
2021-11-25 23:13:15 +01:00
kobewi
b8bda1fb67
Clarify get_indexed in relation to Nodes
(cherry picked from commit 4ea6709558)
2021-11-25 23:13:15 +01:00
lawnjelly
07e5022cce
BVH - add option for expanded AABBs in leaves
This PR adds a define BVH_EXPAND_LEAF_AABBS which is set, which stores expanded AABBs in the tree instead of exact AABBs.

This makes the logic less error prone when considering reciprocal collisions in the pairing, as all collision detect is now taking place between expanded AABB against expanded AABB, rather than expanded AABB against exact AABB.

The flip side of this is that the intersection tests will now be less exact when expanded margins are set.

All margins are now user customizable via project settings, and take account of collision pairing density to adjust the margin dynamically.

(cherry picked from commit 211dc8cd2d)
2021-11-25 23:13:14 +01:00
Haoyu Qiu
58dc743a2c
Allow toggle TextEdit bookmark gutter
(cherry picked from commit eb6f74855f)
2021-11-25 23:13:14 +01:00
kobewi
cce91ce6e0
Mention how to add margins to Button's icon
(cherry picked from commit 2341c7bbd9)
2021-11-25 21:03:42 +01:00
Rémi Verschelde
f737ed4da0
i18n: Sync classref translations with Weblate 2021-11-19 09:54:07 +01:00
Hugo Locurcio
a49e3bb449
Document low performance when using SurfaceTool.append_from() in thread
(cherry picked from commit f39375d315)
2021-11-15 22:47:24 +01:00
lawnjelly
7de023e192
Portals - Allow user to set roaming expansion margin
Previously a crude metric was used to decide on the roaming expansion margin, but it created unexpected results in some scenarios. Instead this setting is exposed to the user via the RoomManager, allowing them to tailor it to the world size, room sizes, roaming objects sizes and the speeds of movement.

(cherry picked from commit 788f075b44)
2021-11-15 22:45:57 +01:00
Hugo Locurcio
fc749f7f8b
Improve the GIProbe and BakedLightmap class documentation
This adds information about performance and procedural generation.

(cherry picked from commit 194d45f11d)
2021-11-15 22:37:51 +01:00
Benjamin Armstrong
4f2993b124
Clarify how 'audio/driver/output_latency' project setting works
(cherry picked from commit 1e485a7da8)
2021-11-15 22:35:33 +01:00
Rémi Verschelde
9868850a9f
Rect2: Clarify docs for has_point excluding bottom and right borders
Improve tests, as well as documentation for `expand`.

(cherry picked from commit 36c4451a7b)
2021-11-15 22:35:01 +01:00
boruok
0a2dadb639
fixed typo in NavigationPolygon doc
(cherry picked from commit 30d22305e1)
2021-11-15 22:34:11 +01:00
PouleyKetchoupp
f9710ecb5e
Fix test_move reporting collision when touching another body
Reporting rest collision information is needed for move_and_collide and
move_and_slide so floor detection can be done properly, but in the case
of just testing the motion for collision, it makes sense to return false
if the body is able to move all along the path without being stopped.

Updated the logic in test_move and clarified the documentation for
test_move and move_and_collide.

(cherry picked from commit 1560c8b5aa)
2021-11-15 22:33:16 +01:00
PouleyKetchoupp
7344beafdd
Fix errors in KinematicBody when floor is destroyed or removed
In all physics servers, body_get_direct_state() now silently returns
nullptr when the body has been already freed or is removed from space,
so the client code can detect this state and invalidate the body rid.

In 2D, there is no change in behavior (just no more errors).

In 3D, the Bullet server returned a valid direct body state when the
body was removed from the physics space, but in this case it didn't
make sense to use the information from the body state.

(cherry picked from commit b93aeec4a2)
2021-11-15 22:32:53 +01:00
Kongfa Waroros
5f27fd458c
Fix little typos in 3.x doc
(cherry picked from commit 0d852bf5a6)
2021-11-15 22:22:45 +01:00
PouleyKetchoupp
c2a108fe7d
Expose intersect_point in 3D physics server
Also cleaned a few things in the documentation for 2D.

(cherry picked from commit fc2bd63ca0)
2021-11-15 22:22:31 +01:00
Hugo Locurcio
231883bdcc
Improve description for BitMap.grow_mask()
(cherry picked from commit e3d23d444c)
2021-11-04 19:55:56 +01:00