Commit Graph

2985 Commits

Author SHA1 Message Date
Marcus Brummer d3d34dc73b
Fixed Geometry2D::get_closest_points_between_segments docs
(cherry picked from commit 56e5ca38d7)
2020-12-29 16:01:59 +01:00
Rémi Verschelde 1a64f5d2ec
ProximityGroup: Fix access modifiers, rename private methods for clarity
See #36285 which mistakenly added documentation for the whole C++ API, while
some of it is meant to be and stay private as it's not exposed to scripts.
The access modifiers and method prefix were not used properly.

Cleanup code, and rename wrong `group_name` parameters to `method`, as it's a
method name which is being broadcast.

This is a very old class from pre-open source days, chances are that it was
just forgotten and not meant to be kept as is and undocumented.

(cherry picked from commit 79ba70f7ee)
2020-12-29 16:01:58 +01:00
Rémi Verschelde a4d25a115e
Merge pull request #44460 from theogen-ratkin/3.2
[3.2] Add interpolation parameter to resize_to_po2()
2020-12-19 09:36:01 +01:00
Theogen Ratkin 8f6a6ac8d0 Add interpolation parameter to resize_to_po2()
Image::resize_to_po2() now takes an optional p_interpolation parameter
that it passes directly to resize() with default value INTERPOLATE_BILINEAR.

GLES2: call resize_to_po2() with interpolate argument

Call resize_to_po2() in GLES2 rasterizer storage with either
INTERPOLATE_BILINEAR or INTERPOLATE_NEAREST depending on TEXTURE_FLAG_FILTER.

This avoids filtering issues with non power of two pixel art textures.
See #44379
2020-12-18 14:02:38 -04:00
Yuri Sizov 816fef21f9 Add a minimap to the GraphEdit 2020-12-18 01:31:17 +03:00
Rémi Verschelde 9710a38637
Merge pull request #44435 from Calinou/fix-max-renderable-elements-hint
Fix invalid property hint for `max_renderable_elements` project setting
2020-12-16 21:59:29 +01:00
Hugo Locurcio 680312b95a
Fix invalid property hint for `max_renderable_elements` project setting
This closes #36240.
2020-12-16 19:33:15 +01:00
skyace65 04926adb8a [3.2] Document what can be used as a type hint 2020-12-15 22:34:25 -05:00
Marcel Admiraal 825ad65fc4 Remove Generic6DOFJoint precision property 2020-12-15 10:15:42 +00:00
Hugo Locurcio 9c234abdc9
Document the argument count limit in `SceneTree.call_group()`
This limitation should be lifted in 4.0 thanks to the new method
binding system, but it's still present in 3.2.x.
2020-12-15 00:53:40 +01:00
Hugo Locurcio f2b04e8865
Document that changing the particle amount resets emission
See #16352.
2020-12-11 15:38:55 +01:00
Rémi Verschelde 0c7a9bd283
doc: Sync classref with current source
And fix broken doctool after #43948.
2020-12-10 14:22:31 +01:00
volzhs c904cf612a
Add option to draw all tabs in front
(cherry picked from commit 814f9015f8)
2020-12-10 13:07:49 +01:00
Michael Alexsander 32da9dc1e9
Add "font_color_separator" theme property to 'PopupMenu'
(cherry picked from commit 383e8919e0)
2020-12-10 13:06:15 +01:00
Tomasz Chabora 99a6cf77dd
Mention that 'changed' signal needs manual emit
(cherry picked from commit b552c26c68)
2020-12-10 13:03:25 +01:00
Hugo Locurcio b1919a3ed0
Document the lack of localization remapping support in VideoPlayer
See #43917.

(cherry picked from commit 1636fb8856)
2020-12-10 13:03:05 +01:00
Danil Alexeev 6c3a0e3a5a
Several edits to the GDScript docs
(cherry picked from commit bf96056ad0)
2020-12-09 11:22:03 +01:00
Hugo Locurcio eda04c6b6c
Fix incorrect `Curve3D.interpolate_baked()` description
The offset is in 3D units, not pixels.

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

(cherry picked from commit 5a9600cd24)
2020-12-02 16:03:06 +01:00
Jummit deda90bad7
add root_node as property of MultiplayerAPI
(cherry picked from commit d4c4d2db4c)
2020-12-01 09:00:54 +01:00
Hugo Locurcio d8c90f5f1e
Improve the `ProjectSettings.globalize_path()` documentation
This closes https://github.com/godotengine/godot-docs/issues/4409.

(cherry picked from commit f415db5b75)
2020-12-01 09:00:52 +01:00
Rémi Verschelde dbb69f8f49
doc: Mention iOS support for Input gravity/gyroscope sensors
It has been implemented for iOS a long time ago already with #7127.

(cherry picked from commit 2d0fda3ca2)
2020-12-01 09:00:48 +01:00
Marcel Admiraal 2e99b5b137 Fix cast_motion sometimes failing
- Fixes Godot physics failing when the cast Shape is inside of, or
already colliding with another Shape.
- Fixes Bullet physics failing when there is no motion.
- Ensures Godot and Bullet physics behave the same.
- Updates the documentation to exclude the caveats for the failures and
differences.
2020-11-27 15:32:25 +00:00
jfons bdc6f2fd95
Fix binding of default value in EditorSpatialGizmoPlugin::get_material()
It was commented for some reason I can't remember.

(cherry picked from commit e6949dae72)
2020-11-26 09:38:47 +01:00
Hugo Locurcio 9706b78a3f
Document C# garbage collection caveats in Reference and Resource
(cherry picked from commit 0565c76e8b)
2020-11-26 09:38:47 +01:00
Hugo Locurcio b2b5d9a7a3
Improve the AudioStreamPlayer3D class documentation
(cherry picked from commit 95618e2937)
2020-11-26 09:38:47 +01:00
Rémi Verschelde ac8dedd532
doc: Warn about using Node internal processing
See #43689.

Also 'fixed' some spelling for behavior in publicly visible strings.
(Sorry en_GB, en_CA, en_AU, and more... Silicon Valley won the tech spelling
war.)

(cherry picked from commit a655de89e3)
2020-11-26 09:38:45 +01:00
Hugo Locurcio 8adaf603d1
Update the number of lights supported in OmniLight and SpotLight docs
Follow-up to #43606.
2020-11-20 14:07:33 +01:00
Phischermen 776faa5c92
Clarify that SceneTree::quit() does not immediately end the application.
(cherry picked from commit 371d12a2f0)
2020-11-19 17:15:27 +01:00
Andrii Doroshenko (Xrayez) 2edd489f83 Describe `ImageTexture`, `Image` creation and usage
Ported from commit 0ee88d6705.
2020-11-17 18:06:52 +02:00
Rémi Verschelde d099b6cf60
Merge pull request #43606 from NHodgesVFX/3.2
Make lights_per_object configurable
2020-11-17 16:20:38 +01:00
Unknown 5965fbd9fa Make lights_per_object configurable 2020-11-17 10:03:44 -05:00
Rémi Verschelde fc718d87a6
doc: Add description for rendering/quality/2d/use_transform_snap
Co-authored-by: lawnjelly <lawnjelly@gmail.com>
2020-11-17 12:23:58 +01:00
Ryan Roden-Corrent 07c8e25078
Clarify Curve3D.get_point_{in,out} position in doc.
I verified this experimentally. I added a point at roughly (1,0,0), and
dragged a handle back to the origin. The result was:

```
get_point_position: (0.991079, 0, -0.000069)
get_point_in: (0.993409, 0, 0)
get_point_out: (-0.993409, 0, 0)
```

(cherry picked from commit c6093ae612)
2020-11-17 12:07:02 +01:00
Tomasz Chabora 17af75953f
Correct the doc about Tree.get_edited
(cherry picked from commit b8145c182b)
2020-11-17 12:07:02 +01:00
Hugo Locurcio e53a5f6be5
Improve the Dictionary class documentation
- Mention Lua-style syntax.
- Make the code samples self-contained.
- Mention caveat with `const` (also in Array).
- Clarify the description of `size()`.

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

(cherry picked from commit 5325de4e6b)
2020-11-17 12:07:02 +01:00
Hugo Locurcio 92f81ff782
Clarify packet peer `max_buffer_po2` in ProjectSettings documentation
This closes https://github.com/godotengine/godot-docs/issues/4364.

(cherry picked from commit c475b1fd0b)
2020-11-17 12:07:02 +01:00
Feniks c58b5c5df4
Changed mouse cursor to the caret (text cursor) location.
(cherry picked from commit 59ed3c1aaf)
2020-11-17 12:01:58 +01:00
Wilson E. Alvarez aa6406874e
Document InstancePlaceholder.create_instance not being thread-safe.
(cherry picked from commit a6f3ef3ac7)
2020-11-17 12:01:58 +01:00
HaSa1002 18d65673af
Docs: MeshDataTool: showcase tool in code example
(cherry picked from commit 4f9b993423)
2020-11-17 12:01:58 +01:00
Rémi Verschelde fc5b106369
Merge pull request #42168 from madmiraal/fix-42108-3.2
[3.2]  Remove the unnecessary sync() and the restrictions it imposes on 3D Physics.
2020-11-16 09:33:17 +01:00
Aaron Franke 9c83b8ed70
[3.2] Improve comments in Color documentation 2020-11-14 04:56:18 -05:00
Rémi Verschelde a57b6eb211
doc: Sync classref with current source
Move EditorSceneImporterFBX doc to its module folder.
2020-11-11 17:00:41 +01:00
PouleyKetchoupp 9b64646bc3
Expose LineEdit scroll offset to scripts
(cherry picked from commit 4775db1600)
2020-11-11 15:44:18 +01:00
Tomasz Chabora 98774000e2
Add append_array() method to Array class
(cherry picked from commit 9f23a94b8a)
2020-11-11 15:44:14 +01:00
Tomasz Chabora dc05beca80
Register methods for drawing 3D editor overlays
(cherry picked from commit cbfbb4538b)
2020-11-11 15:30:57 +01:00
Tomasz Chabora da2ac44d77
Add docs for editor viewport drawing methods
(cherry picked from commit 5d8b60ac3d)
2020-11-11 15:30:57 +01:00
Rémi Verschelde 2652f6fc69
doc: Override default value for RandomNumberGenerator.seed
It's non-deterministic so it's better to show a fixed value like 0 instead of
having it potentially change whenever `randomize()` is called.

Fixes #43317.

(cherry picked from commit 35e6070a35)
2020-11-11 15:30:56 +01:00
Ryan Roden-Corrent b472d5366c
Fix typo in Tabs doc.
I don't know enough about grammar to say why the "ing" suffix is
correct, but I'm reasonably sure it is :)

(cherry picked from commit 3826f3348f)
2020-11-11 15:30:56 +01:00
Rémi Verschelde 05143ca39a
Tooltips: Improve code clarity and docs
The return type for `_make_custom_tooltip` is clarified as Control, and users
should make sure to return a visible node for proper size calculations.

Moreover in the current master branch, a PopupPanel will be added as parent
to the provided tooltip to make it a sub-window.

Clarifies documentation for `Control._make_custom_tooltip`, and shows how to
use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types
to style tooltips.

Fixes #39677.

(cherry picked from commit c5d8dafec4)
2020-11-11 15:30:56 +01:00
Hugo Locurcio de96b29c58
Correct documentation about NinePatchRect stretch modes
This closes https://github.com/godotengine/godot-docs/issues/4333.

(cherry picked from commit 82bfb6273b)
2020-11-11 15:30:56 +01:00
Hugo Locurcio 10b1987fda
Fix a variable being redeclared in the HTTPRequest code sample
(cherry picked from commit d7025c4167)
2020-11-11 15:30:56 +01:00
SirQuartz 7dd5de5a57
Clarify what the "item_rect_changed" signal does
(cherry picked from commit 120ef02ca3)
2020-11-11 15:30:55 +01:00
Hugo Locurcio 7db872b55a
Add `Image.load_bmp_from_buffer()` for run-time BMP image loading
This partially addresses
https://github.com/godotengine/godot-proposals/issues/676.

(cherry picked from commit 0209e3790e)
2020-11-11 15:30:55 +01:00
Hugo Locurcio 2c6b3074fc
Increase the default HTTPClient download chunk size to 64 KiB
This improves download speeds at the cost of increased memory usage.

This change also effects HTTPRequest automatically.

See #32807 and #33862.

(cherry picked from commit 13357095ee)
2020-11-11 15:30:55 +01:00
Hugo Locurcio b682df5653
Document the supported TLS versions in HTTPRequest
See #42857.

(cherry picked from commit 0ebbc7602c)
2020-11-11 15:30:55 +01:00
Hugo Locurcio fb4b800507
Document how to interrupt `PacketPeerUDP.wait()`
This closes #36335.

(cherry picked from commit 25777488fd)
2020-11-11 15:30:54 +01:00
Hugo Locurcio b62b71e140
Improve the documentation related to fullscreen and borderless settings
(cherry picked from commit a1f81a52df)
2020-11-11 15:12:01 +01:00
Enhex 7ec83ccb9f
Fix missing quote in documentation
(cherry picked from commit aaf5a58b44)
2020-11-11 15:12:01 +01:00
Hugo Locurcio fab38f7cf1
Document AtlasTexture not supporting repetition
See #5660.
2020-11-02 18:29:27 +01:00
unknown 8d409423f7 Added a note to ImmediateGeometry regarding it's buffer limit 2020-10-30 16:43:48 +05:30
Rémi Verschelde c43b2ab603
Merge pull request #42942 from Calinou/add-viewport-debanding-3.2
Add a debanding property to Viewport for GLES3
2020-10-30 11:47:57 +01:00
Hugo Locurcio 7746afec94
Document hiding a Control when its reference point is behind the camera
See https://github.com/godotengine/godot/issues/1725.

(cherry picked from commit b3a6937c0c)
2020-10-28 14:05:42 +01:00
Dustin Petersohn a7609d9c49
Improved documentation for TileMap.cell_y_sort
(cherry picked from commit 669f21d367)
2020-10-28 14:05:42 +01:00
Andrii Doroshenko (Xrayez) 921046c822
Add `border_width` to `ReferenceRect`
Exposes a hidden parameter behind `CanvasItem.draw_rect()`.

(cherry picked from commit aef00021a9)
2020-10-28 14:05:40 +01:00
Andrii Doroshenko (Xrayez) bdfa43ea63
Cross-reference `ColorRect` and `ReferenceRect` in the class reference
They use the same underlying `CanvasItem.draw_rect()` API.

(cherry picked from commit 803b046b38)
2020-10-28 14:05:40 +01:00
Hugo Locurcio a5f98e915c
Document how to display the vertex color in `SurfaceTool.add_color()`
This closes https://github.com/godotengine/godot-docs/issues/4083.

(cherry picked from commit 2f1d40367a)
2020-10-28 14:05:39 +01:00
Rémi Verschelde 2e073ecbea
Merge pull request #42927 from lawnjelly/octree_default
Change render octree balance default
2020-10-21 10:19:34 +02:00
Hugo Locurcio 2dbc329704
Add a debanding property to Viewport for GLES3
It can be enabled in the Project Settings
(`rendering/quality/filters/use_debanding`). It's disabled
by default as it has a small performance impact and can make
PNG screenshots much larger (due to how dithering works).

As a result, it should be enabled only when banding is noticeable enough.

Since debanding requires a HDR viewport to work, it's only supported
in the GLES3 backend.
2020-10-20 19:07:15 +02:00
Rémi Verschelde 150f9ce807
Merge pull request #42009 from Calinou/theme-node-type-3.2
Rename the `type` parameter to `node_type` in Theme and Control (3.2)
2020-10-20 15:58:41 +02:00
Hugo Locurcio af45c97652
Add fast approximate antialiasing (FXAA) to Viewport
This backports FXAA from the `master` branch.

Co-authored-by: Clay John <claynjohn@gmail.com>
2020-10-20 14:54:52 +02:00
Rémi Verschelde 04fb41a0f3
Merge pull request #42531 from BastiaanOlij/add_get_native_handle
Add get native handle
2020-10-20 13:27:07 +02:00
Bastiaan Olij 1ea7358405 Add get_native_handle to OS 2020-10-20 20:23:37 +11:00
lawnjelly 10cdfda894 Change render octree balance default
Another bug in the octree has been discovered which can cause flickering in rare circumstances : #42895

For safety until this is fixed properly this PR reverts the default state of the octree to match the old behaviour, which doesn't appear exhibit the bug (or at least not as readily).
2020-10-20 08:49:52 +01:00
Rémi Verschelde a239894827
Merge pull request #42902 from akien-mga/3.2-cherrypicks
Cherry-picks for the 3.2 branch (future 3.2.4) - 5th batch
2020-10-19 22:14:05 +02:00
Juan Linietsky 388ebfb498
Merge pull request #41629 from JFonS/disable_baked_lights
Disable lights for objects with baked lighting
2020-10-19 14:12:50 -03:00
Rémi Verschelde 311bdbc16c
doc: Sync classref with current source 2020-10-19 17:13:30 +02:00
Rémi Verschelde 4028414e0e
Revert "Made toplevel a property for Node3D and CanvasItem"
This reverts commit a726d011d5.
2020-10-19 16:58:56 +02:00
Rémi Verschelde 4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Aaron Franke 069ed4ec63
Link to demos from within the class reference
(cherry picked from commit 439be614f4)
2020-10-19 16:10:01 +02:00
Tomasz Chabora d9bd61508b
Document that setting node name will remove @s
(cherry picked from commit 02ce2f4bb9)
2020-10-19 16:10:01 +02:00
Hugo Locurcio 8c6a5b06a2
Clarify that `MultiMesh.set_instance_color()` multiplies vertex colors
This closes https://github.com/godotengine/godot-docs/issues/4273.

(cherry picked from commit 6975bd106a)
2020-10-19 16:10:01 +02:00
Hugo Locurcio 8d445f3f9f
Link the Random number generation tutorial in the class reference
(cherry picked from commit 802c1e4df1)
2020-10-19 16:10:00 +02:00
Charles Merriam 1a25a301db
Fix typo in the ProjectSettings class documentation
(cherry picked from commit 5160a9f650)
2020-10-19 16:09:58 +02:00
Sniff 13e128b934
Docs change: More detailed description of StreamPeerTCP.is_connected_to_host()
(cherry picked from commit 7970e4a433)
2020-10-19 16:09:58 +02:00
Tomasz Chabora f7ea1e6b38
Correct the doc about linear damping
(cherry picked from commit ebca7d4e4e)
2020-10-19 16:09:58 +02:00
Umang Kalra 9ec70c54ab
Explaining the behavior of focus & pressed stylebox overlap
(cherry picked from commit 10a7eddc5e)
2020-10-19 16:09:58 +02:00
Rémi Verschelde 123942f61f
Merge pull request #42119 from lawnjelly/ewok3
Unified GLES3 / GLES2 Batching
2020-10-19 15:01:10 +02:00
Rémi Verschelde 3495cb91d8
Merge pull request #41577 from FIF15/deprecate-redundant-property-enabled-focus-mode
Deprecate Redundant property enabled_focus_mode
2020-10-19 14:15:43 +02:00
Marcel Admiraal b7d00a364e Set Bullet collision shape index to zero when using a single shape
or ConcavePolygonShape.
2020-10-19 11:50:29 +01:00
lawnjelly c2290dbedd Unified GLES2 / GLES3 Batching
Batching is mostly separated into a common template which can be used with multiple backends (GLES2 and GLES3 here). Only necessary specifics are in the backend files.

Batching is extended to cover more primitives.
2020-10-16 10:34:47 +01:00
FIF15 8311a37ed9 Deprecate Redundant property enabled_focus_mode
of BaseButton
see #41529 for details
this closes #41529
2020-10-16 14:14:04 +08:00
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