Commit graph

2944 commits

Author SHA1 Message Date
Hugo Locurcio
009bf148b3
Document OmniLight/SpotLight rendering limitations 2020-10-15 22:14:08 +02:00
JFonS
fcb00ca048 Disable lights for objects with baked lighting
Don't apply lighting to objects when they have a lightmap texture and
the light is set to BAKE_ALL. This prevents applying the same direct
light twice on the same object and makes setting up scenes with mixed
lighting much easier.
2020-10-11 20:41:40 +02:00
PouleyKetchoupp
f9544716f4 Option for software skinning in MeshInstance
Option in MeshInstance to enable software skinning, in order to test
against the current USE_SKELETON_SOFTWARE path which causes problems
with bad performance.

Co-authored-by: lawnjelly <lawnjelly@gmail.com>
2020-10-08 16:14:55 +02:00
Marcel Admiraal
5d548d12aa
Remove reference to 3D shapes in RigidBody2D.xml contacts description.
(cherry picked from commit e7edbcedc9)
2020-10-04 20:54:16 +02:00
Anant Ahuja
55d756cbab
Updated NinePatchRect's patch margin descriptions
(cherry picked from commit 00d9432f44)
2020-10-04 20:53:31 +02:00
Andrii Doroshenko (Xrayez)
1a71792655
Cross-reference GDScript load and ResourceLoader.load in classref
The GDScript `load` mention is moved from the class `ResourceLoader`
description to the `ResourceLoader.load` method description instead,
where it is more likely to be found.

(cherry picked from commit a8404cf56c)
2020-10-04 20:51:40 +02:00
Ryan Roden-Corrent
d05a07235c
Fix bound return type on get_priority.
Also adds a description explaining gizmo priority.

Inferred from:
e4363d001a/editor/plugins/spatial_editor_plugin.cpp (L5867-L5880)
e4363d001a/editor/plugins/spatial_editor_plugin.cpp (L6462-L6470)

(cherry picked from commit c6919a13da)
2020-10-04 20:51:19 +02:00
lolligerjoj
0586c856f6
Expose Animation::value_track_interpolate to GDscript
(cherry picked from commit ff4af94414)
2020-10-04 20:50:34 +02:00
Rémi Verschelde
e35687a116
Merge pull request #42478 from bruvzg/macos_dpi_32
[3.2] Fix `get_screen_dpi` on macOS.
2020-10-01 23:03:28 +02:00
bruvzg
610728c9f1
[3.2] Fix get_screen_dpi on macOS for non fractional display scales and update documentation. 2020-10-01 22:55:54 +03:00
Ryan Roden-Corrent
35d58c4435
Clarify store_string vs store_line.
While the behavior can be implied from the name, it seems worth stating
it explicitly.

(cherry picked from commit 2762821c08)
2020-10-01 16:00:47 +02:00
Duroxxigar
a726d011d5
Made toplevel a property for Node3D and CanvasItem
(cherry picked from commit 85a8dbb7b6)
2020-10-01 16:00:47 +02:00
Hugo Locurcio
016ea497eb
Improve the String.is_valid_ip_address() documentation
This closes https://github.com/godotengine/godot-docs/issues/4097.

(cherry picked from commit 00ade39389)
2020-10-01 16:00:47 +02:00
Hugo Locurcio
867b0d57d6
Improve the String comparison methods' documentation
This closes https://github.com/godotengine/godot-docs/issues/4096.

(cherry picked from commit a2271ba3bd)
2020-10-01 16:00:47 +02:00
Wilson E. Alvarez
5766547e33
Make "function" a property of FuncRef
(cherry picked from commit b4e7edabf3)
2020-10-01 16:00:47 +02:00
Rémi Verschelde
4ad74609ce
Merge pull request #40205 from bruvzg/click-through-3
[3.2] Add mouse event pass-through support for window.
2020-10-01 13:58:24 +02:00
Rémi Verschelde
ef223f3aa7
Merge pull request #41185 from Chaosus/vs_uniform_ref_3.2
[3.2] Added UniformRef visual shader node
2020-10-01 13:50:08 +02:00
Sergey Minakov
42de81e235 iOS: move touch delay to settings 2020-10-01 12:36:57 +03:00
Rémi Verschelde
66cbcc1b7e
Merge pull request #41123 from lawnjelly/octree_fix
Optimize octree and fix leak
2020-09-30 23:11:31 +02:00
Rémi Verschelde
aaf0b32e91
doc: Sync classref with current source 2020-09-29 13:57:58 +02:00
follower
0d8cbd5d8c
Doc clarity/detail for extra spacing properties
Re: Space spacing being in addition to character spacing see:

 * <d7b85fbaa1/scene/resources/dynamic_font.cpp (L858-L859)>

Re: Value being able to be negative see example here:

 * <https://github.com/godotengine/godot/issues/38630>

But also note that nodes other than `Label` may not currently render extra space spacing correctly.

(cherry picked from commit 2ef89e0b43)
2020-09-29 13:57:58 +02:00
Megamega53
6bfaa8a8c9
doc: Some improvements to KinematicBody docs
Co-authored-by: Marcel Admiraal <madmiraal@users.noreply.github.com>
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit ca5ae64525)
2020-09-29 13:57:58 +02:00
Justin Lee
52b3324e58
doc: Improve distance_fade documentation
Changed the documentation of distance_fade_max_distance and min
to be consistent with the behavior of the code as well as the user
documentation. Also noted the behavior of swapping max_distance and
min_distance (where max_distance < min_distance).

Fixes #36051.

Co-authored-by: Clay John <claynjohn@gmail.com>
(cherry picked from commit 90d1eda90e)
2020-09-29 13:57:58 +02:00
andriyDev
98eb6e4af6
Added inspector_only option to inspect_object in EditorInterface.
Updated docs to reflect change to inspect_object.

(cherry picked from commit 45a1c6f278)
2020-09-29 13:57:57 +02:00
Hugo Locurcio
00e4be1926
Document the BaseMaterial3D billboard mode not being suited for VR
See #41567.

(cherry picked from commit ecc47ce235)
2020-09-29 13:57:57 +02:00
Haoyu Qiu
9bf09a909b
Surrounds boolean false with code tag
(cherry picked from commit aa7ce12bee)
2020-09-29 13:57:56 +02:00
skyace65
a2c4564dc3
Move note about using Resource in the File documentation
(cherry picked from commit 75c5a8b354)
2020-09-29 08:54:45 +02:00
skyace65
1257beac96
Add documentation for shelf filters
(cherry picked from commit 75adefd4b6)
2020-09-29 08:54:44 +02:00
Hugo Locurcio
28be48fb67
Reference the Color constants cheatsheet in the class reference
(cherry picked from commit de49085567)
2020-09-29 08:54:44 +02:00
Hugo Locurcio
c33373b80a
Reference the BaseButton class explicitly in button class documentations
Users are sometimes confused as to the `pressed` property not being
visible in the Button class documentation. This is because `pressed`
is defined in BaseButton.

(cherry picked from commit 038baede5a)
2020-09-24 14:43:12 +02:00
Hugo Locurcio
6036fdab70
Cross-reference AABB and Rect2 in the class reference
(cherry picked from commit e9eddb4f1f)
2020-09-24 14:43:12 +02:00
Hugo Locurcio
f568413e8d
Document RichTextLabel.append_bbcode() not closing previously open tags
This closes #42216.

(cherry picked from commit 3e1457f517)
2020-09-24 14:43:11 +02:00
Hugo Locurcio
575aa3efe3
Document that the JavaScript singleton may be disabled at build-time
(cherry picked from commit 0422027f07)
2020-09-24 14:43:11 +02:00
Leleat
27b09083fc
add description for ScriptEditor.open_script_create_dialog()
(cherry picked from commit adb205a150)
2020-09-24 14:43:11 +02:00
Hugo Locurcio
92a85b4445
Improve documentation about VideoPlayer video formats
This closes https://github.com/godotengine/godot-docs/issues/4021.

(cherry picked from commit 1efe57848a)
2020-09-24 14:43:11 +02:00
Michael Alexsander
2d848227cf
Add 'get_previous_tab()' to 'Tabs'
(cherry picked from commit 2b319889cb)
2020-09-24 14:43:10 +02:00
Jonathan Vice
96ca267209
Reorder sprite h_frames & v_frames
(cherry picked from commit 28326aec60)
2020-09-24 14:43:10 +02:00
Yilin Ma
d571de5f81
added load resource pack with offset feature
(cherry picked from commit c524d50444)
2020-09-24 14:43:09 +02:00
Hugo Locurcio
e07ac3d77e
Fix a typo in the Array class documentation
This closes https://github.com/godotengine/godot-docs/issues/4049.

(cherry picked from commit 603eddce86)
2020-09-24 14:43:07 +02:00
Somnath Sarkar
1f7a3e0f8d
Sort points in a Gradient for color and offset updates.
(cherry picked from commit d5d832417e)
2020-09-24 14:43:06 +02:00
Aaron Franke
76a8458753
Make the Import dock depend on the FileSystem dock
(cherry picked from commit de6f8f9d21)
2020-09-24 14:43:05 +02:00
Rémi Verschelde
c8859f0463
Fix typos with codespell
Using codespell 1.17.1.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
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
```
2020-09-18 14:09:51 +02:00
Marcel Admiraal
fc72c3fdf5 Remove the unnecessary sync() and the restrictions it imposes on 3D Physics. 2020-09-18 10:42:59 +01:00
bruvzg
e51fed9d1b
[3.2] Add window click-through support. 2020-09-17 12:36:01 +03:00
Hugo Locurcio
939de03db7
Cross-reference AABB getter methods in the documentation
This also clarifies that `get_aabb()` returns the AABB in local space.

See https://github.com/godotengine/godot/issues/42095.

(cherry picked from commit 9712f8fd2d)
2020-09-16 16:22:39 +02:00
Hugo Locurcio
369e5a7f35
Mark InterpolatedCamera as deprecated
InterpolatedCamera has already been removed from the `master` branch.
This adds a deprecation notice to inform people about the upcoming removal
in Godot 4.0.

Its functionality could be replicated in a GDScript add-on with relative
ease.
2020-09-16 15:36:40 +02:00
Rémi Verschelde
16eb7b95be
Merge pull request #42102 from Calinou/doc-animationtreeplayer-deprecation
Mention the AnimationTreePlayer deprecation in the class reference
2020-09-16 08:13:27 +02:00
Hugo Locurcio
868776949b
Mention the AnimationTreePlayer deprecation in the class reference
There's a node configuration warning already, but you can only
see it after adding the node to your scene.
2020-09-16 00:19:32 +02:00
Rémi Verschelde
3170ebc0e2
makerst: Add missing newline at EOF
(cherry picked from commit d435537f7e)
2020-09-15 19:26:44 +02:00
Hugo Locurcio
34a0af8343
Clarify that 2D cell sizes are defined in pixels
See https://github.com/godotengine/godot/issues/40577#issuecomment-662329021.

(cherry picked from commit f83249f224)
2020-09-15 19:26:43 +02:00
Danil Alexeev
06f3cd8bd8
Several documentation improvements
(cherry picked from commit a4c5790350)
2020-09-15 19:26:40 +02:00
Hugo Locurcio
738f6ea221
Document how to remove metadata from an Object
This closes https://github.com/godotengine/godot-docs/issues/4010.

(cherry picked from commit cba4d73b71)
2020-09-14 14:24:14 +02:00
Ebrahim Ebrahim
508dde662a
Clarify get_data Image method
(cherry picked from commit b9764b6109)
2020-09-14 11:00:50 +02:00
skyace65
de9a5b6229
Improve AudioEffectDistortion and AudioEffectFilter documentation
(cherry picked from commit 959f2287f6)
2020-09-14 11:00:49 +02:00
Hugo Locurcio
e36587751f
Rename the type parameter to node_type in Theme and Control
This makes it clearer that it expects a node type as a string (such as "Label")
instead of a type like "TYPE_ARRAY". This is backwards-compatible since only
the name of the parameter is changed, not its order.

See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 18:42:45 +02:00
Hugo Locurcio
74952764f3
Improve documentation related to Array error handling
This closes https://github.com/godotengine/godot-docs/issues/3834.

(cherry picked from commit 263f620421)
2020-09-10 12:04:07 +02:00
Hugo Locurcio
2bc6298bce
Document that batching is only effective when using the GLES2 renderer 2020-09-09 00:58:25 +02:00
Rémi Verschelde
4a9264271d
doc: Sync classref with current source 2020-09-08 14:20:53 +02:00
Hugo Locurcio
77a6766b3e
Clarify the required child node type in the GridContainer documentation
This closes #41822.

(cherry picked from commit 40b5331d79)
2020-09-08 08:56:13 +02:00
Hugo Locurcio
c040e8f93a Document missing character behavior when drawing text with fonts
See #40405.

(cherry picked from commit 7735d8d0ce)
2020-09-04 08:50:32 +02:00
Yetizone
e882d535a7 Mention Viewport.render_target_clear_mode property is intended for 2D usage 2020-09-03 07:57:01 +03:00
Hugo Locurcio
d773de6d24
Document how renaming the project affects the user data path
(cherry picked from commit 386f86cddf)
2020-09-01 21:02:19 +02:00
Hugo Locurcio
be126bfd55
Document RigidBodies in character mode never sleeping automatically
See #7996.

(cherry picked from commit 5fbf709ca2)
2020-09-01 21:01:58 +02:00
umarcor
b0a6439df9
doc/FileDialog: warn about access limitations in sandboxed apps
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit 1ddb0e56ac)
2020-09-01 21:01:32 +02:00
Hugo Locurcio
ef7675a053
Document support for normal and specular maps in AnimatedSprite2D
This closes #38509.

(cherry picked from commit 8d0099f5fc)
2020-09-01 21:00:58 +02:00
Hugo Locurcio
cc3b69cf7b
Reference the online documentation in collision layer/mask properties
See https://github.com/godotengine/godot-docs/pull/3863.

(cherry picked from commit c73c327bab)
2020-08-31 15:55:11 +02:00
Andreas Gustafsson
727bce727b
OptionButton.xml word order fix
Change word order of 'Emitted the when...' into 'Emitted when the...'

(cherry picked from commit 8f082d63c6)
2020-08-31 15:29:44 +02:00
Tomasz Chabora
57810f851c
Explain editor usage of current_animation
(cherry picked from commit 70ce86ad29)
2020-08-31 15:29:43 +02:00
Maganty Rushyendra
fdb5561e55
Updated cursor positioning description for File open()
Added more details about the cursor offsets for the different ModeFlags
in the `File` class.

(cherry picked from commit 5e77eea216)
2020-08-31 15:29:43 +02:00
Hugo Locurcio
1f7f28a1eb
Document HTTPRequest not supporting request data with GET method
This also improves the HTTPClient class documentation to be easier
to read and more informative.

This closes #40564.

(cherry picked from commit 2f577facc9)
2020-08-31 15:29:43 +02:00
Hugo Locurcio
6eee52e49b
Improve the documentation related to overriding GUI theme items
Overriding theme items is a common point of confusion.
Hopefully, these code samples should clear things up.

(cherry picked from commit 2a8bbda2a7)
2020-08-31 15:29:43 +02:00
skyace65
92a1c168ea
Clarify get_data texture method
(cherry picked from commit 635c9761a0)
2020-08-31 15:29:43 +02:00
Hugo Locurcio
dd057d36dc
Document the GDScript debugger not supporting Thread yet
See https://github.com/godotengine/godot/issues/2446.

(cherry picked from commit dec20883c1)
2020-08-31 15:29:42 +02:00
Hugo Locurcio
a23c0aca87
Clarify that KEY_BACK is unrelated to the Back button on Android
This closes #19325.

(cherry picked from commit 359c95156a)
2020-08-31 15:29:42 +02:00
skyace65
dea530d5ca
Add information to get thread id
(cherry picked from commit aa08023115)
2020-08-31 15:29:42 +02:00
skyace65
14e1c83350
Improve touch screen button description
(cherry picked from commit 416cac96fa)
2020-08-31 15:29:42 +02:00
skyace65
45e596e02f
Document where the center of mass is for RigidBody nodes
(cherry picked from commit 555f4f3e17)
2020-08-31 15:29:42 +02:00
Hugo Locurcio
96ad9dc4c6
Document supported platforms for Input.get_accelerometer() and related
This closes #41303.

(cherry picked from commit eee704e6f6)
2020-08-31 15:29:41 +02:00
skyace65
8466f9147b
Mention listener node in AudioStreamPlayer3D description
(cherry picked from commit 51367c1bcf)
2020-08-31 15:29:41 +02:00
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
lawnjelly
667c970b77 Optimize octree and fix octree leak
Prevents adding new octants until a limiting number of elements have been added to the current octant. This enables balancing the benefits of brute force against the benefits of spatial partitioning. The limit can be set per octree.

Project settings are added for rendering octree to set the best balance per project depending on number of tests per frame / tick, and the amount of editing of the octree.

Fixes octants being leaked when removing elements.

Optimize octree with cached linear lists

Storing elements in octants using linked lists is efficient for housekeeping but very slow for testing. This optimization stores additional local_vectors with Element pointers and AABBs which are cached and only updated when a dirty flag is set on the octant.

This is selectable with 2 versions of Octree : Octree and Octree_CL, Octree being the old behaviour. At present the cached list version is only used for the visual server octree (rendering) as it has only been demonstrated to be faster there so far.

This uses slightly more memory (probably a few kb in most cases) but can be significantly faster during testing (culling etc).

Co-authored-by: Sergey Minakov <naithar@icloud.com>
2020-08-18 11:02:21 +01: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
Yuri Roubinsky
d0c705781c [3.2] Added UniformRef visual shader node 2020-08-11 15:04:06 +03: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
Hugo Locurcio
8cc3d4bda6 Keep the bottom panel visible when enabling the distraction-free mode
- Document the `EditorInterface.distraction_free_mode` property.

This closes https://github.com/godotengine/godot-proposals/issues/951.

(cherry picked from commit e6352d1daa)
2020-06-29 10:46:05 +02:00
Marcel Admiraal
ebff150680 Support SDL2 half axes and inverted axes mappings. 2020-06-26 06:28:56 +01:00
Andreas Gustafsson
68c273fb09 Tween.xml word order fix
Change the word order of '...the where...' into '...where the...'.

(cherry picked from commit 5181daaf9e)
2020-06-24 22:52:05 +02:00
Meriipu
d2347bc4ec Clarify what a string being empty means
Should close https://github.com/godotengine/godot-docs/issues/2432

(cherry picked from commit 2643b8fa5e)
2020-06-24 22:52:05 +02:00
Dylan
198bd4cb0f Environment doc update regarding Viewport usage. 2020-06-22 17:59:44 -04:00
Rémi Verschelde
8fd861ab11 doc: Sync classref with current source 2020-06-22 13:24:11 +02:00
skyace65
0b1d9f9d88 Fix Joint2D doc
(cherry picked from commit a94ba7be59)
2020-06-22 08:37:57 +02:00
Hugo Locurcio
9889641bae Document how Vector2, Vector3 and Color behave in a boolean context
See #39731.

(cherry picked from commit 227f12478d)
2020-06-21 21:44:02 +02:00
Aaron Franke
d9beab34c5 Update bool documentation to be more clear
(cherry picked from commit 08577fab14)
2020-06-21 21:42:56 +02:00
Rémi Verschelde
8ac13e50cf Move Haiku platform port to external repository
The Haiku port now resides at:
https://github.com/godotengine/godot-haiku-platform

While we're happy to support as many Free and Open Source platforms as we can,
we need to put the main focus on the platforms that we can reasonably maintain,
and for Haiku we have been lacking maintainers ever since the port was first
merged in 2015.

The Haiku code has not been compiling and much less working at least since the
release of Godot 3.0, and while some attempts have been made at fixing things,
it's still not functional today in the `3.2` branch (and much less in `master`,
understandably).

Having it in an external repository should hopefully enable Haiku contributors
to fix issues in their own time, and possibly tag versions compatible with
past Godot releases once they are ready.

(cherry picked from commit efcc508ee5)
2020-06-21 21:42:26 +02:00
PouleyKetchoupp
b3af0b2a39 Option in RichTextLabel for height to fit content
(cherry picked from commit ad8081216c)
2020-06-19 16:17:27 +02:00
Ev1lbl0w
17c87d2ec1
Expose disable_render_loop property to GDScript 2020-06-18 11:59:29 +01:00
Rémi Verschelde
bf913d6917 DocData: Skip language-specific ClassDoc without methods/constants
Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.

(cherry picked from commit ba0db95909)
2020-06-18 11:29:28 +02:00
Vorblen
f46624030c Add description for "absorbent" and "rough"
(cherry picked from commit 8acdbaa4f2)
2020-06-18 11:29:28 +02:00
Andrii Doroshenko (Xrayez)
5084043373 Bind Shape2D draw method
(cherry picked from commit 430d1fd795)
2020-06-18 10:51:44 +02:00
dominiks
ff185f715a Add note about automatic window title to FileDialog documentation.
(cherry picked from commit d2250a2320)
2020-06-15 14:34:35 +02:00
Hugo Locurcio
4c289058ed Clarify Node virtual methdods not being called if node is orphan
This closes #39489.

(cherry picked from commit b2ba78ff0f)
2020-06-15 14:34:35 +02:00
31
1b58f94296 Fix Image.create_from_data use_mipmaps doc
The Image.create_from_data doc describes the "use_mipmaps" argument as a
way to generate mipmaps, but this method only allocates and loads data.
This can cause confusion, where this function reads more or less data
than expected. Update the doc to be more specific that create_from_data
is loading the mipmaps from the raw data.

(cherry picked from commit 09b324b5b6)
2020-06-15 14:34:35 +02:00
Hugo Locurcio
469c1b5f5e Document how to resize a SubViewportContainer to avoid stretching
This closes #27534.

(cherry picked from commit f818a99d0b)
2020-06-15 14:34:35 +02:00