Commit Graph

2510 Commits

Author SHA1 Message Date
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
kleonc
00d087e47d
Fix docs description for CapsuleMesh::mid_height
(cherry picked from commit dd3cc9b817)
2021-04-14 13:52:57 +02:00
Hugo Locurcio
5283c1fb1d
Document overriding project settings that have feature tags
This non-obvious behavior can take a while to discover and fix,
so it's important to mention it in the class reference.

(cherry picked from commit 554742312d)
2021-04-14 13:29:59 +02:00
lawnjelly
2ffdfdfd1a Add buffer orphan / stream options
Allows users to override default API usage, in order to get best performance on different platforms.

Also changes the default legacy flags to use STREAM rather than DYNAMIC.
2021-04-14 12:08:32 +01:00
kobewi
f72c91e0b1
Expose edit_node() for editor plugins
(cherry picked from commit 72014a7a2e)
2021-04-12 09:24:37 +02:00
Anders Stenberg
c4f941114c
Add missing color argument in forward_canvas_draw_over_viewport example.
(cherry picked from commit 034c48dbed)
2021-04-12 00:23:43 +02:00
Nathan Franke
8dd6fd058a
Improve Ambiguous StreamPeerTCP set_no_delay Documentation
(cherry picked from commit dbff957028)
2021-04-07 11:55:11 +02:00
Rémi Verschelde
ed44e2806f
doc: Fix markup issues in classref 2021-04-07 11:52:44 +02:00
Yuri Sizov
ea5b3dda93
Expose editor scale to the plugin API
(cherry picked from commit ea31af68ba)
2021-04-06 10:18:20 +02:00
RoniPerson
79f4da78fb
Added missing : in gdscript example.
(cherry picked from commit 5870931a15)
2021-04-05 12:03:40 +02:00
Rémi Verschelde
7b35fc4549
Merge pull request #47382 from akien-mga/3.x-tilemap-collisions-opt-in
TileMap: Make collision visibility opt-in
2021-03-31 17:59:41 +02:00
Rémi Verschelde
72a547dc9d
TileMap: Make collision visibility opt-in
Supersedes #47204, see discussion there.
2021-03-30 23:39:37 +02:00
skyace65
98caee44f3
Add a warning on using directory to access of imported files
(cherry picked from commit 4378ef0bb7)
2021-03-29 09:26:27 +02:00
Hugo Locurcio
b6ed099b3d
Document how to avoid light leaks with GIProbe 2021-03-28 01:05:58 +01:00
Rémi Verschelde
b450c0091a
Merge pull request #42824 from madmiraal/update-intersect_point-doc-3.2
[3.x] Update intersect_point documentation to mention solid shapes.
2021-03-26 15:48:36 +01:00
Rémi Verschelde
c37c95d1c9
Merge pull request #47108 from lawnjelly/software_skinning_docs
Add to 2d software skinning classref note about custom shaders
2021-03-26 11:22:59 +01:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Paul Joannon
596169d7df
class reference proofreading
(cherry picked from commit 8455e901f3)
2021-03-26 09:49:07 +01:00
kobewi
e8e69b2d50
Clarify that get_unix_time() returns seconds
(cherry picked from commit 6e4a8b7f37)
2021-03-26 09:23:12 +01:00
lupoDharkael
3b0cf34299 Control: Expose pass_on_modal_close_click 2021-03-25 18:29:41 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Hugo Locurcio
df27173750
Make the expected method calling order in SurfaceTool more explicit
(cherry picked from commit 6648dc58d3)
2021-03-23 13:15:30 +01:00
PouleyKetchoupp
4caaa57b49 More detailed documentation for KinematicBody safe collision margin 2021-03-22 15:39:40 -07:00
lawnjelly
4a2ff5b6f2 Add to software skinning classref note about custom shaders
Added note to say that custom shaders operate on VERTEX after the transform with software skinning rather than before (as is the case with hardware skinning).
2021-03-20 10:45:53 +00:00
jmb462
a5bcacb115
Fix AudioEffectCapture buffer length cannot be changed
(cherry picked from commit b588232b83)
2021-03-19 10:50:18 +01:00
Marcus Brummer
9926425ce9
Document different unit of measurement for sensor data on iOS and Android
(cherry picked from commit d1798b235c)
2021-03-17 15:17:02 +01:00
Rémi Verschelde
ea9c1c0a94
Merge pull request #45577 from Birdulon/DocDrawString
[3.3] Documentation: Correct CanvasItem.draw_string position description
2021-03-17 15:16:10 +01:00
Aaron Franke
d82c01c1a0
Improve documentation for AtlasTexture
(cherry picked from commit 682286fec8)
2021-03-16 11:35:23 +01:00
Rémi Verschelde
ba174332af
Merge pull request #46939 from abaire/relaxes_gltf_name_sanitization_3.2
Relaxes Node naming constraints in glTF documents to match the Editor.
2021-03-13 14:57:09 +01:00
abaire
b032067e42 Relaxes Node naming constraints in glTF documents to match the Editor. 2021-03-12 08:35:50 -08:00
Rémi Verschelde
3f246ebeed
Merge pull request #46932 from JFonS/fix_lm_capture_env
[3.2] Batch of lightmapper fixes and minor improvements
2021-03-12 12:30:36 +01:00
JFonS
e2c28675ef Batch of lightmapper fixes and minor improvements
- Fix objects with no material being considered as fully transparent by the lightmapper.
- Added "environment_min_light" property: gives artistic control over the shadow color.
- Fixed "Custom Color" environment mode, it was ignored before.
- Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not.
- Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update).
- Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes.
- Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-12 12:00:53 +01:00
Aitor Cereceto
7e5020b2fa [46188] fix: get unix from datetime when empty dict
(cherry picked from commit 1e820b3d9d)
2021-03-12 10:17:41 +01:00
Bhuvan Vemula
f695e7b4d9 Added Additional Description for PhysicsServer2D->area_create() method.
(cherry picked from commit e3fed7bde8)
2021-03-12 10:12:36 +01:00
lawnjelly
d3930b1af2 Change default ninepatch mode to scaling
Changes default ninepatch mode to preserve compatibility, and renames default mode to 'fixed'.

Also adds an editor restart to changing ninepatch mode and software skinning, which will be more user friendly.
2021-03-10 09:30:23 +00:00
Rémi Verschelde
16fbe80dd2
Merge pull request #46802 from Faless/js/3.x_allow_hidpi
[3.2][HTML5] Respect allow_hidpi option during setup
2021-03-09 10:56:21 +01:00
Fabio Alessandrelli
758daab3ad [HTML5] Respect allow_hidpi option during setup
The option was forced to `true` before, unlike on other platforms.
2021-03-08 23:35:10 +01:00
Rémi Verschelde
0ddba5b712
Merge pull request #44323 from Calinou/doc-spatialmaterial-depth-no-triplanar
Document that SpatialMaterial doesn't support depth mapping + triplanar
2021-03-08 19:41:21 +01:00
Rémi Verschelde
f1f472439e i18n: Sync translations with Weblate 2021-03-08 17:40:29 +01:00
kobewi
e9e0cac3f5 Allow to save override.cfg with ProjectSettings
(cherry picked from commit 156c402f2b)
2021-03-08 17:40:22 +01:00
Rémi Verschelde
118567ca28
Merge pull request #46657 from lawnjelly/revert_snapping
Revert backport of 2D transform and camera snapping options
2021-03-08 14:49:41 +01:00
Aaron Franke
a320d28f53
[3.2] Fix documentation for Vector2/3.sign() 2021-03-07 15:34:57 -05:00
Hugo Locurcio
48d5080e6a
Link to advanced exports tutorial in the Object class documentation 2021-03-05 22:44:41 +01:00
lawnjelly
bf1de6bbfa Revert backport of 2D transform and camera snapping options
More work is needed to make sure that those options actually solve users' issues, so we prefer to remove the options for 3.2.4 and revisit for a future release.
2021-03-05 14:20:31 +00:00
Rémi Verschelde
8a020a6573
Merge pull request #46662 from Calinou/doc-bakedlightmap-hdr
Improve the BakedLightmap `use_hdr` documentation
2021-03-05 15:14:33 +01:00
Rémi Verschelde
ff6cf26286
Merge pull request #46664 from Calinou/doc-margincontainer-theme-constant-3.2
Use safer `add_theme_constant_override()` in MarginContainer code sample
2021-03-05 15:12:03 +01:00
Rémi Verschelde
cad3771ce7
Merge pull request #46623 from Janglee123/tilemap-collision-show
Added `show_collision` property for tilemap node.
2021-03-04 23:40:17 +01:00
janglee
7b6cc3e687 Added show_collision property.
If true, collision shapes are shown in the editor and at run-time.
Requires Visible Collision Shapes to be enabled in the Debug menu,
for collision shapes to be visible at run-time.
2021-03-05 01:21:40 +05:30
Hugo Locurcio
e90f08642d
Use safer add_theme_constant_override() in MarginContainer code sample
Control has magic setters to set custom theme items, but using the
dedicated Control methods is less prone to typos so it should be favored.
2021-03-04 17:18:51 +01:00
Hugo Locurcio
f3496529dd
Improve the BakedLightmap use_hdr documentation
See https://github.com/godotengine/godot/issues/46442.
2021-03-04 17:10:29 +01:00
Hugo Locurcio
bd907d48ad
Remove incorrect/trivial examples in the ItemList class documentation
This closes https://github.com/godotengine/godot-docs/issues/4712.
2021-03-03 22:56:02 +01:00
Ryan Roden-Corrent
d39e5b9987 Clarify Curve.get_closest_point uses baked points.
Based on the doc, I wasn't sure if get_closest_point would return the
closest baked point or the closest "source" point. It seems to use
baked:
8faecd6a47/scene/resources/curve.cpp (L809)

(cherry picked from commit ef5042a70f)
2021-03-02 10:26:14 +01:00
Andy Maloney
28365a5258 Fix some grammar in StyleBoxFlat class docs
(cherry picked from commit 89e7e61773)
2021-03-02 10:26:14 +01:00
Mateo Kuruk Miccino
04fefed904 Logger: Cache 'flush_stdout_on_print' to improve performance, and works before ProjectSettings starts.
ProjectSetting: Now 'application/run/flush_stdout_on_print' requires a restart of the Editor to take effect

(cherry picked from commit 89283b7b53)
2021-03-02 10:26:14 +01:00
lawnjelly
b1e24597e7 Renaming rendering/2d project settings.
The rendering/quality/2d section of project settings is becoming considerably expanded in 3.2.4, and arguably was not the correct place for settings that were not really to do with quality.

3.2.4 is the last sensible opportunity we will have to move these settings, as the only existing one likely to break compatibility in a small way is `pixel_snap`, and given that the whole snapping area is being overhauled we can draw attention to the fact it has changed in the release notes.

Class reference is also updated and slightly improved.

`pixel_snap` is renamed to `gpu_pixel_snap` in the project settings and code to help differentiate from CPU side transform snapping.
2021-03-01 11:38:46 +00:00
lawnjelly
7d5cf60149 Disallow antialiasing for software skinned 2d polys
Antialiasing is not supported for batched polys. Currently due to the fallback mechanism, skinned antialiased polys will be rendered without applying animation.

This PR simply treats such polys as if antialiasing had not been selected. The class reference is updated to reflect this.
2021-03-01 08:26:59 +00:00
Delf Neumärker
7df977c3ed
Fix crash during drag if user freed the drag preview 2021-02-27 15:16:06 +01:00
Haoyu Qiu
2003a41f0f Fixes typo in Array::bsearch_custom doc
(cherry picked from commit 31243e377f)
2021-02-26 11:29:35 +01:00
Hugo Locurcio
b2725cb4b9 Improve the OS.get_environment()/OS.set_environment() documentation
(cherry picked from commit 355803db1b)
2021-02-25 22:38:07 +01:00
Rémi Verschelde
6fc9c409dd
Merge pull request #46420 from nekomatata/draw-collision-outline-option-3.2
[3.2] Added option in project settings to draw Shape2D outlines
2021-02-25 17:15:52 +01:00
PouleyKetchoupp
d94cd42ccd Added option in project settings to draw Shape2D outlines
Disabling collision outlines can be useful for performance when the game
is running and many collision shapes are displayed.
2021-02-25 07:48:33 -07:00
Jummit
0a9190134d expose edit_selected in Tree
(cherry picked from commit 13fb24cb6f)
2021-02-25 15:14:32 +01:00
Bastiaan Olij
e9ce9a8422 Expose set_environment to GDScript 2021-02-25 22:07:38 +11:00
bruvzg
5bbacc85bd
Expose String contents to the GDScript as PoolByteArray. 2021-02-23 13:43:36 +02:00