Commit Graph

2246 Commits

Author SHA1 Message Date
6c3a0e3a5a Several edits to the GDScript docs
(cherry picked from commit bf96056ad0)
2020-12-09 11:22:03 +01:00
eda04c6b6c Fix incorrect Curve3D.interpolate_baked() description
The offset is in 3D units, not pixels.

This closes https://github.com/godotengine/godot-docs/issues/4339.

(cherry picked from commit 5a9600cd24)
2020-12-02 16:03:06 +01:00
deda90bad7 add root_node as property of MultiplayerAPI
(cherry picked from commit d4c4d2db4c)
2020-12-01 09:00:54 +01:00
d8c90f5f1e Improve the ProjectSettings.globalize_path() documentation
This closes https://github.com/godotengine/godot-docs/issues/4409.

(cherry picked from commit f415db5b75)
2020-12-01 09:00:52 +01:00
dbb69f8f49 doc: Mention iOS support for Input gravity/gyroscope sensors
It has been implemented for iOS a long time ago already with #7127.

(cherry picked from commit 2d0fda3ca2)
2020-12-01 09:00:48 +01:00
bdc6f2fd95 Fix binding of default value in EditorSpatialGizmoPlugin::get_material()
It was commented for some reason I can't remember.

(cherry picked from commit e6949dae72)
2020-11-26 09:38:47 +01:00
9706b78a3f Document C# garbage collection caveats in Reference and Resource
(cherry picked from commit 0565c76e8b)
2020-11-26 09:38:47 +01:00
b2b5d9a7a3 Improve the AudioStreamPlayer3D class documentation
(cherry picked from commit 95618e2937)
2020-11-26 09:38:47 +01:00
ac8dedd532 doc: Warn about using Node internal processing
See #43689.

Also 'fixed' some spelling for behavior in publicly visible strings.
(Sorry en_GB, en_CA, en_AU, and more... Silicon Valley won the tech spelling
war.)

(cherry picked from commit a655de89e3)
2020-11-26 09:38:45 +01:00
8adaf603d1 Update the number of lights supported in OmniLight and SpotLight docs
Follow-up to #43606.
2020-11-20 14:07:33 +01:00
776faa5c92 Clarify that SceneTree::quit() does not immediately end the application.
(cherry picked from commit 371d12a2f0)
2020-11-19 17:15:27 +01:00
2edd489f83 Describe ImageTexture, Image creation and usage
Ported from commit 0ee88d6705.
2020-11-17 18:06:52 +02:00
d099b6cf60 Merge pull request #43606 from NHodgesVFX/3.2
Make lights_per_object configurable
2020-11-17 16:20:38 +01:00
5965fbd9fa Make lights_per_object configurable 2020-11-17 10:03:44 -05:00
fc718d87a6 doc: Add description for rendering/quality/2d/use_transform_snap
Co-authored-by: lawnjelly <lawnjelly@gmail.com>
2020-11-17 12:23:58 +01:00
07c8e25078 Clarify Curve3D.get_point_{in,out} position in doc.
I verified this experimentally. I added a point at roughly (1,0,0), and
dragged a handle back to the origin. The result was:

```
get_point_position: (0.991079, 0, -0.000069)
get_point_in: (0.993409, 0, 0)
get_point_out: (-0.993409, 0, 0)
```

(cherry picked from commit c6093ae612)
2020-11-17 12:07:02 +01:00
17af75953f Correct the doc about Tree.get_edited
(cherry picked from commit b8145c182b)
2020-11-17 12:07:02 +01:00
e53a5f6be5 Improve the Dictionary class documentation
- Mention Lua-style syntax.
- Make the code samples self-contained.
- Mention caveat with `const` (also in Array).
- Clarify the description of `size()`.

This closes https://github.com/godotengine/godot-docs/issues/4272.

(cherry picked from commit 5325de4e6b)
2020-11-17 12:07:02 +01:00
92f81ff782 Clarify packet peer max_buffer_po2 in ProjectSettings documentation
This closes https://github.com/godotengine/godot-docs/issues/4364.

(cherry picked from commit c475b1fd0b)
2020-11-17 12:07:02 +01:00
c58b5c5df4 Changed mouse cursor to the caret (text cursor) location.
(cherry picked from commit 59ed3c1aaf)
2020-11-17 12:01:58 +01:00
aa6406874e Document InstancePlaceholder.create_instance not being thread-safe.
(cherry picked from commit a6f3ef3ac7)
2020-11-17 12:01:58 +01:00
18d65673af Docs: MeshDataTool: showcase tool in code example
(cherry picked from commit 4f9b993423)
2020-11-17 12:01:58 +01:00
fc5b106369 Merge pull request #42168 from madmiraal/fix-42108-3.2
[3.2]  Remove the unnecessary sync() and the restrictions it imposes on 3D Physics.
2020-11-16 09:33:17 +01:00
9c83b8ed70 [3.2] Improve comments in Color documentation 2020-11-14 04:56:18 -05:00
a57b6eb211 doc: Sync classref with current source
Move EditorSceneImporterFBX doc to its module folder.
2020-11-11 17:00:41 +01:00
9b64646bc3 Expose LineEdit scroll offset to scripts
(cherry picked from commit 4775db1600)
2020-11-11 15:44:18 +01:00
98774000e2 Add append_array() method to Array class
(cherry picked from commit 9f23a94b8a)
2020-11-11 15:44:14 +01:00
dc05beca80 Register methods for drawing 3D editor overlays
(cherry picked from commit cbfbb4538b)
2020-11-11 15:30:57 +01:00
da2ac44d77 Add docs for editor viewport drawing methods
(cherry picked from commit 5d8b60ac3d)
2020-11-11 15:30:57 +01:00
2652f6fc69 doc: Override default value for RandomNumberGenerator.seed
It's non-deterministic so it's better to show a fixed value like 0 instead of
having it potentially change whenever `randomize()` is called.

Fixes #43317.

(cherry picked from commit 35e6070a35)
2020-11-11 15:30:56 +01:00
b472d5366c Fix typo in Tabs doc.
I don't know enough about grammar to say why the "ing" suffix is
correct, but I'm reasonably sure it is :)

(cherry picked from commit 3826f3348f)
2020-11-11 15:30:56 +01:00
05143ca39a Tooltips: Improve code clarity and docs
The return type for `_make_custom_tooltip` is clarified as Control, and users
should make sure to return a visible node for proper size calculations.

Moreover in the current master branch, a PopupPanel will be added as parent
to the provided tooltip to make it a sub-window.

Clarifies documentation for `Control._make_custom_tooltip`, and shows how to
use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types
to style tooltips.

Fixes #39677.

(cherry picked from commit c5d8dafec4)
2020-11-11 15:30:56 +01:00
de96b29c58 Correct documentation about NinePatchRect stretch modes
This closes https://github.com/godotengine/godot-docs/issues/4333.

(cherry picked from commit 82bfb6273b)
2020-11-11 15:30:56 +01:00
10b1987fda Fix a variable being redeclared in the HTTPRequest code sample
(cherry picked from commit d7025c4167)
2020-11-11 15:30:56 +01:00
7dd5de5a57 Clarify what the "item_rect_changed" signal does
(cherry picked from commit 120ef02ca3)
2020-11-11 15:30:55 +01:00
7db872b55a Add Image.load_bmp_from_buffer() for run-time BMP image loading
This partially addresses
https://github.com/godotengine/godot-proposals/issues/676.

(cherry picked from commit 0209e3790e)
2020-11-11 15:30:55 +01:00
2c6b3074fc Increase the default HTTPClient download chunk size to 64 KiB
This improves download speeds at the cost of increased memory usage.

This change also effects HTTPRequest automatically.

See #32807 and #33862.

(cherry picked from commit 13357095ee)
2020-11-11 15:30:55 +01:00
b682df5653 Document the supported TLS versions in HTTPRequest
See #42857.

(cherry picked from commit 0ebbc7602c)
2020-11-11 15:30:55 +01:00
fb4b800507 Document how to interrupt PacketPeerUDP.wait()
This closes #36335.

(cherry picked from commit 25777488fd)
2020-11-11 15:30:54 +01:00
b62b71e140 Improve the documentation related to fullscreen and borderless settings
(cherry picked from commit a1f81a52df)
2020-11-11 15:12:01 +01:00
7ec83ccb9f Fix missing quote in documentation
(cherry picked from commit aaf5a58b44)
2020-11-11 15:12:01 +01:00
fab38f7cf1 Document AtlasTexture not supporting repetition
See #5660.
2020-11-02 18:29:27 +01:00
8d409423f7 Added a note to ImmediateGeometry regarding it's buffer limit 2020-10-30 16:43:48 +05:30
c43b2ab603 Merge pull request #42942 from Calinou/add-viewport-debanding-3.2
Add a debanding property to Viewport for GLES3
2020-10-30 11:47:57 +01:00
7746afec94 Document hiding a Control when its reference point is behind the camera
See https://github.com/godotengine/godot/issues/1725.

(cherry picked from commit b3a6937c0c)
2020-10-28 14:05:42 +01:00
a7609d9c49 Improved documentation for TileMap.cell_y_sort
(cherry picked from commit 669f21d367)
2020-10-28 14:05:42 +01:00
921046c822 Add border_width to ReferenceRect
Exposes a hidden parameter behind `CanvasItem.draw_rect()`.

(cherry picked from commit aef00021a9)
2020-10-28 14:05:40 +01:00
bdfa43ea63 Cross-reference ColorRect and ReferenceRect in the class reference
They use the same underlying `CanvasItem.draw_rect()` API.

(cherry picked from commit 803b046b38)
2020-10-28 14:05:40 +01:00
a5f98e915c Document how to display the vertex color in SurfaceTool.add_color()
This closes https://github.com/godotengine/godot-docs/issues/4083.

(cherry picked from commit 2f1d40367a)
2020-10-28 14:05:39 +01:00
2e073ecbea Merge pull request #42927 from lawnjelly/octree_default
Change render octree balance default
2020-10-21 10:19:34 +02:00