Commit Graph

2510 Commits

Author SHA1 Message Date
Hugo Locurcio
eb504880f1
Document Image.generate_mipmaps() always running on the main thread
(cherry picked from commit 30a88f464b)
2021-09-29 08:57:24 +02:00
LoipesMas
8205edaa64
Add note about batching to Line2D's anti-aliasing
(cherry picked from commit b047430702)
2021-09-29 08:57:21 +02:00
Kyle
5646d32a91
Wrote JNISinglton docs
I added a few descriptions and links to the empty JNISingleton class doc.

(cherry picked from commit 4eff57d39b)
2021-09-29 08:14:21 +02:00
skyace65
6d98595280
Add note that for _gui_input(event) event position is relative to the control origin
(cherry picked from commit 824259aca0)
2021-09-29 08:13:26 +02:00
kobewi
5b97007def
Improve call_group documentation
(cherry picked from commit 31ef94f2ec)
2021-09-21 17:45:13 +02:00
Hugo Locurcio
651ab394a8
Document how to delay code execution in a non-blocking manner
(cherry picked from commit 1529bf7c10)
2021-09-21 17:45:13 +02:00
mechPenSketch
9569ec516b
Add Graph Illustrations to Doc
(cherry picked from commit 9ea619c486)
2021-09-21 17:45:12 +02:00
Nick Huelin
c939ef15fa
Add note to SceneTree about pausing
This pull request adds a small amendment to `SceneTree` describing the behavior `_physics_process()` when pausing the scene.

`_physics_process` will completely stop processing collisions and signals whenever the scene is paused, however, the function will still receive calls.

This addresses: #47326

(cherry picked from commit d62175e009)
2021-09-21 15:39:12 +02:00
Nick Huelin
525e5ba729
Add note to RichTextLabel
(cherry picked from commit 4a0cadd4ed)
2021-09-21 15:38:57 +02:00
Marcus Brummer
3abde51994
Documented that mutexes are implemented recursively
(cherry picked from commit 46bbeb2b60)
2021-09-21 15:30:33 +02:00
georgespatton
1c1bc75e28
doc: Clarify need to save ConfigFile to apply changes to file
See #52645 for context.

(cherry picked from commit fd8bdddd5d)
2021-09-21 15:29:39 +02:00
Hugo Locurcio
8e55a1870f
Document caveats with StyleBoxFlat antialiasing and beveled corners
(cherry picked from commit f7f8ae6372)
2021-09-21 15:27:15 +02:00
Hugo Locurcio
aa0de1c6e0
Improve documentation for String.get_extension()
(cherry picked from commit 09eb98c530)
2021-09-21 14:26:47 +02:00
Hugo Locurcio
0ac9c9906b
Document Object.get_class()/is_class() ignores class_name declaration
(cherry picked from commit a15847e5ca)
2021-09-21 11:02:15 +02:00
Hugo Locurcio
2cd5516672
Improve documentation for Engine.get_idle_frames/get_physics_frames()
(cherry picked from commit 31c07bcca7)
2021-09-21 10:52:40 +02:00
Hugo Locurcio
62953c4fae
Document that ConfigFiles can use any file extension
The file extension given to a ConfigFile has no impact on its
formatting or behavior.

(cherry picked from commit 9c6ae95cb2)
2021-09-20 16:21:42 +02:00
Aaron Franke
f799163914
[3.x] Improve the docs for the float type
(cherry picked from commit 02a94ee977)
2021-08-18 23:27:57 +02:00
kobewi
f604b32081
Fix renaming directories
(cherry picked from commit 0dde3e5b59)
2021-08-18 23:23:39 +02:00
ne0fhyk
2eb8875b77
Add partial support for Android scoped storage.
This is done by providing API access to app specific directories which don't have any limitations and allows us to bump the target sdk version to 30.
In addition, we're also bumping the min sdk version to 19 as version 18 is no longer supported by Google Play Services and only account of 0.3% of Android devices.

(cherry picked from commit c88d1608ab)
2021-08-16 09:56:32 +02:00
Hugo Locurcio
afefa8f70f
Fix incorrect descriptions for EditorFileSystem's get_file_type()
(cherry picked from commit 1942e0c117)
2021-08-13 10:41:32 +02:00
Fredia Huya-Kouadio
d4eecf4535
Update external texture flag configuration.
(cherry picked from commit 2cc1cdc27b)
2021-08-13 10:41:19 +02:00
Max Hilbrunner
8c20e03150
Docs: Add warnings about no SSL/(D)TLS revocation
(cherry picked from commit 4eb427afb8)
2021-08-13 10:40:55 +02:00
follower
1785d3e030
Fix Unicode URL link tags to render correctly.
Change incorrect `[/code]` closing tags to `[/url]` tags.

The `url` tags for the links to the Unicode code points information use `[/code]` rather than `[/url]` to close them.

This results in the links being rendered incorrectly in the IDE--the entire rest of the documentation for each method gets turned into a giant underlined link.

This issue was introduced in a2271ba3bd.

(cherry picked from commit b85688ac7d)
2021-08-13 10:36:58 +02:00
Yuri Sizov
2cf58509dd
Improve the inspector plugin documentation and remove a confusing statement
(cherry picked from commit 974e76a082)
2021-08-13 10:36:57 +02:00
Iced Quinn
bb14eb9743
doc: Add documentation for JSONRPC class
(cherry picked from commit 3fc5646b98)
2021-08-13 10:25:58 +02:00
kobewi
4bc527fedd
Improve ConfigFile example
(cherry picked from commit 1721f0143e)
2021-08-03 14:57:34 +02:00
Rémi Verschelde
16fd1c421e
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:32:31 +02:00
Kevin Sanders
620579eaf8
Grammar fix.
(cherry picked from commit 6db57b9da2)
2021-08-03 09:28:47 +02:00
Hugo Locurcio
5e3ed7e014
Link to the Random number generation tutorial in RandomNumberGenerator
This was done in `master` already, but not in `3.x`.

(cherry picked from commit 93f4f9e076)
2021-08-03 09:28:00 +02:00
Hugo Locurcio
dd7bb8f965
Document Image.save_exr() only being available in editor builds
(cherry picked from commit a1784c64b4)
2021-07-28 15:39:44 +02:00
Hugo Locurcio
bd63402ed6
Document caveats with Control's mouse_entered/mouse_exited signals
(cherry picked from commit 37c1cbdcb2)
2021-07-26 14:40:01 +02:00
Nicholas Huelin
6cea423cc6
Fix doc typos
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`,  `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.

(cherry picked from commit 9a72b0d3d0)
2021-07-24 01:12:59 +02:00
Nicholas Huelin
f240d77e29
Fix miscellaneous doc typos and inconsistencies
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.

(cherry picked from commit 9787e631aa)
2021-07-24 01:12:42 +02:00
Distrikt64
ce71a883c7
Fix msec documentation description typo
(cherry picked from commit 44eb041d60)
2021-07-24 01:12:30 +02:00
Joseph Davies
22a449c420
Fix grammar in MultiMesh documentation.
(cherry picked from commit 136567ebcf)
2021-07-24 01:12:10 +02:00
Hugo Locurcio
e652218b1f
Document the RootMotionView class
(cherry picked from commit 6880829a9a)
2021-07-24 01:11:21 +02:00
Aaron Franke
752c1451db
[3.x] Allow reading shaders from .gdshader files
(cherry picked from commit 7dc2edc430)
2021-07-20 12:00:16 +02:00
Haoyu Qiu
cca999c007
Fix doc description of HTTPClient::request
(cherry picked from commit 422f821be9)
2021-07-13 12:16:25 +02:00
Nick Huelin
00ed053486
Add method description to PopupMenu
This pull request adds a missing method description to `PopupMenu`.

This completes the documentation for `PopupMenu` and enhances usability by doing so.

Update doc/classes/PopupMenu.xml

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit 2e3cbbcd11)
2021-07-13 12:15:31 +02:00
Nick Huelin
bdcdfb0db7
Add multiple descriptions to several classes
This pull request adds several descriptions to multiple different classes.

This improves the completeness of the documentation and enhances usability by doing so.

(cherry picked from commit 27e9df7778)
2021-07-06 16:29:53 +02:00
Nick H
28ea0cf1e2
Add get_dead_zone() method to InputMap
This commit adds a new method to the `InputMap`, allowing the user to get the value of an action's dead zone as a float.

(cherry picked from commit c6f28ed62b)
2021-07-06 16:29:20 +02:00
Hugo Locurcio
c90766cc38
Document debanding being broken on mobile
(cherry picked from commit 9c4ebea9ef)
2021-07-06 16:28:41 +02:00
Levi Lindsey
25bf30da53
Update File.store_var description to mention which properties of an object are included.
(cherry picked from commit 2b7c0cfb34)
2021-06-29 14:02:57 +02:00
Nick H
6f58cfd077
Amend Label.clip_text() Method Description
This update fixes an inconsistencies in the documentation about the `clip_text()` method.

(cherry picked from commit ea94aeac48)
2021-06-29 14:02:56 +02:00
Hugo Locurcio
e39d59b43e
Improve descriptions for ProjectSettings' disable_stdout/disable_stderr
(cherry picked from commit e3ef50db38)
2021-06-29 13:52:49 +02:00
PouleyKetchoupp
0938958111
Expose collider RID in 2D/3D kinematic collision
Can be useful to access the colliding body information for bodies
created with the physics server directly.

(cherry picked from commit a146e79758)
2021-06-29 13:48:37 +02:00
Hugo Locurcio
5dcbe95758
Fix duplicate paragraph in ArrayMesh.add_surface_from_arrays() description
(cherry picked from commit 033985f9c2)
2021-06-17 13:21:12 +02:00
Hugo Locurcio
fbe8226213
Tweak the physics FPS property hint to only allow reasonable values
Physics FPS above 1000 cause the whole project to slow down
and are not very practical in the first place (since no CPU currently
available can keep up).

(cherry picked from commit 8f4ac7bc4a)
2021-06-17 13:20:04 +02:00
Hugo Locurcio
2760de8710
Document applying VRAM compression setting changes retroactively
(cherry picked from commit d0d717809e)
2021-06-17 13:17:28 +02:00
Nick Huelin
aa4afee320
Edit "quit()" method description in SceneTree
Updated the `SceneTree.quit()` method to include a note that on iOS this method won't work as apps are expected to be closed via the Home button, not programmatically.

(cherry picked from commit c63af17a31)
2021-06-07 22:50:12 +02:00