Commit graph

2763 commits

Author SHA1 Message Date
Michael Alexsander
d7065106ef
State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docs
(cherry picked from commit 4f13a7f47f)
2020-08-31 15:29:41 +02:00
skyace65
2e1e1af1d2
Add defaults to tilemap set_cell function example
(cherry picked from commit 43ab91ca02)
2020-08-31 15:29:41 +02:00
Hugo Locurcio
b76aa91402
Mention performance caveats about find_node() and find_parent()
See https://github.com/godotengine/godot-proposals/issues/1303.

(cherry picked from commit ab2f41f598)
2020-08-31 15:29:31 +02:00
Rémi Verschelde
7d825e2c05
Merge pull request #41046 from Calinou/doc-windowdialog-exclusive
Mention caveats for `popup_exclusive` in the WindowDialog documentation
2020-08-31 13:24:09 +02:00
hhsdev
90ba819e7b Documentation: specify how WindowDialog's default title bar is made 2020-08-31 16:17:53 +06:30
Hugo Locurcio
3b080845a8
Link to 2D Sprite animation tutorial in relevant class documentations
(cherry picked from commit 6d62e8b917)
2020-08-25 12:58:31 +02:00
Tomasz Chabora
e880956943
Mention that body_set_state is deferred
(cherry picked from commit 255129a5d9)
2020-08-25 12:58:24 +02:00
Rémi Verschelde
dbb0ad3b59
doc: Sync classref with current source 2020-08-21 02:33:44 +02:00
skyace65
5954f82e44
Update CollisionShape2D doc
(cherry picked from commit fe8d998858)
2020-08-21 02:28:28 +02:00
skyace65
cd2da16d63
Clarify points in Line2D doc
(cherry picked from commit 3c9c541c59)
2020-08-21 02:28:18 +02:00
Hugo Locurcio
13175b6387
Document limitations related to centering text with RichTextLabel
This is a relatively common question on various community channels.

(cherry picked from commit 95c2e43095)
2020-08-21 02:28:18 +02:00
Hugo Locurcio
f90931c47a
Add more error explanations in the BMP image loader
This closes #32166 and closes #30629.

(cherry picked from commit 40485e2479)
2020-08-21 02:28:17 +02:00
Hugo Locurcio
a6f0810d51
Make the lack of AtlasTexture support in AnimatedTexture more prominent
See https://github.com/godotengine/godot/issues/33855.

(cherry picked from commit a7ad7ce3bd)
2020-08-21 02:28:17 +02:00
Yetizone
5bc06c7014 Viewport Usage enumeration
Mention that 3D effects are not available when using USAGE_2D
2020-08-20 17:54:14 +03:00
Rémi Verschelde
9bf5a0b791
Merge pull request #41081 from naithar/feature/ios-framework-import-3.2
[iOS] [3.2] Export: Add a method to embed a framework
2020-08-19 14:11:27 +02:00
Sergey Minakov
910c554a1a iOS Export: Add a method to embed a framework
By default 'add_ios_framework' would not embed a framework to save previous behavior.
New 'add_ios_embedded_framework' would embed framework on export.
2020-08-19 14:54:59 +03:00
Rémi Verschelde
5a3096a1cd
Merge pull request #41088 from clayjohn/DOCS-32-Sprite3D
Update Sprite3D docs to reflect recent changes
2020-08-18 23:38:58 +02:00
Hugo Locurcio
62256e0b3a Reference Range signals in the Slider class documentations
See https://github.com/godotengine/godot-docs/issues/3837.

(cherry picked from commit eaa52cbb36)
2020-08-17 11:05:04 +02:00
Hugo Locurcio
d4740ee643 Document the lack of kerning support in DynamicFont
(cherry picked from commit e506479fce)
2020-08-17 11:04:32 +02:00
Rémi Verschelde
e283d4b5c8 Update AUTHORS and DONORS list
New contributors added to AUTHORS:
@hinlopen, @naithar, @rrcore, @SkyLucilfer, @TwistedTwigleg

Thanks to all contributors and donors for making Godot possible!

---

Also changes to relevant code that parses the DONORS.md to match
the new tiers.

(cherry picked from commit d2d4c1c957)
2020-08-14 00:32:05 +02:00
Tomasz Chabora
7ce476c425 Expose NOTIFICATION_POST_ENTER_TREE
(cherry picked from commit 677796a2c3)
2020-08-14 00:32:05 +02:00
Thakee Nathees
b62872d5bc Documentation: clarify the indent parameter of JSON.print
(cherry picked from commit 3609351788)
2020-08-14 00:32:05 +02:00
Tomasz Chabora
f592600ee8 Mention that Array.front/back throw error if empty
(cherry picked from commit 4ff1a34171)
2020-08-14 00:32:05 +02:00
Hazar
58a30199b4 grow_mask() description added
Description;
> Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied.

(cherry picked from commit 1c61c8ab55)
2020-08-14 00:32:05 +02:00
Tomasz Chabora
5433b8470c Improve Vector2.angle() description
(cherry picked from commit a09078e64b)
2020-08-14 00:32:05 +02:00
Martin Capitanio
71bad8dba6 Add option to disable virtual keyboard for TextEdit
Adding support for disabling virtual keyboard on mobile platforms, in
order to make it consistent with LineEdit.

It allows implementing a custom virtual keyboard.

See: https://github.com/godotengine/godot/pull/41139
2020-08-09 18:22:11 +02:00
clayjohn
8fdbf61df8 Update Sprite3D docs to reflect recent changes 2020-08-06 13:10:39 -07:00
Hugo Locurcio
793694fc40
Mention caveats for popup_exclusive in the WindowDialog documentation
This closes #41045.
2020-08-05 12:01:31 +02:00
Hugo Locurcio
fc7451204e Improve JSON-related documentation
This closes https://github.com/godotengine/godot-docs/issues/3848.

(cherry picked from commit 930e10ffff)
2020-07-31 13:09:21 +02:00
codetorex
3869b82bc1 Added missing information about File.open_encrypted function to docs.
(cherry picked from commit 3f6a7c74e3)
2020-07-31 13:08:59 +02:00
TheDuriel
7e9b7b0462 Clarify TreeItem return values
(cherry picked from commit 0ff1ca4655)
2020-07-31 13:08:40 +02:00
Hugo Locurcio
7c728f0ee4 Add an example for creating a button in the Button class documentation
This closes https://github.com/godotengine/godot-docs/issues/3798.

(cherry picked from commit 8836c7203b)
2020-07-31 13:08:24 +02:00
Hugo Locurcio
78a6a57884 makerst: Add descriptions to method qualifiers
This closes https://github.com/godotengine/godot-docs/issues/1753.

(cherry picked from commit c162a39c7b)
2020-07-30 22:46:16 +02:00
Hugo Locurcio
2987fb3b45 Improve the EditorInterface.get_editor_viewport() description
This closes https://github.com/godotengine/godot-docs/issues/1109.

(cherry picked from commit 60d40d8430)
2020-07-30 16:27:11 +02:00
Hugo Locurcio
2494224f96 Link to Thread-safe APIs in the Thread class documentation
This closes https://github.com/godotengine/godot-docs/issues/2276.

(cherry picked from commit f50a4b8a3b)
2020-07-30 16:26:55 +02:00
Rémi Verschelde
6d2f8dd827 doc: Sync classref with current source 2020-07-30 16:26:45 +02:00
Rémi Verschelde
19802f7dc0
Merge pull request #33646 from NeoSpark314/gles2_highp
Added option to enable high precision float in GLES2
2020-07-30 07:52:29 +02:00
Holger Dammertz
efe6b50f17 Added option to enable high precision float in GLES2
An additional project setting under rendering/gles2/compatibility with the name
enable_high_float.Android is introduced that enables #define USE_HIGHP_PRECISION
in GLES2 shader on Android when it is supported by the shader compiler.
This fixes #33633 and #32813 and also https://github.com/GodotVR/godot_oculus_mobile/issues/60
and https://github.com/GodotVR/godot_oculus_mobile/issues/68 on devices that
support the highp (high precision) modifier.
2020-07-30 05:40:15 +02:00
Hugo Locurcio
4a0568b609 Document how to perform advanced string splitting using RegEx
This closes https://github.com/godotengine/godot-docs/issues/3607.

(cherry picked from commit 5f2b6bd476)
2020-07-29 18:24:00 +02:00
Hugo Locurcio
bd76fcd43b Add an example to the CanvasItem.draw_string() documentation
This closes https://github.com/godotengine/godot-docs/issues/3374.

(cherry picked from commit 0c7735be5b)
2020-07-29 18:23:45 +02:00
Hugo Locurcio
b3effe5faa Fix incorrect key name in the Animation documentation code sample
This closes https://github.com/godotengine/godot-docs/issues/3841.

(cherry picked from commit 4257aa5c5c)
2020-07-29 18:23:31 +02:00
Rémi Verschelde
36b746d903
Merge pull request #40822 from Calinou/doc-canvasitem-draw_multiline_colors-antialiased
Document `CanvasItem.draw_multiline_colors()` not supporting width and AA
2020-07-29 12:45:17 +02:00
Hugo Locurcio
39ec3ad2e5 Document CanvasItem.draw_multiline_colors() not supporting width and AA 2020-07-29 11:45:49 +02:00
Nathan Franke
9de0439a45
Revert "Follow-Up Fix Directory Open"
This reverts commit ec787f0134.
2020-07-28 13:53:57 -04:00
Rémi Verschelde
e82e9588fd doc: Sync classref with current source 2020-07-28 11:50:39 +02:00
Hugo Locurcio
451648c34d Improve visibility documentation for CanvasItem and Node3D
This closes https://github.com/godotengine/godot-docs/issues/3840.

(cherry picked from commit 27b09dfc44)
2020-07-28 00:53:16 +02:00
Marcel Admiraal
cdb3712992 Clarify the difference between contacts and collisions.
(cherry picked from commit 6f1c99e5b4)
2020-07-28 00:52:07 +02:00
Hugo Locurcio
b717a61903 Improve the Object, Reference and Resource class documentations
(cherry picked from commit 4275e6aad5)
2020-07-28 00:48:33 +02:00
Hugo Locurcio
508388a9fd Document an example dictionary returned by TileSet.tile_get_shapes()
(cherry picked from commit 60bb80505f)
2020-07-28 00:39:49 +02:00
Rémi Verschelde
400a780050 Revert "Allow Area2D and 3D mouse events without a collision layer"
This reverts commit 15850687a8.
2020-07-27 22:46:04 +02:00
Rémi Verschelde
a2edf04fd2
Merge pull request #40469 from nekomatata/virtual-keyboard-enter-fixes-3.2
[3.2] Fix Return key events in LineEdit & TextEdit on Android
2020-07-26 20:26:02 +02:00
Rémi Verschelde
b3d46d4809
Merge pull request #40675 from Calinou/doc-texturerect-viewporttexture
Document ViewportTexture flipping in TextureRect
2020-07-24 23:32:46 +02:00
Hugo Locurcio
5589529cf3
Document ViewportTexture flipping in TextureRect 2020-07-24 22:30:58 +02:00
Rémi Verschelde
b40f3f9740 Style: Sync other changes from new fix_style.sh and clang_format.sh 2020-07-24 10:39:18 +02:00
QbieShay
53a3476fc2 fixed documentation for get_hit_length of spring arm 3D
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit d1bff73611)
2020-07-24 10:31:57 +02:00
follower
0fdfa47929 Fix presumed copy/paste error: "Returns" -> "Sets"
I might be going out on a limb here... :D

(cherry picked from commit e38b63400c)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
ad18e16389 Document polling rate limitations in InputEventMouseMotion
This closes #40579.

(cherry picked from commit 924b7ea2f5)
2020-07-24 10:31:57 +02:00
PouleyKetchoupp
930c880fa6 Add option to disable virtual keyboard for LineEdit
Co-authored-by: Alexander Holland <alexander.holland@live.de>
(cherry picked from commit 0aa56e3ab8)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
7078d33fa1 Document HTML5 CORS restrictions in HTTPClient and HTTPRequest
See https://github.com/godotengine/godot/issues/40247.

(cherry picked from commit 90db42d9db)
2020-07-24 10:31:57 +02:00
Andrii Doroshenko (Xrayez)
6416df8e34 Document the process of parsing command-line arguments
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit df80e259cd)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
606d4270c6 Document several editor-related classes to 100% completion
(cherry picked from commit fb2e4d77eb)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
0e44834cd3 Improve the VisibilityNotifier and VisibilityEnabler class descriptions
(cherry picked from commit ce57cc43dd)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
52a33a8066 Complete the EditorSettings class documentation
EditorSettings is now 100% documented.

(cherry picked from commit 708a0a43fb)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
7e9a51cdd5 Mention toggled signal for pressed state in BaseButton documentation
This closes #40455.

(cherry picked from commit 43dae28e9d)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
753ff1fad2 Mention the Data paths documentation in the File class
This closes https://github.com/godotengine/godot-docs/issues/3799.

(cherry picked from commit d4085d6bfb)
2020-07-24 10:31:57 +02:00
Ryan Roden-Corrent
c77492408a Clarify how to convert PrimitiveMesh to ArrayMesh.
It took me a bit to figure this out, as I was initially doing something
more complicated like this before I realized I just had to pass
get_mesh_arrays directly to add_surface_from_arrays.

```
var arr_mesh = ArrayMesh.new()
var arrays = []
arrays.resize(ArrayMesh.ARRAY_MAX)
arrays[ArrayMesh.ARRAY_VERTEX] = c.get_mesh_arrays()
arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays)
```

(cherry picked from commit 933bf96523)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
5c7802a061 Document which escape sequences are supported by String.c_unescape()
See https://github.com/godotengine/godot/issues/38716.

(cherry picked from commit 04b25108ac)
2020-07-24 10:31:57 +02:00
Hugo Locurcio
11bceb3d62 Document caveats related to Control scaling
This is a common topic of confusion. Clarifying its intended scope
should make things easier to understand.

(cherry picked from commit a36912b3cb)
2020-07-24 10:31:56 +02:00
Aaron Franke
3ab5183ffa
[3.2] Backport core documentation changes to 3.2
Also add AABB.abs()
2020-07-21 21:22:54 -04:00
Rémi Verschelde
7b4b83e9dc
Merge pull request #39817 from yrk06/ExposeInertiaTensor
Added Rigid Body Method "get_inverse_inertia_tensor"
2020-07-21 16:50:56 +02:00
Pedro J. Estébanez
06904ac215 Add DynamicFont::get_available_chars() 2020-07-20 17:45:04 +02:00
Yerik
d09b16512b Added Method get_inverse_inertia_tensor 2020-07-19 13:51:32 -03:00
PouleyKetchoupp
c0b394572f Fix Return key events in LineEdit & TextEdit on Android
Depending on the device implementation, editor actions could be
received with different action ids or not at all for multi-line.

Added a parameter to virtual keyboards to properly handle single-line
and multi-line cases in all situations.

Single-line:
Input type set to text without multiline to make sure actions are sent.
IME options are set to DONE action to force action id consistency.

Multi-line:
Input type set to text and multiline to make sure enter triggers new lines.
Actions are disabled by the multiline flag, so '\n' characters are
handled in text changed callbacks.
2020-07-17 18:25:40 +02:00
Rémi Verschelde
2244841729 doc: Sync classref with current source 2020-07-15 12:56:16 +02:00
Hugo Locurcio
e41ab634c6 Mention C# gotchas in Object's dynamic call/set/connect methods
This closes #34015.

(cherry picked from commit 878f03d8e3)
2020-07-15 12:48:18 +02:00
Hugo Locurcio
f7021e57d7 Document VehicleBody3D and VehicleWheel3D limitations
These classes have dozens of open bugs and missing features
which may not be fixed anytime soon.

It's probably better to document it upfront at this point.

(cherry picked from commit 0493e7c106)
2020-07-15 12:48:18 +02:00
Fabio Alessandrelli
91b2d020a8 Document updated UDPServer interface.
(cherry picked from commit 839c7b1ba3)
2020-07-15 12:48:18 +02:00
Rémi Verschelde
3de89f78e5
Merge pull request #40265 from Calinou/doc-node-clarify-add-child-below-node
Clarify the node parameters in `Node.add_child_below_node()` docs
2020-07-14 09:41:57 +02:00
Hugo Locurcio
fb736018c5
Clarify the node parameters in Node.add_child_below_node() docs
This closes https://github.com/godotengine/godot-docs/issues/3769.
2020-07-11 12:23:41 +02:00
Tomasz Chabora
15850687a8 Allow Area2D and 3D mouse events without a collision layer
Co-authored-by:    Tomasz Chabora <kobewi4e@gmail.com>
2020-07-11 11:14:12 +01:00
Hugo Locurcio
c2a4ce9380 Enable file logging by default on desktops to help with troubleshooting
- Use the `.log` file extension (recognized on Windows out of the box)
  to better hint that generated files are logs. Some editors provide
  dedicated syntax highlighting for those files.
- Use an underscore to separate the basename from the date and
  the date from the time in log filenames. This makes the filename
  easier to read.
- Keep only 5 log files by default to decrease disk usage in case
  messages are spammed.

(cherry picked from commit 20af28ec06)
2020-07-10 11:03:32 +02:00
Nathan Franke
ec787f0134 Follow-Up Fix Directory Open
(cherry picked from commit 6952458538)
2020-07-10 10:21:39 +02:00
Hugo Locurcio
4a0fe1adb3 Add a POST request example to the HTTPRequest class documentation
(cherry picked from commit 54db59be67)
2020-07-10 10:09:01 +02:00
Bob Gardner
8f0d50c3ec Update Resource.xml to explain behavior of duplicate when subresources is true and a subresource contains further nested resources.
Updated documentation for duplicate() on Resource to better explain the behavior. As per #30385.

(cherry picked from commit 660a780c3b)
2020-07-10 09:00:02 +02:00
Hugo Locurcio
6eb1a2eacb Document how to instance a PackedScene and add it as a child
This information was already present in `@GDScript.preload()`,
but it's not easy to find.

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

(cherry picked from commit 23d929d540)
2020-07-10 08:51:21 +02:00
Hugo Locurcio
81f448aa5d Mention SceneTree.create_timer() in the Timer class documentation
This closes https://github.com/godotengine/godot-docs/issues/2349
(as the linked method already contains an example).

(cherry picked from commit 1261f47c35)
2020-07-10 08:51:21 +02:00
bruvzg
e9ab41b71d
[macOS, 3.2] Implement seamless display scaling. 2020-07-07 22:54:33 +03:00
Rémi Verschelde
07b24de868
Merge pull request #38724 from madmiraal/fix-8368-3.2
[3.2] Support SDL2 half axes and inverted axes mappings.
2020-07-06 23:10:47 +02:00
Yuri Sizov
2b4773f0cf Expose methods to play scene from plugin code
(cherry picked from commit 49f6dc5004)
2020-07-06 19:00:56 +02:00
Rémi Verschelde
1f886d1f31
Merge pull request #39867 from clayjohn/Sprite3D-mesh
Use mesh instead of immediate for drawing Sprite3D
2020-07-06 16:36:27 +02:00
Rémi Verschelde
fcce1ca8c4 doc: Sync classref with current source 2020-07-06 14:32:13 +02:00
Hugo Locurcio
d4f4e0d7dc Fix String.capitalize() description to follow camelCase changes
This closes #40093.

(cherry picked from commit 887099680a)
2020-07-06 14:16:49 +02:00
Slooth
d4d57476ad Add documentation for minimap_draw and minimap_width
(cherry picked from commit df8f0e6215)
2020-07-06 14:14:23 +02:00
clayjohn
6c0ff26f35 Use mesh instead of immediate for drawing Sprite3D 2020-07-03 12:19:26 -06:00
Slooth
c29da0e2fe Update TextEdit select and select_all methods
(cherry picked from commit b2471edf45)
2020-07-03 15:37:58 +02:00
Slooth
62677d7da1 Add documentation for selecting_enabled
(cherry picked from commit bc1ea1cbad)
2020-07-03 15:37:58 +02:00
Slooth
a8d499723f Add documentation for center_viewport_to_cursor method
(cherry picked from commit 654d33866b)
2020-07-03 15:34:30 +02:00
Slooth
aacbdebda3 Add documentation for shortcut_keys_enabled
(cherry picked from commit d838282191)
2020-07-03 15:34:30 +02:00
Aaron Franke
3fd7c33f39 Fix incorrect documentation for Vector2.angle()
(cherry picked from commit 299c3ec1c1)
2020-07-03 15:34:30 +02:00
Andrii Doroshenko (Xrayez)
f50c88ba7b Clarify Geometry.offset_polygon_2d regarding vertices translation
The method is used to either inflate or deflate a polygon.
For translating/transforming a polygon, use `Transform2D.xform`.

(cherry picked from commit 19b72da35d)
2020-07-03 13:17:57 +02:00