Commit graph

3283 commits

Author SHA1 Message Date
Rémi Verschelde
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
HaSa1002
a3df26e554 Docs: Port Code Examples to C# (M, N, O, P, R)
Includes:
 * MarginContainer
 * NavigationPolygon
 * Node
 * NodePath
 * OS
 * PackedByteArray
 * PackedScene
 * PacketPeerUDP
 * PCKPacker
 * Performance
 * PhysicsShapeQueryParameters2D
 * PhysicsShapeQueryParameters3D
 * PrimitiveMesh
 * ProjectSettings

Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-09 10:05:53 +01:00
Rémi Verschelde
593e35346a
Merge pull request #42841 from HaSa1002/docs-lang-3
Port code examples to C# (D and E)
2020-11-09 08:29:44 +01:00
Tomasz Chabora
9f23a94b8a Add append_array() method to Array class 2020-11-08 21:09:45 +01:00
Rémi Verschelde
709964849f
Merge pull request #42896 from Calinou/httprequest-increase-chunk-size
Increase the default HTTPClient download chunk size to 64 KiB
2020-11-07 16:38:28 +01:00
Rémi Verschelde
329d2c1ced
Merge pull request #42947 from Calinou/image-load-bmp-from-buffer
Add `Image.load_bmp_from_buffer()` for run-time BMP image loading
2020-11-07 16:38:09 +01:00
Hugo Locurcio
13357095ee
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.
2020-11-07 16:11:04 +01:00
Tomasz Chabora
5d8b60ac3d Add docs for editor viewport drawing methods 2020-11-06 16:42:40 +01:00
Rémi Verschelde
a9bc440311
Merge pull request #41746 from Calinou/doc-projectsettings-fullscreen-borderless
Improve the documentation related to fullscreen and borderless settings
2020-11-06 14:34:22 +01:00
Rémi Verschelde
aba611b6fc
Merge pull request #42870 from Calinou/doc-httprequest-tls-version
Document the supported TLS versions in HTTPRequest
2020-11-06 14:32:45 +01:00
Rémi Verschelde
52c1b5fc41
Merge pull request #43283 from Calinou/color-remove-contrasted
Remove `Color.contrasted()` as its behavior is barely useful
2020-11-06 10:17:12 +01:00
Rémi Verschelde
35e6070a35
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.
2020-11-05 00:41:24 +01:00
Rémi Verschelde
424cd00f8b
doc: Sync classref with current source + fixup some bindings
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
Ryan Roden-Corrent
3826f3348f
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 :)
2020-11-03 18:26:48 -05:00
Hugo Locurcio
7adb6b91b3
Remove Color.contrasted() as its behavior is barely useful
Returning the most contrasting color isn't a trivial task, as there
are often many possible choices. It's usually best left for the user
to implement using a script.
2020-11-03 04:46:08 -05:00
Rémi Verschelde
c5d8dafec4
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.
2020-11-03 09:19:03 +01:00
Rémi Verschelde
873d461785
Merge pull request #40364 from marstaik/alpha2coverage_up
Alpha Hash and Alpha2Coverage Implementation
2020-11-03 07:50:49 +01:00
Marios Staikopoulos
e5d7c7d5fc Alpha Hash and Alpha2Coverage Implementation 2020-11-02 20:11:20 -08:00
Rémi Verschelde
e8794b24bd
Merge pull request #43260 from HaSa1002/mainloop-remove-deprecated-methods
MainLoop: Remove deprecated methods
2020-11-02 14:26:49 +01:00
Hugo Locurcio
82bfb6273b
Correct documentation about NinePatchRect stretch modes
This closes https://github.com/godotengine/godot-docs/issues/4333.
2020-11-01 18:41:10 +01:00
HaSa1002
f8ac4c4d75 MainLoop: Remove deprecated methods 2020-11-01 12:38:30 +01:00
HaSa1002
8fb113bb4c Port code examples to C# (D)
Includes:
 * Decal
 * Dictionary
 * Directory
 * DisplayServer
 * DTLSServer
 * DynamicFont
 * EditorImportPlugin
 * EditorPlugin
 * EditorScenePostImport
 * EditorScript
 * EditorSettings
 * EditorTranslationParserPlugin
 * Engine
 * Expression

Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-01 09:05:17 +01:00
Hugo Locurcio
d7025c4167
Fix a variable being redeclared in the HTTPRequest code sample 2020-10-31 19:20:18 +01:00
Rémi Verschelde
f6f38ac086
Merge pull request #42811 from Calinou/doc-packetpeerudp-wait-interrupt
Document how to interrupt `PacketPeerUDP.wait()`
2020-10-29 22:38:36 +01:00
SirQuartz
120ef02ca3 Clarify what the "item_rect_changed" signal does 2020-10-28 15:59:14 +01:00
Hugo Locurcio
a1f81a52df
Improve the documentation related to fullscreen and borderless settings 2020-10-28 14:30:33 +01:00
Hugo Locurcio
b3a6937c0c
Document hiding a Control when its reference point is behind the camera
See https://github.com/godotengine/godot/issues/1725.
2020-10-27 17:37:03 +01:00
Hugo Locurcio
c3b246e6af
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.
2020-10-27 14:58:52 +01:00
Dustin Petersohn
669f21d367 Improved documentation for TileMap.cell_y_sort 2020-10-27 00:30:14 +01:00
Andrii Doroshenko (Xrayez)
8ce2f401dd Fixup ColorRamp to Gradient renames 2020-10-25 18:32:44 +02:00
Aaron Franke
961ee3a1d7
Rename button group property to button_group 2020-10-24 01:30:18 -04:00
Rémi Verschelde
f0f8864c9c
Merge pull request #42907 from Xrayez/add-ref-rect-border-width
Add `border_width` to `ReferenceRect`
2020-10-22 15:58:12 +02:00
Hugo Locurcio
0209e3790e
Add Image.load_bmp_from_buffer() for run-time BMP image loading
This partially addresses
https://github.com/godotengine/godot-proposals/issues/676.
2020-10-20 23:52:45 +02:00
Andrii Doroshenko (Xrayez)
803b046b38 Cross-reference ColorRect and ReferenceRect in the class reference
They use the same underlying `CanvasItem.draw_rect()` API.
2020-10-20 13:59:41 +03:00
Andrii Doroshenko (Xrayez)
aef00021a9 Add border_width to ReferenceRect
Exposes a hidden parameter behind `CanvasItem.draw_rect()`.
2020-10-20 13:58:50 +03:00
Yuri Roubinsky
4f4287243c Removed underscore from GraphEdit begin/end_node_move signals 2020-10-20 09:22:40 +03:00
Hugo Locurcio
2f1d40367a
Document how to display the vertex color in SurfaceTool.add_color()
This closes https://github.com/godotengine/godot-docs/issues/4083.
2020-10-19 15:23:16 +02:00
Rémi Verschelde
6b20859984
Merge pull request #42558 from Chaosus/vs_curve
Added visual shader node to easy gather data from a CurveTexture
2020-10-19 14:58:45 +02:00
Rémi Verschelde
bc8300d201
Merge pull request #42579 from theoway/stylebox_and_control_documentation
Documentation change: Explaining the behavior of focus stylebox overlapping the pressed stylebox
2020-10-19 09:36:24 +02:00
Juan Linietsky
53d5a252bb
Revert "Replace SAO implementation with MSSAO" 2020-10-18 19:27:51 -03:00
Juan Linietsky
d98261ab8f
Merge pull request #42077 from clayjohn/MSSAO
Replace SAO implementation with MSSAO
2020-10-18 18:34:43 -03:00
Juan Linietsky
e799a2ba45
Merge pull request #42201 from clayjohn/Vulkan-new-glow
Optimize Glow with local memory
2020-10-18 18:32:36 -03:00
clayjohn
366ee46774 Replace SAO implementation with MSSAO 2020-10-18 13:15:51 -07:00
clayjohn
63a34b93aa Optimize Glow with local memory 2020-10-18 11:37:12 -07:00
Rémi Verschelde
d9e5c355e5
Merge pull request #41418 from clayjohn/Vulkan-aerial
Add aerial perspective to fixed fog
2020-10-18 17:32:19 +02:00
Yuri Roubinsky
f402e1e675 Added VisualShaderNodeCurve to easy gather data from a CurveTexture 2020-10-18 09:57:15 +03:00
clayjohn
8c21c26fb5 Add aerial perspective to fixed fog 2020-10-17 10:53:07 -07:00
Hugo Locurcio
0ebbc7602c
Document the supported TLS versions in HTTPRequest
See #42857.
2020-10-17 14:49:56 +02:00
Tomasz Chabora
02ce2f4bb9 Document that setting node name will remove @s 2020-10-17 12:13:54 +02:00
Rémi Verschelde
ea21b8ff83
Merge pull request #42823 from madmiraal/update-intersect_point-doc
Update intersect_point documentation to mention solid shapes.
2020-10-15 18:40:36 +02:00
Rémi Verschelde
14e3d68dd9
Merge pull request #42778 from madmiraal/remove-get_layers
Remove old RigidBody get_layers() methods.
2020-10-15 18:40:21 +02:00
Marcel Admiraal
e496db79d8 Update intersect_point documentation to mention solid shapes. 2020-10-15 16:44:57 +01:00
Hugo Locurcio
6975bd106a
Clarify that MultiMesh.set_instance_color() multiplies vertex colors
This closes https://github.com/godotengine/godot-docs/issues/4273.
2020-10-15 10:19:20 +02:00
Hugo Locurcio
25777488fd
Document how to interrupt PacketPeerUDP.wait()
This closes #36335.
2020-10-15 10:10:32 +02:00
Hugo Locurcio
802c1e4df1
Link the Random number generation tutorial in the class reference 2020-10-14 18:03:29 +02:00
Marcel Admiraal
a17fdaef09 Remove old RigidBody layers property and methods. 2020-10-13 16:59:49 +01:00
Rémi Verschelde
7baefe812a
Merge pull request #42604 from KoBeWi/da100mp
Correct the doc about linear damping
2020-10-13 11:53:01 +02:00
Tomasz Chabora
ebca7d4e4e Correct the doc about linear damping 2020-10-13 11:41:18 +02:00
Rémi Verschelde
5782b3355a
Merge pull request #41576 from FIF15/remove-redundant-property-enabled-focus-mode
Remove redundant property "enabled_focus_mode"
2020-10-13 10:50:00 +02:00
FIF15
0e7e25d488 Remove redundant property "enabled_focus_mode"
Fixes #41529.
2020-10-13 10:04:37 +02:00
Charles Merriam
5160a9f650 Fix typo in the ProjectSettings class documentation 2020-10-13 09:55:31 +02:00
Rémi Verschelde
0df7793693
Merge pull request #42696 from arthurpaulino/update-kinematicbody2d-is-on-descriptions
Updating KinematicBody2D "is_on" functions' descriptions
2020-10-13 08:53:01 +02:00
Arthur Paulino
0c9a1a1cd4 updating descriptions 2020-10-12 20:24:19 -03:00
Rémi Verschelde
d22791c271
doc: Sync classref with current source 2020-10-12 10:58:02 +02:00
Rémi Verschelde
7c4d1e9c65
Merge pull request #42660 from Chaosus/remove_get_uv84_normal_bit
Removed unused method Geometry3D.get_uv84_normal_bit
2020-10-09 19:31:24 +02:00
Rémi Verschelde
a33fe75050
doc: Sync classref with current source 2020-10-09 15:04:15 +02:00
Yuri Roubinsky
66c2aaf749 Removed unused method Geometry.get_uv84_normal_bit 2020-10-09 10:22:26 +03:00
Sniff
7970e4a433
Docs change: More detailed description of StreamPeerTCP.is_connected_to_host() 2020-10-07 16:35:33 +02:00
Umang Kalra
10a7eddc5e Explaining the behavior of focus & pressed stylebox overlap 2020-10-06 17:44:33 +05:30
Rémi Verschelde
3556bc48a1
Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xref
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
2020-10-04 20:48:07 +02:00
Rémi Verschelde
b5eea37fb0
Merge pull request #42518 from Duroxxigar/update-getter-and-setters
Updated getters and setters names for toplevel
2020-10-03 21:53:35 +02:00
Marcel Admiraal
e7edbcedc9 Remove reference to 3D shapes in RigidBody2D.xml contacts description. 2020-10-03 10:38:52 +01:00
Duroxxigar
4834e14493 Updated getters and setters names for toplevel 2020-10-02 19:09:01 -04:00
Rémi Verschelde
7879b0a6e5
Merge pull request #42511 from InfiniteAnts/update-ninepatchrect-class-reference
Updated NinePatchRect's patch margin descriptions
2020-10-02 17:32:45 +02:00
Anant Ahuja
00d9432f44 Updated NinePatchRect's patch margin descriptions 2020-10-02 09:41:00 -05:00
Rémi Verschelde
19f72beebb
Merge pull request #42451 from Duroxxigar/rename-toplevel
Renamed toplevel to be top_level
2020-10-02 10:57:23 +02:00
Aaron Franke
439be614f4
Link to demos from within the class reference 2020-10-01 23:57:21 -04:00
bruvzg
b0152dcac5
Fix screen_get_dpi on macOS for non fractional display scales and restore documentation. 2020-10-01 22:52:20 +03:00
Rémi Verschelde
f3e557780f
Merge pull request #37194 from lolligerjoj/expose_val_interp
Expose Animation::value_track_interpolate to GDscript
2020-10-01 15:27:32 +02:00
Rémi Verschelde
c646768ba2
Merge pull request #40473 from rcorre/gizmo-doc
Fix return type on EditorNode3DGizmoPlugin::get_priority.
2020-10-01 14:28:38 +02:00
lolligerjoj
ff4af94414 Expose Animation::value_track_interpolate to GDscript 2020-10-01 14:27:09 +02:00
Rémi Verschelde
63d158ff62
Merge pull request #42442 from rcorre/file_doc
Clarify store_string vs store_line.
2020-10-01 13:21:11 +02:00
Ryan Roden-Corrent
2762821c08
Clarify store_string vs store_line.
While the behavior can be implied from the name, it seems worth stating
it explicitly.
2020-10-01 07:03:24 -04:00
Rémi Verschelde
42f2098509
Merge pull request #42435 from Calinou/doc-string-is-valid-ip-address
Improve the `String.is_valid_ip_address()` documentation
2020-10-01 12:54:27 +02:00
Sergey Minakov
1d9b6b01db iOS: move touch delay to settings 2020-10-01 12:36:11 +03:00
Duroxxigar
b687ace7f9 Renamed toplevel to be top_level 2020-10-01 03:17:33 -04:00
Duroxxigar
85a8dbb7b6 Made toplevel a property for Node3D and CanvasItem 2020-10-01 02:43:30 -04:00
Andrii Doroshenko (Xrayez)
a8404cf56c 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.
2020-09-30 23:03:36 +03:00
Hugo Locurcio
00ade39389
Improve the String.is_valid_ip_address() documentation
This closes https://github.com/godotengine/godot-docs/issues/4097.
2020-09-30 19:26:14 +02:00
Hugo Locurcio
a2271ba3bd
Improve the String comparison methods' documentation
This closes https://github.com/godotengine/godot-docs/issues/4096.
2020-09-30 19:08:20 +02:00
Wilson E. Alvarez
b4e7edabf3
Make "function" a property of FuncRef 2020-09-30 06:57:59 -04:00
Rémi Verschelde
8c72b15e51
Merge pull request #38579 from Megamega53/edit
doc: Some improvements to KinematicBody docs
2020-09-29 11:13:10 +02:00
Rémi Verschelde
1bd2efdd46
Merge pull request #38683 from follower/patch-11
Improve doc clarity/detail for extra spacing properties
2020-09-29 10:57:19 +02:00
Rémi Verschelde
7f72d92cb0
Merge pull request #36067 from jsl118/distancefadefix
doc: Improve distance_fade documentation
2020-09-29 10:42:34 +02:00
Rémi Verschelde
bebf424c80
Merge pull request #42078 from Chaosus/vs_rename_type
Renames Type to OpType in VisualShaderNodeMultiplyAdd
2020-09-29 10:34:22 +02:00
Justin Lee
90d1eda90e
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>
2020-09-29 10:21:50 +02:00
Megamega53
ca5ae64525
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>
2020-09-29 10:14:56 +02:00
follower
2ef89e0b43 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.
2020-09-29 10:04:46 +02:00
Rémi Verschelde
2d14c7cb69
Merge pull request #42125 from andriyDev/inspector_only_option
Added inspector_only option to inspect_object in EditorInterface.
2020-09-29 08:45:38 +02:00
Aaron Franke
5fbcd8f9df
Rename the ".import" folder to ".godot/imported" 2020-09-28 05:23:45 -04:00