3c8abbc4bf
doc: Move the class description to be just below the brief description
...
- Drop the "Brief description" header as it became redundant
with this change.
- Fix a bug in the editor help where an extraneous newline was added
after the header if the class isn't inherited by any others.
- Remove the Category line in the rST markup as it's not useful
for API users.
2020-01-15 00:05:34 +01:00
083f68ebf4
Merge pull request #35077 from Feniks-Gaming/master
...
Expanded bool class description with examples
2020-01-14 23:11:20 +01:00
636f003f8c
Expanded class_bool Description with examples
...
I expanded boolean long description with example of when booleans could be use practice because
Boolean
Description:
Boolean built-in type.
was pretty vague. As new to programming person it took me longer than it should have to understand what those are and why I would want to use them. Hopefully this will make it clearer to new users reading documentation
Update bool.xml
2020-01-14 21:45:47 +00:00
42567bffb9
Document `Engine.get_idle/physics_frames` methods
2020-01-14 22:32:32 +02:00
1bafd2d2c8
Merge pull request #35120 from Faless/docs/html5_restrictions
...
Update documentation to reflect HTML5 limitations.
2020-01-14 17:23:54 +01:00
aa744aee7d
Update documentation to reflect HTML5 limitations.
2020-01-14 15:42:47 +01:00
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
ab97f78fa5
Revert "Enable Vsync via Compositor by default"
...
This reverts commit 9600fd5ddeFixes #35038 .
2020-01-13 09:33:27 +01:00
7f9bf5472c
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
478ab8b45b
Merge pull request #34960 from johannesgunnar/spin_box-apply-method
...
Spinbox apply input method
2020-01-12 14:16:14 +01:00
083637a901
Add apply method to SpinBox
2020-01-11 10:47:51 +00:00
d842557afe
Merge pull request #35001 from KoBeWi/nope
...
Add signal for LineEdit overflow event
2020-01-10 23:46:02 +01:00
f39f62954e
Merge pull request #34999 from cajallen/master
...
Updated Array's sort_custom method documentation
2020-01-10 21:57:28 +01:00
60cd3df337
Add signal for LineEdit overflow event
2020-01-10 21:07:00 +01:00
378c4895ae
[DOCS] Corrections and clarifications to classref
2020-01-10 10:46:41 -08:00
05bbbb1225
sort_custom description and example updated
2020-01-10 12:24:49 -06:00
a24aa591af
Merge pull request #34991 from Calinou/doc-os-is-debug-build
...
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:51:16 +01:00
74ae1ca616
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:26:47 +01:00
673f4fabd8
Merge pull request #34962 from KoBeWi/randocs
...
Complete documentation of various classes
2020-01-10 14:41:30 +01:00
508e624b87
Complete documentation of various classes
2020-01-10 14:14:07 +01:00
83d950b58e
Merge pull request #34968 from Calinou/enable-vsync-via-compositor
...
Enable Vsync via Compositor by default
2020-01-10 10:04:55 +01:00
9600fd5dde
Enable Vsync via Compositor by default
...
This feature was added in #33414 but it was disabled by default.
Now that it got some testing, it's probably safe to enable it
by default.
2020-01-09 22:22:11 +01:00
8708d44a50
Add option to disable loading scripts in ScriptCreateDialog
2020-01-09 13:09:23 -03:00
c6b6731857
Doc: Mention that Directory pre-opens res:// by default
...
This may be considered a bug, so we might change that in the future.
See #24149 .
2020-01-09 10:18:48 +01:00
afe39525fd
Improve the Environment class documentation
...
Co-authored-by: Clay John <claynjohn@gmail.com>
2020-01-08 20:34:57 +01:00
033fb72c03
Merge pull request #34871 from lentsius-bark/textEdit-vertical-horizontal-scroll-expose
...
expose scroll_vertical and scroll_horizontal in TextEdit
2020-01-08 08:18:12 +01:00
1b26205b25
Merge pull request #34901 from YeldhamDev/multiple_doc_completions
...
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 07:36:36 +01:00
8b5992f665
Make possible to edit the GraphEdit's selection rect colors
2020-01-07 23:20:48 -03:00
b81843ee6c
Complete docs for GraphEdit/Node and PopupMenu
2020-01-07 22:05:32 -03:00
4fbcc19853
Complete the Environment class documentation
...
This closes #34846 .
2020-01-07 17:41:17 +01:00
c475f11018
expose scroll_vertical and scroll_horizontal in TextEdit + documentation
2020-01-07 15:16:07 +01:00
5fc0a068d0
Rewording RichTextLabel::remove_line documentation
2020-01-07 08:29:10 +08:00
0a965300e7
doc: Document what happens to old script with Object.set_script()
2020-01-06 13:57:35 +01:00
8454804972
Merge pull request #33967 from Calinou/add-os-is-window-focused
...
Add an `OS.is_window_focused()` getter
2020-01-06 11:39:18 +01:00
7c3543380f
Merge pull request #34848 from clayjohn/DOCS-VisualServer
...
Finish documenting VisualServer
2020-01-06 08:38:32 +01:00
1905fdfbca
Finish documenting VisualServer
2020-01-05 23:10:44 -08:00
e85604e541
Merge pull request #34847 from YeldhamDev/splitcontainer_tabs_docs
...
Complete the SplitContainer and Tabs documentations
2020-01-06 08:05:04 +01:00
109f025d83
Merge pull request #34852 from timothyqiu/rtl-doc
...
Completes the RichTextLabel documentation
2020-01-06 08:04:29 +01:00
cab97f4b50
Merge pull request #32126 from Calinou/expose-video-adapter-name-vendor
...
Add VisualServer methods to get the video adapter name and vendor
2020-01-06 07:35:12 +01:00
3deb209105
Completes the RichTextLabel documentation
2020-01-06 13:41:39 +08:00
0cad2c0cd1
Add VisualServer methods to get the video adapter name and vendor
...
These methods can be used in scripts to retrieve the OpenGL
`GL_RENDERER` and `GL_VENDOR` strings (respectively).
This closes #28404 .
2020-01-06 00:37:56 +01:00
538baea208
Complete the SplitContainer and Tabs documentations
2020-01-05 20:03:08 -03:00
d968d032e9
Merge pull request #34833 from clayjohn/DOCS-VisualServer
...
Document most VisualServer functions
2020-01-05 22:16:15 +01:00
566ffc2695
Document most VisualServer functions
2020-01-05 12:14:57 -08:00
482fdfb7f0
Merge pull request #34812 from clayjohn/DOCS-VisualServer
...
Updated many VisualServer functions
2020-01-05 09:28:47 +01:00
35d288b2ef
Updated many VisualServer functions
2020-01-04 16:59:38 -08:00
8662b74bd6
Merge pull request #34820 from timothyqiu/doc-tree
...
Improves Tree documentation
2020-01-05 00:04:17 +01:00
6e79d683fa
Document the return value of `Object.get()` with a nonexistent property
2020-01-04 20:16:10 +01:00
8a4104acb8
Improves Tree documentation
2020-01-04 20:25:40 +08:00
7e6bfe6a8b
Document TabContainer's "use_hidden_tabs_for_min_size"
2020-01-03 16:48:27 -03:00
a18909f945
doc: Sync classref with current source
2020-01-03 15:09:09 +01:00
fa82664419
Merge pull request #34726 from nekomatata/polygon2d-antialiasing-fix
...
Fixed antialiasing option for Polygon2D with concave/hollow shapes
2020-01-03 14:17:05 +01:00
cc626acf45
Add a shorthand for setting the exit code using `SceneTree::quit()`
...
This reduces the amount of code required to exit a process with a
non-zero exit code. This pattern is also found in most other
programming languages.
2020-01-03 11:41:46 +01:00
32fd350254
Merge pull request #34747 from rcorre/add_child_owner
...
Add note about add_child and owner.
2020-01-03 09:08:13 +01:00
98bbee3008
Add note about add_child and owner.
...
Resolves #34739 .
2020-01-02 21:50:31 -05:00
dc2e4cc804
Merge pull request #34736 from cbscribe/kcc_doc_fixes
...
[DOCS] Class reference typos and fixes.
2020-01-02 20:22:38 +01:00
ab11916822
[DOCS] Class reference typos and fixes.
2020-01-02 10:31:16 -08:00
4d727f1ee6
Allows to doc vararg method return type as void
2020-01-02 21:37:26 +08:00
1591677eb8
Fixed antialiasing option for Polygon2D
...
Some cases were not handled properly for Polygon2D after making changes in common code to fix Line2D antialiasing. Added an option for drawing polygons to differentiate the two use cases.
Fixes #34568
2020-01-01 11:40:14 +01:00
7a752215ba
Improves ItemList
...
* Adds range hint for integer properties
* Adds missing descriptions in documentation
* Updates some method descriptions to match the actual behavior
* Fixes second param name of `set_item_icon_transposed` from `rect` to `transposed`
2019-12-31 08:44:55 +08:00
97ebde45d5
Merge pull request #34572 from KoBeWi/I_give_up
...
Make new ScrollContainer focus behavior optional
2019-12-30 19:00:57 +01:00
33b560a5cf
Merge pull request #34700 from Calinou/doc-input-device-touchscreen-id
...
Document how to distinguish emulated mouse events from physical ones
2019-12-30 18:16:10 +01:00
9c6863e74b
Merge pull request #34692 from bluenote10/bluenote10-shadow_item_cull_mask-docs
...
shadow_item_cull_mask should reference light mask
2019-12-30 18:12:20 +01:00
ccedda9c71
Merge pull request #34682 from Calinou/os-exit-code-nonportable-warning
...
Print a warning message if `OS.exit_code` is set to a non-portable value
2019-12-30 18:09:32 +01:00
fdfb7e5fc4
Merge pull request #34621 from cbscribe/kcc_misc_doc_fixes
...
[Docs] Description updates for Node2D & Object
2019-12-30 17:23:23 +01:00
e9696628f1
Merge pull request #34615 from lakshay-angrish/area_shape_entered-docs
...
add area_shape_entered usage
2019-12-30 17:14:08 +01:00
cc72885107
Make new ScrollContainer focus behavior optional
2019-12-30 16:40:02 +01:00
ae9716cf78
Merge pull request #34611 from lakshay-angrish/33841_bitmapfont_doc
...
add AngelCode format in BitmapFont doc's description
2019-12-30 16:35:53 +01:00
d595a5e9c3
Merge pull request #34593 from Calinou/doc-httprequest-json-example
...
Add an example of using HTTPRequest to contact a REST API
2019-12-30 16:34:09 +01:00
1da9a60cd8
Merge pull request #34590 from willnationsdev/kc
...
Fix KinematicCollision docs mislabeling an ObjectID as an RID.
2019-12-30 16:33:34 +01:00
46bc05c5ac
Merge pull request #34576 from rcorre/imgeo-coords
...
Clarify ImmediateGeometry.add_vertex.
2019-12-30 16:25:21 +01:00
df2968de26
Merge pull request #34571 from rcorre/array_returns
...
Be more specific about array return values.
2019-12-30 16:22:30 +01:00
9ae73f7bb5
Document how to distinguish emulated mouse events from physical ones
...
Mouse events emulated from a touchscreen will always have a device ID
of -1.
2019-12-30 15:30:34 +01:00
d2690b37fd
shadow_item_cull_mask should reference light mask
2019-12-29 19:06:18 +01:00
d441a6aefa
Print a warning message if `OS.exit_code` is set to a non-portable value
...
This also improves the related documentation.
2019-12-29 16:56:22 +01:00
bc234ce0ae
[Docs] Description updates for Node2D & Object
2019-12-26 10:24:29 -08:00
fe9a4ff818
add area_shape_entered usage
2019-12-26 17:30:48 +05:30
c37429b281
add AngelCode format in BitmapFont doc's description
2019-12-26 11:12:02 +05:30
c719cea116
Add an example of using HTTPRequest to contact a REST API
...
We already had an example to download and display an image,
but having another example dedicated to REST APIs doesn't hurt.
2019-12-24 23:24:16 +01:00
e182aa0d32
Fix KinematicCollision docs mislabeling an ObjectID as an RID.
2019-12-24 15:35:58 -06:00
67f441a09d
Clarify ImmediateGeometry.add_vertex.
...
It isn't obvious whether you should add vertices in global coordinates,
or local to the ImmediateGeometry Node.
2019-12-23 23:20:32 -05:00
e002044761
Be more specific about array return values.
...
The prior docs weren't clear if {pop_,}{front,back} would fail or return
`null` on an empty array.
2019-12-22 14:38:10 -05:00
56d44aaac9
Merge pull request #34090 from Calinou/doc-improve-basis
...
Improve the Basis class documentation
2019-12-22 20:37:48 +01:00
bb62c07fce
Improve the Basis class documentation
2019-12-22 18:04:51 +01:00
0bab51ab55
Fix the Node `process_priority` description to match actual behavior
...
This closes #34531 .
2019-12-22 17:01:56 +01:00
4bec32a11e
Merge pull request #34400 from alexchond/alexchon
...
Document DUPLICATE_USE_INSTANCING #2770
2019-12-22 12:36:42 +01:00
18e4fb3548
Merge pull request #34413 from Zacxalot/vehiclewheel-tooltip
...
Update VehicleWheel.xml
2019-12-22 12:34:34 +01:00
0b776ebbe4
Merge pull request #34498 from KoBeWi/bad_idea
...
Mention that bbcode_text += string is a bad idea
2019-12-21 14:38:54 +01:00
abbff65dc8
Mention that bbcode_text += string is a bad idea
2019-12-21 10:45:26 +01:00
2b1fb0375d
Mention how to handle cancel in ConfirmationDialog
2019-12-21 00:19:16 +01:00
b3a70f0b80
Merge pull request #34357 from clayjohn/DOCS-VisualServer
...
Updated docs for many VisualServer methods
2019-12-20 09:20:29 +01:00
f88f762240
Updated docs for many VisualServer methods
2019-12-19 18:24:51 -08:00
e26b066871
DUPlICATE_USING_INSTANCE documentation update
2019-12-19 17:17:57 +02:00
a58deee648
Updates docs of AABB and Plane
2019-12-18 15:14:38 +08:00
4f18c134b9
Merge pull request #34412 from flyingpimonster/docs-optionbutton
...
Docs: OptionButton
2019-12-18 07:59:32 +01:00
13b77c9acd
Update VehicleWheel.xml
...
VehicleWheels roll influence values in the tool tip were the wron way round.
2019-12-17 23:27:41 +00:00
575a1dc9cf
Docs: OptionButton
...
Complete the documentation and make some existing descriptions a bit
clearer.
Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
2019-12-17 16:45:18 -06:00
6cf1499eaf
Improve the `KEY_MASK_CMD` documentation
2019-12-17 18:26:21 +01:00
be3fc17603
Document DUPLICATE_USE_INSTANCING #2770
2019-12-17 13:41:36 +02:00
c64c46db1d
doc: Sync classref with current source
2019-12-17 11:43:07 +01:00
f8ea390b52
Merge pull request #34269 from KoBeWi/scrolling_peeps
...
Scroll ScrollContainer to focused children
2019-12-16 14:03:21 +01:00
6ec42b7507
Merge pull request #34372 from KoBeWi/how_to_graphnode
...
Mention how to add slots to GraphNode
2019-12-16 08:26:43 +01:00
078e9c04d2
Mention how to add slots to GraphNode
2019-12-15 23:29:27 +01:00
1b8b380993
Document that translated does not behave like rotated or scaled
2019-12-15 12:31:08 -05:00
d3a07d3550
Merge pull request #33910 from Faless/net/android_mlock
...
Acquire MulticastLock on Android when using broadcast/multicast
2019-12-14 21:53:08 +01:00
04c917899f
Add Android NetSocket implementation.
...
Automatically acquire and release multicast lock when needed.
2019-12-14 18:10:36 +01:00
9269d6be32
UDP sockets broadcast is now disabled by default.
...
Add method `set_broadcast_enabled` to allow enabling broadcast via
GDScript.
2019-12-14 17:48:16 +01:00
a5dcabbbfb
Merge pull request #34272 from MissKraya/34258-fix
...
Fix for #34258 and added get_zoom_hbox() documentation.
2019-12-14 17:14:41 +01:00
59937e1c54
Updated get_zoom_hbox() documentation.
2019-12-14 14:02:15 +00:00
185017b922
Clarifying how float(String from) parses partially invalid strings
...
Update the description of this method to be in line with [code]int int(String from)[/code] in regards to how it deals with a completely invalid parameter and a partially invalid parameter.
2019-12-13 11:34:26 -03:00
cf3a863fa9
Merge pull request #34229 from NoFr1ends/fix-home-indicator-ios
...
Allow to change the home indicator behaviour on iOS
2019-12-13 14:00:14 +01:00
4d61118f64
Add project setting to hide home indicator on iOS
...
On iOS devices without a physical home button iOS
shows a home indicator instead. This is often in the
way of the UI or the game.
Added a project setting to disable hidden home indicator.
The default value is to hide the home indicator
2019-12-13 11:00:18 +01:00
9f68626fb2
doc: Sync classref with current source
...
Also apply clang-format.
2019-12-13 10:41:06 +01:00
1cd736951a
Merge pull request #34189 from aaronfranke/mesh-aabb
...
Expose Mesh get_aabb
2019-12-13 09:14:16 +01:00
aab70008d3
Merge pull request #34309 from Muller-Castro/VarDeclFix
...
Fixed HTTPClient.xml:115 and 121 variant declaration
2019-12-12 22:51:58 +01:00
f9db01ec50
Fixed HTTPClient.xml:115 and 121 variant declaration
2019-12-12 15:40:17 -03:00
37d164e24e
CharFXTransform: Drop unnecessary get_value_or()
...
See https://github.com/godotengine/godot/pull/23658#issuecomment-562706669
The method was implemented back when Dictionary.get(key, default) did not
exist, but now that it does we do not need a custom method in CharFXTransform.
It's a new feature in 3.2, so does not break compat with 3.1.x.
2019-12-12 07:47:08 +01:00
77a8657633
Scroll ScrollContainer to focused children
2019-12-11 14:29:36 +01:00
a139104646
Expose Mesh get_aabb
2019-12-11 08:25:36 -05:00
c868baf658
Merge pull request #34222 from Calinou/doc-collisionshapes
...
Improve the Shape/Shape2D classes documentation
2019-12-10 10:44:36 +01:00
16d612dccc
Improve the Shape/Shape2D classes documentation
2019-12-10 08:21:15 +01:00
3acbabca1e
Document the KinematicBody axis lock methods
2019-12-09 13:45:12 +01:00
3684810a28
Merge pull request #34164 from Calinou/pckpacker-optional-args
...
Make some arguments in PCKPacker methods optional
2019-12-09 09:41:52 +01:00
fe06966181
Make some arguments in PCKPacker methods optional
...
Those arguments aren't required for most common use cases,
so making them optional should help with code readability.
2019-12-07 01:06:42 +01:00
7ae0e4be46
Improve the PCKPacker class documentation
2019-12-07 01:00:51 +01:00
ff58030ed6
Merge pull request #34160 from Calinou/add-makerst-git-hook
...
Add a pre-commit hook to check the class reference syntax
2019-12-07 00:11:29 +01:00
07a739e7e1
Merge pull request #34159 from akien-mga/doc-enums-constants
...
doc: Markup fixes for enums and constants
2019-12-07 00:11:17 +01:00
643b37aaf0
Merge pull request #34086 from Calinou/doc-improve-stylebox
...
Improve the StyleBox class documentations
2019-12-07 00:10:57 +01:00
17add2dc86
Add a pre-commit hook to check the class reference syntax
...
This also makes documentation helper scripts executable.
2019-12-06 23:40:19 +01:00
f1a76a8820
Improve the StyleBox class documentations
2019-12-06 23:29:38 +01:00
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
7c6c32b500
Document RichTextEffect and CharFXTransform
2019-12-06 22:50:29 +01:00
5f64d773ba
Merge pull request #34128 from akien-mga/doc-animplayer-play-stop
...
doc: Fix and clarify AnimationPlayer play and stop descriptions
2019-12-06 09:35:03 +01:00
4b64ef88d8
Merge pull request #34132 from flyingpimonster/arvr-docs
...
Docs: ARVRController and ARVRInterface
2019-12-06 08:38:29 +01:00
5978e6afac
Docs: ARVRController and ARVRInterface
...
This commit clarifies a few methods and members in the AR/VR docs. It
also updates some wording according to the style guide and fixes a
couple typos.
2019-12-05 18:10:11 -06:00
9a12b40100
doc: Fix and clarify AnimationPlayer play and stop descriptions
...
Closes #34125 .
2019-12-05 21:56:31 +01:00
99b81aa1b9
Merge pull request #34039 from Eoin-ONeill-Yokai/multimeshfix
...
Added Missing Binding for `multimesh_create` to VisualServer
2019-12-05 06:49:43 +01:00
f7f7544997
Added method binding for `multimesh_create` that was missing from VisualServer class.
2019-12-04 16:00:18 -08:00
e1dda5195c
Added support for vertical syncing via the Windows OS compositor (DWM.)
2019-12-04 11:14:21 +01:00
bc4dbcf793
Travis CI: Run `makerst.py` to check for documentation errors
2019-12-04 08:51:32 +01:00
0aebba2388
[ci skip] OS class documentations, adds platform compatibility notes.
2019-12-03 18:14:14 +02:00
a74f0fd4cf
doc: Fix markup errors
2019-12-03 10:26:20 +01:00
d0243e9e0f
Merge pull request #34077 from Calinou/doc-improve-dynamicfont
...
Improve the DynamicFont class documentation
2019-12-03 10:18:15 +01:00
dc3d8f0e45
Merge pull request #34076 from Calinou/doc-listener
...
Add documentation for the Listener class
2019-12-03 10:14:11 +01:00
673bd79a9e
Improve the DynamicFont class documentation
2019-12-03 09:56:11 +01:00
c6c5a213cd
Add documentation for the Listener class
2019-12-03 09:38:26 +01:00
73149499c0
Improve the Camera class documentation
...
This makes the Camera class 100% documented.
2019-12-03 09:37:01 +01:00
10bae7c05b
Merge pull request #33857 from nekomatata/polygon-2d-antialiasing
...
Fixed antialiased option for Polygon2D
2019-12-03 07:51:16 +01:00
7140d766a2
Merge pull request #33997 from akien-mga/doc-makerst-escape
...
makerst: Escape default values using reST markup
2019-12-01 11:52:20 +01:00
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
Hugo Locurcio
Rémi Verschelde
Feniks
Andrii Doroshenko (Xrayez)
Fabio Alessandrelli
Tomasz Chabora
Jóhannes Gunnar Þorsteinsson
Chris Bradfield
cajallen
Michael Alexsander
Krystof Klestil
Haoyu Qiu
rainlizard
clayjohn
Ryan Roden-Corrent
PouleyKetchoupp
Fabian Keller
Lakshay Angrish
willnationsdev
alexchond
Zacxalot
James Westman
Aaron Franke
Hannah Crawford
Danilo Costa Viana
Jonas Bernemann
Muller-Castro
Eoin O'Neill
TerminalJack
bruvzg