Commit graph

2337 commits

Author SHA1 Message Date
Hugo Locurcio
90db42d9db Document HTML5 CORS restrictions in HTTPClient and HTTPRequest
See https://github.com/godotengine/godot/issues/40247.
2020-07-20 15:15:55 +02:00
Hugo Locurcio
fb2e4d77eb Document several editor-related classes to 100% completion 2020-07-20 14:48:42 +02:00
TheDuriel
0ff1ca4655 Clarify TreeItem return values 2020-07-20 14:38:34 +02:00
Hugo Locurcio
1554fce23c Document Vector2.dot() and Vector3.dot() more extensively
These methods are commonly used in games. It's time to make the
documentation more explicit about them :)
2020-07-20 14:20:17 +02:00
Rémi Verschelde
639252d0f8
Merge pull request #40409 from Calinou/doc-control-rect-scale
Document caveats related to Control scaling
2020-07-20 13:56:50 +02:00
Andrii Doroshenko (Xrayez)
df80e259cd Document the process of parsing command-line arguments
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-07-20 12:09:46 +03:00
Hugo Locurcio
ce57cc43dd
Improve the VisibilityNotifier and VisibilityEnabler class descriptions 2020-07-18 00:30:30 +02:00
Hugo Locurcio
708a0a43fb
Complete the EditorSettings class documentation
EditorSettings is now 100% documented.
2020-07-17 20:23:14 +02:00
Hugo Locurcio
43dae28e9d
Mention toggled signal for pressed state in BaseButton documentation
This closes #40455.
2020-07-17 00:01:24 +02:00
Hugo Locurcio
60bb80505f Document an example dictionary returned by TileSet.tile_get_shapes() 2020-07-16 09:42:24 +02:00
Hugo Locurcio
8836c7203b Add an example for creating a button in the Button class documentation
This closes https://github.com/godotengine/godot-docs/issues/3798.
2020-07-15 16:33:44 +02:00
Hugo Locurcio
d4085d6bfb Mention the Data paths documentation in the File class
This closes https://github.com/godotengine/godot-docs/issues/3799.
2020-07-15 16:10:06 +02:00
Rémi Verschelde
f131daf972
Merge pull request #40414 from rcorre/get-mesh-arrays-doc
Clarify how to convert PrimitiveMesh to ArrayMesh.
2020-07-15 15:30:27 +02:00
Rémi Verschelde
1cc5d35906
Merge pull request #40412 from Calinou/doc-string-c-unescape
Document which escape sequences are supported by `String.c_unescape()`
2020-07-15 14:19:50 +02:00
Ryan Roden-Corrent
933bf96523
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)
```
2020-07-15 08:09:27 -04:00
Rémi Verschelde
08dda79a9c
Merge pull request #37961 from Calinou/doc-csharp-dynamic-object-call
Mention C# gotchas in Object's dynamic call/set/connect methods
2020-07-15 12:33:41 +02:00
Hugo Locurcio
04b25108ac Document which escape sequences are supported by String.c_unescape()
See https://github.com/godotengine/godot/issues/38716.
2020-07-15 11:52:00 +02:00
bruvzg
0181c3dde1
Docs: Ignore OS specific values (constants, project settings, properties). 2020-07-15 12:24:59 +03:00
Hugo Locurcio
a36912b3cb Document caveats related to Control scaling
This is a common topic of confusion. Clarifying its intended scope
should make things easier to understand.
2020-07-15 10:36:29 +02:00
Rémi Verschelde
dad21acebd
Merge pull request #40380 from Calinou/doc-vehiclebody-limitations
Document VehicleBody3D and VehicleWheel3D limitations
2020-07-15 09:28:19 +02:00
Rémi Verschelde
c8523038cc
Merge pull request #40268 from DanielZTing/master
Fix cancel/OK button order on macOS
2020-07-15 09:21:04 +02:00
Rémi Verschelde
b79aa89796 doc: Sync classref with current source 2020-07-15 08:43:21 +02:00
Hugo Locurcio
878f03d8e3
Mention C# gotchas in Object's dynamic call/set/connect methods
This closes #34015.
2020-07-14 17:07:10 +02:00
Hugo Locurcio
0493e7c106
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.
2020-07-14 16:16:08 +02:00
Fabio Alessandrelli
839c7b1ba3 Document updated UDPServer interface. 2020-07-14 14:10:18 +02:00
Aaron Franke
9986439352
Commit other files changed by file_format.sh 2020-07-13 14:14:11 -04:00
Rémi Verschelde
9678a41b19
Merge pull request #40272 from clayjohn/VULKAN-time-slicing
Add incremental update mode to sky
2020-07-11 10:00:39 +02:00
clayjohn
a54f93c169 Add incremental update mode to sky 2020-07-11 00:10:15 -07:00
Rémi Verschelde
d0cea291d2
Merge pull request #40193 from KoBeWi/dem_pikks
Allow Area2D and 3D mouse events without collision layer
2020-07-11 00:26:56 +02:00
Daniel Ting
9605fc54c7 Fix cancel/OK button order on macOS
The macOS platform convention regarding button order is cancel on left,
OK on right.
2020-07-10 15:10:11 -05:00
Yuri Roubinsky
ecb5f7ea23 Added 'fma' function to shader language 2020-07-10 19:58:03 +03:00
Tomasz Chabora
7eebb06b55 Allow Area2D and 3D mouse events without a collision layer
Co-authored-by: madmiraal <madmiraal@users.noreply.github.com>
2020-07-10 13:23:20 +02:00
Rémi Verschelde
aeccd1e287
Merge pull request #40121 from Calinou/enable-file-logging
Enable file logging by default on desktops to help with troubleshooting
2020-07-10 11:02:57 +02:00
Rémi Verschelde
1282b8201f
Merge pull request #40243 from nathanfranke/fix-regression-directory-open-check
Follow-Up Fix Directory Open
2020-07-10 10:21:03 +02:00
Rémi Verschelde
2638168da8
Merge pull request #40246 from Calinou/doc-httprequest-post-example
Add a POST request example to the HTTPRequest class documentation
2020-07-10 10:01:56 +02:00
Nathan Franke
6952458538
Follow-Up Fix Directory Open 2020-07-10 02:56:37 -05:00
Hugo Locurcio
54db59be67 Add a POST request example to the HTTPRequest class documentation 2020-07-10 09:13:46 +02:00
Rémi Verschelde
8894af3908
Merge pull request #40210 from RantingBob/patch-1
Update Resource.xml to explain behavior of duplicate when subresource…
2020-07-10 08:59:27 +02:00
Rémi Verschelde
de794bfa3c
Merge pull request #40240 from Calinou/doc-packedscene-example-instance
Document how to instance a PackedScene and add it as a child
2020-07-09 23:04:21 +02:00
Hugo Locurcio
23d929d540
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.
2020-07-09 20:05:33 +02:00
Hugo Locurcio
1261f47c35
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).
2020-07-09 19:43:38 +02:00
Hugo Locurcio
20af28ec06
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.
2020-07-08 18:57:25 +02:00
Bob Gardner
660a780c3b
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.
2020-07-08 09:51:51 -07:00
Aaron Franke
af80bcd2f8
Add sort and has methods to PackedArrays 2020-07-06 22:16:39 -04:00
Yuri Sizov
49f6dc5004 Expose methods to play scene from plugin code 2020-07-06 17:39:16 +03:00
SkyJJ
cae6f0bda2 Change translation parser plugin API to parse_file() 2020-07-05 12:14:56 +02:00
Rémi Verschelde
8ccb1cec91
Merge pull request #40084 from bruvzg/macos_seamless_scaling
[macOS] Implement seamless display scaling.
2020-07-04 10:51:09 +02:00
Rémi Verschelde
9cec315ec0
Merge pull request #40103 from Calinou/doc-fix-string-capitalize
Fix `String.capitalize()` description to follow camelCase changes
2020-07-04 09:57:46 +02:00
bruvzg
df968d577a
[macOS] Implement seamless display scaling. 2020-07-04 10:36:33 +03:00
Rémi Verschelde
c020eea184
Merge pull request #40092 from hinlopen/remove-find-last
Remove String::find_last (same as rfind)
2020-07-04 01:38:01 +02:00
Hugo Locurcio
887099680a
Fix String.capitalize() description to follow camelCase changes
This closes #40093.
2020-07-03 20:36:27 +02:00
Rémi Verschelde
cf97137681
Merge pull request #40089 from slooths/doc-textedit-minimap
Add documentation for minimap_draw and minimap_width
2020-07-03 17:35:22 +02:00
Rémi Verschelde
96644d23a0 doc: Sync classref with current source 2020-07-03 16:09:12 +02:00
Rémi Verschelde
54ce2e9820
Merge pull request #40086 from slooths/doc-update-select-methods
Update TextEdit select and select_all method descriptions
2020-07-03 15:36:46 +02:00
Stijn Hinlopen
929b98d24b Remove String::find_last (same as rfind) 2020-07-03 15:26:22 +02:00
Rémi Verschelde
eaf15fd5a2
Merge pull request #40085 from slooths/doc-selecting-enabled
Add documentation for selecting_enabled
2020-07-03 15:23:39 +02:00
Slooth
df8f0e6215 Add documentation for minimap_draw and minimap_width 2020-07-03 07:42:43 -05:00
Slooth
b2471edf45 Update TextEdit select and select_all methods 2020-07-03 06:44:34 -05:00
Slooth
bc1ea1cbad Add documentation for selecting_enabled 2020-07-03 06:24:40 -05:00
Rémi Verschelde
b5fa2634d4
Merge pull request #40082 from slooths/doc-textedit-center-viewport-to-cursor
Add documentation for center_viewport_to_cursor method
2020-07-03 13:17:46 +02:00
Slooth
654d33866b Add documentation for center_viewport_to_cursor method 2020-07-03 05:39:17 -05:00
Slooth
d838282191 Add documentation for shortcut_keys_enabled 2020-07-03 03:03:56 -05:00
Aaron Franke
299c3ec1c1
Fix incorrect documentation for Vector2.angle() 2020-07-02 22:52:37 -04:00
Rémi Verschelde
f9c2f35dd9
Merge pull request #39415 from SkyLucilfer/PotGeneration
Add POT generation feature in Editor
2020-07-02 22:22:46 +02:00
Rémi Verschelde
67e4082b1e
Merge pull request #37350 from aaronfranke/force-impulse
Refactor physics force and impulse code to use (force, position) order
2020-07-02 18:39:16 +02:00
SkyJJ
efb4609425 Add translation parser plugin support 2020-07-02 14:47:35 +02:00
Rémi Verschelde
f4aea93537
Merge pull request #38390 from Xrayez/doc-offset-poly-translate
Clarify `Geometry.offset_polygon_2d` regarding vertices translation
2020-07-02 14:28:49 +02:00
Rémi Verschelde
afe03e872b
Merge pull request #34926 from Xrayez/draw-transform-defaults
Provide `draw_set_transform` defaults for rotation and scale
2020-07-02 09:06:06 +02:00
Rémi Verschelde
0a8dbe7f75
Merge pull request #32516 from nekomatata/texture-button-flip
Added flip_h and flip_v properties in TextureButton
2020-07-01 19:07:59 +02:00
Andrii Doroshenko (Xrayez)
851c1050b2 Provide draw_set_transform defaults for rotation and scale 2020-07-01 18:09:11 +03:00
Andrii Doroshenko (Xrayez)
19b72da35d 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`.
2020-07-01 17:10:21 +03:00
Rémi Verschelde
372136fe75 Environment: Refactor code for readability + more
- Makes all boolean setters/getters consistent.
- Fixes bug where `glow_hdr_bleed_scale` was not used.
- Split CameraEffects to their own source file.
- Reorder all Environment method and properties declarations,
  definitions and bindings to be consistent with each other
  and with the order of property bindings.
- Bind missing enum values added with SDFGI.
- Remove unused SDFGI enhance_ssr boolean.
- Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:44:45 +02:00
PouleyKetchoupp
5f1d94bb7d Added flip_h and flip_v properties in TextureButton 2020-07-01 11:31:27 +02:00
Rémi Verschelde
27605769c4
Merge pull request #35633 from Xrayez/physics-shape-property
Expose shape property for shape query parameters classes
2020-06-30 13:57:23 +02:00
simpu
bfadb882b1 Added Custom Performance Monitor and feature to read intermediate values of Monitor
Custom monitors can be added/removed/checked using `Performance.add_custom_monitor`/`Performance.remove_custom_monitor`/`Performance.has_custom_monitor`

The value can be viewed in the `Monitor` tab of Debugger.

Text before `/` is used to categorize the custom monitor.

`EditorPerformanceProfiler` class is created to separate logic from `ScriptEditorDebugger`

User can click on the graph of monitors to read the value at that point.

Graph includes intermediate base lines.
2020-06-29 17:20:29 +05:30
Hugo Locurcio
e6352d1daa
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.
2020-06-26 22:09:08 +02:00
Andrii Doroshenko (Xrayez)
da3fbc0296 Expose shape property for shape query parameters classes
Co-authored-by: PouleyKetchoupp <pouleyketchoup@gmail.com>
2020-06-26 16:54:05 +03:00
Rémi Verschelde
2446dbfba1 doc: Sync classref with current source 2020-06-25 11:00:38 +02:00
Andreas Gustafsson
5181daaf9e Tween.xml word order fix
Change the word order of '...the where...' into '...where the...'.
2020-06-23 18:42:11 +02:00
Meriipu
2643b8fa5e Clarify what a string being empty means
Should close https://github.com/godotengine/godot-docs/issues/2432
2020-06-23 11:13:12 +02:00
Rémi Verschelde
42c4a701dd
Merge pull request #39755 from Faless/crypto/encryption_pr_4.0
Crypto enhancements, AESContext, RSA public key, signature, verification.
2020-06-22 23:31:58 +02:00
skyace65
a94ba7be59 Fix Joint2D doc 2020-06-21 22:55:16 -04:00
Hugo Locurcio
227f12478d
Document how Vector2, Vector3 and Color behave in a boolean context
See #39731.
2020-06-21 17:16:10 +02:00
Rémi Verschelde
4af74c0d7c
Merge pull request #39712 from akien-mga/古池や蛙飛び込む水の音
Move Haiku platform port to external repository
2020-06-21 12:20:31 +02:00
Aaron Franke
08577fab14
Update bool documentation to be more clear 2020-06-21 03:08:28 -04:00
Rémi Verschelde
efcc508ee5 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.
2020-06-20 17:59:41 +02:00
Hugo Locurcio
31b7f02a29
Remove ToolButton in favor of Button
ToolButton has no redeeming differences with Button;
it's just a Button with the Flat property enabled by default.
Removing it avoids some confusion when creating GUIs.

Existing ToolButtons will be converted to Buttons, but the Flat
property won't be enabled automatically.

This closes https://github.com/godotengine/godot-proposals/issues/1081.
2020-06-19 20:49:49 +02:00
Yuri Roubinsky
cb9cbf840d Added Texture2DArray support to visual shaders 2020-06-19 18:02:05 +03:00
Rémi Verschelde
3eab3c10b5
Merge pull request #39641 from akien-mga/mono-always-define-options
Mono: Always define options in main.cpp to keep them in docs
2020-06-19 12:53:33 +02:00
Rémi Verschelde
a8132b2fab
Merge pull request #33235 from nekomatata/rich-text-label-fit-height
Option in RichTextLabel for height to fit content
2020-06-19 12:52:25 +02:00
Fabio Alessandrelli
f055b86e65 Document AES and new Crypto/CryptoKey functions. 2020-06-18 17:06:16 +02:00
Rémi Verschelde
2b6bbf8dce Mono: Always define options in main.cpp to keep them in docs
Otherwise generating docs with non-Mono builds removes them,
which is not so convenient for the documentation work.
2020-06-18 12:06:24 +02:00
Rémi Verschelde
dfa5f88c11 doc: Fix rebase error from #39589 2020-06-18 11:34:10 +02:00
Hugo Locurcio
24a8d43272 Document Mono-specific classes
This fully documents all Mono-specific classes.
2020-06-18 10:32:34 +02:00
Rémi Verschelde
ba0db95909 DocData: Skip language-specific ClassDoc without methods/constants
Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.
2020-06-17 15:09:07 +02:00
Rémi Verschelde
93d79023ad
Merge pull request #39541 from Ev1lbl0w/feature/disable-rendering
Expose disable_render_loop property to GDScript
2020-06-16 20:48:41 +02:00
Ev1lbl0w
03879a564a
Expose disable_render_loop property to GDScript 2020-06-16 15:43:44 +01:00
Rémi Verschelde
78d09a4163
Merge pull request #37903 from Xrayez/shape-2d-draw-bind
Bind Shape2D draw method
2020-06-16 15:15:51 +02:00
Rémi Verschelde
8db8577f10
Merge pull request #39126 from TwistedTwigleg/GSOC_2020_Working_Branch
Skeleton and Skeleton inspector low-level changes
2020-06-16 09:30:22 +02:00
Rémi Verschelde
4b5b60de85
Merge pull request #39189 from touilleMan/issue-38925
Unify OS.get_system_time_* and OS.get_unix_time
2020-06-15 23:57:16 +02:00