Commit graph

3097 commits

Author SHA1 Message Date
Hugo Locurcio f0dcedbf3a
Make makerst.py create folders automatically, print a message when done
(cherry picked from commit f05aa9cc01)
2021-07-13 12:16:05 +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
kobewi e5dc7a06a9
Improve sort_custom() description
(cherry picked from commit 48f0368ddc)
2021-06-07 22:49:37 +02:00
Marcel Admiraal 3c55a9c210
Fix game controllers ignoring the last listed button
(cherry picked from commit 18825ad4ff)
2021-06-07 22:40:42 +02:00
Hugo Locurcio f7e9467441
Document Navigation.get_simple_path() often returning non-optimal results
(cherry picked from commit 8e4afdc71d)
2021-06-07 22:38:55 +02:00
RoniPerson f1ca7c5e98
Added documentation to some add_*_plugin methods
Added documentation to some `add_*_plugin` methods and the corresponding `remove_*_plugin` methods.
Added an example of how to register a plugin to `add_inspector_plugin` and linked to it in the other methods.

(cherry picked from commit e849157e07)

Proofread add_*_plugin/remove_*_plugin descriptions in EditorPlugin

(cherry picked from commit 21f0961610)
2021-06-07 22:38:05 +02:00
Hugo Locurcio c45ce8b6bb
Uncap the range for gravity and change the slider hints
There's not really a reason to cap the gravity amount, and we can also
give better hints for the range (for 3D, ±32 is much more sensible
than ±1024).

(cherry picked from commit e0facdaf61)
2021-06-03 12:42:30 +02:00
Hugo Locurcio 593b3272f6
Document Resource.duplicate() only copying exported variables' values
(cherry picked from commit 2ba893e3ce)
2021-05-31 13:43:20 +02:00
Aaron Franke f901049a0d
[3.x] Fix Camera FOV documentation
(cherry picked from commit 753d0fca1d)
2021-05-31 12:39:57 +02:00
Marcel Admiraal 3574c87888
Update EditorResourcePreview queue_*() documentation
(cherry picked from commit 72446bab1b)
2021-05-31 11:34:13 +02:00
PouleyKetchoupp b9492b2659
Fix logic for showing tilemap debug collision
In editor: only when show_collision property is enabled
In game: only when 'Visible collision shapes' is enabled

(cherry picked from commit 114da550ec)
2021-05-31 11:34:00 +02:00
Hugo Locurcio c3f2eb9291
Remove duplicate orientation settings in the iOS export preset
The screen orientation is now sourced from the Project Settings
like it is done for Android already.

(cherry picked from commit 914b5dc525)
2021-05-31 11:27:26 +02:00
Rémi Verschelde 2c99306e20
OS: Better validation of invalid input for get_unix_time_from_datetime
Default missing keys to Unix time 0 (1970-01-01 at 00:00:00 UTC).
Abort if year <= 0, this is not supported by the current algorithm.

Prevents an infinite loop further down.

Fixes #49022.

(cherry picked from commit 62efa30ed2)
2021-05-24 13:39:13 +02:00
Hugo Locurcio 418e044789
Remove high radiance sizes from the editor due to issues on specific GPUs
These values can still be set by code, but are no longer presented in
the editor.

(cherry picked from commit 8d9cef3726)
2021-05-22 19:08:35 +02:00
Rémi Verschelde 337ef03958
Fix typos with codespell
Using codespell 2.0.0.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
GIRD
leapyear
lod
merchantibility
nd
numer
ois
ony
que
seeked
synching
te
uint
unselect
webp
EOF

$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```

(cherry picked from commit eb78f80f03)
2021-05-20 14:36:39 +02:00
Fabio Alessandrelli 066ceefcaf
[Doc] Remove reference to UNIX sockets in StreamPeer.
That class can be used as a base to implement them, but there is no
actual implementation for it in Godot.

(cherry picked from commit e858f7c2ea)
2021-05-20 14:36:08 +02:00
kleonc 5602deeb0f
Document valid range of Node2D.z_index
(cherry picked from commit 4871bf4668)
2021-05-20 14:35:51 +02:00
Hugo Locurcio 3299600093
Document caveats of OS.get_unique_id()
(cherry picked from commit 7350f90c57)
2021-05-09 16:29:14 +02:00
Hugo Locurcio 5514b16950
Improve the AudioStreamPlayer(2D/3D) class descriptions
(cherry picked from commit b90adec417)
2021-05-09 16:23:16 +02:00
TwistedTwigleg e9c8889ae8
Fixes the SkeletonIK twisting issue by using the skeleton global pose without overrides
(cherry picked from commit c1bc87ed0d)
2021-05-09 16:14:11 +02:00
PouleyKetchoupp 7c5633c032
Expose get_debug_mesh in Shape to scripting API
Can be useful for custom drawing of physics shapes without having to add
a collision object node to the tree.

(cherry picked from commit 0ba5001fb6)
2021-05-05 18:35:54 +02:00
Hugo Locurcio b1cb84b452
Document that File.open_compressed() can only open files saved by Godot
(cherry picked from commit 5f098d6db6)
2021-05-05 18:35:54 +02:00
Hugo Locurcio edf5a03714
Document that SceneTree.call_group() is deferred
(cherry picked from commit 7516ff3805)
2021-04-30 12:11:08 +02:00
Hugo Locurcio 08bedba341
Document that clearcoat/rim lighting is not visible on unshaded materials
(cherry picked from commit 8df0e61cc2)
2021-04-29 13:36:57 +02:00
smix8 42c88d99ae
Add SkeletonIK function documentation
Add SkeletonIK function documentation

(cherry picked from commit 84e603ec7e)
2021-04-29 13:34:31 +02:00
skyace65 dbf71c1b70
Improve SpriteFrames get_animation_loop description
(cherry picked from commit d311c48d6a)
2021-04-29 13:05:52 +02:00
Rémi Verschelde 278af7d023
doc: Mark LargeTexture as deprecated (removed in 4.0)
Cf. https://github.com/godotengine/godot/pull/48269.

(cherry picked from commit 562c6bd9ab)
2021-04-29 13:05:15 +02:00
kleonc 9201ffa9a2
Improve some argument names for core types
(cherry picked from commit 4d7f642fb3)
2021-04-26 11:50:31 +02:00
Hugo Locurcio dc98144b99
Link to Feature tags more explicitly in ProjectSettings documentation
(cherry picked from commit 188bd5638c)
2021-04-23 22:05:22 +02:00
Arthur Paulino 3b44829fbd
Updating KinematicBody2D "is_on" functions' descriptions
(cherry picked from commit 0c9a1a1cd4)
2021-04-23 22:03:27 +02:00
Hugo Locurcio e33562fe9f
Improve the Engine.editor_hint property documentation
(cherry picked from commit 17591fc6a1)
2021-04-21 08:59:31 +02:00
Rémi Verschelde 64cf72af7b
Merge pull request #48059 from clayjohn/shadow-cubemap-fix
Add setting for shadow cubemap max size
2021-04-21 08:53:26 +02:00
clayjohn 0546c8760a Add setting for shadow cubemap max size 2021-04-20 23:17:45 -07:00
Hugo Locurcio f0d1bedc74
Print a warning when trying to seek in VideoPlayer
Seeking isn't implemented in built-in video formats and can only
be supported in GDNative-provided video formats.

(cherry picked from commit ea46639e22)
2021-04-20 20:16:42 +02:00
smix8 595a1edd3b
Document AnimationNodeTimeSeek with clarified usage and code example
Document AnimationNodeTimeSeek with clarified usage and code example

(cherry picked from commit 35c9192689)
2021-04-20 20:15:54 +02:00
RoniPerson 6308f4374f
changed description of merge_polygons
Clarified that the `merge_polygons` method can produce multiple holes.

(cherry picked from commit 8f01c261f2)
2021-04-20 20:14:54 +02:00
Hugo Locurcio ad413a613c
Document AStar.get_point_path() not being thread-safe
(cherry picked from commit cf64bad63e)
2021-04-20 20:14:47 +02:00
Rémi Verschelde 1c9203ad68
Object: Make deleted object access raise errors, not warnings
Clarify doc about not decaying to `null` for `free` and `queue_free`.

Part of #45639.
2021-04-20 11:37:39 +02:00
rainlizard 84ecbbaa89
Document how to use a TextureArray 2021-04-19 14:20:03 +02:00