Commit Graph

2593 Commits

Author SHA1 Message Date
Feniks 1ebf4c7fdc Improve Description of GraphNode
It mostly fixes issues I have listed in https://github.com/godotengine/godot-docs/issues/3065 where GraphNode description was rather lacking clarity. It was near impossible how to use the them or how to create new slots etc. 

I improved it quite a bit if anyone has idea how to reword original "A tuple of input and output slots is defined for each GUI element included in the GraphNode." I would love to hear it. I am unsure how to word it in more understandable way.
2020-01-19 19:21:30 +00:00
Rémi Verschelde 05c8654390 doc: Timer.autostart resets to false on start
Fixes #35289.
2020-01-19 10:18:11 +01:00
Rémi Verschelde d4a222cd9d
Merge pull request #35281 from timothyqiu/video-player-doc
Improves VideoPlayer's documentation
2020-01-18 15:27:28 +01:00
Haoyu Qiu ecf3d3fd84 Improves VideoPlayer's documentation 2020-01-18 21:51:17 +08:00
Hugo Locurcio 9914b6fc62
doc: Mention the limited comment support in ConfigFile 2020-01-18 13:58:36 +01:00
Rémi Verschelde ea1da40d79
Merge pull request #35223 from Feniks-Gaming/MenueButtonDescription
Improved MenuButton Description
2020-01-18 09:25:49 +01:00
Feniks 156f5b7ce2 Improved MenuButton Description
I expanded description of MenueButton to explain how to create the items inside of the pop up as this is initially a mystery to many new people.
2020-01-18 07:22:19 +00:00
Haoyu Qiu 9882cbf8cd Improves LineEdit documentation
* Recently supported macOS shortcuts are added
* Makes it clear than `set_text` won't trigger `text_changed`
* `minimum_spaces` is the number of space characters that can be shown
  without scrolling
2020-01-17 11:02:43 +08:00
Rémi Verschelde 1de633205f Validate input in (CPU)Particles set_emission_shape()
Fixes #29777.

Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 11:08:51 +01:00
Rémi Verschelde 7c624949b5
Merge pull request #35147 from madmiraal/fix-34992
Fixes get_floor_normal() returning the user defined floor_normal.
2020-01-15 14:17:15 +01:00
Marcel Admiraal 907adb37ce Fixes get_floor_normal() returning the user defined floor_normal.
When there is no collision with a floor the get_floor_normal() function
should return the zero vector to be consistent with get_floor_velocity().

Renames floor_normal to up_direction in all bindings.

Updates the documentation of get_floor_normal() and get_floor_velocity()
to make it clear when the values are valid. Updates the documentation for
move_and_slide() and move_and_slide_with_snap() to use the new up_direction
parameter name.
2020-01-15 10:13:35 +01:00
Rémi Verschelde 6e8eb0d98d
Merge pull request #35134 from clayjohn/DOCS-update-multiple
Completed documentation for many visual nodes
2020-01-15 08:10:15 +01:00
clayjohn 46b5742159 Completed documentation for many visual nodes 2020-01-14 18:28:36 -08:00
Rémi Verschelde 40f0649e5b Fix typos with codespell
Using codespell 1.16.0.

See ab3bccdb78 for procedure.
2020-01-15 00:49:52 +01:00
Rémi Verschelde 8d60f5a349
Merge pull request #35132 from Calinou/doc-description-below-brief
doc: Move the class description to be just below the brief description
2020-01-15 00:49:31 +01:00
Hugo Locurcio 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
Rémi Verschelde 083f68ebf4
Merge pull request #35077 from Feniks-Gaming/master
Expanded bool class description with examples
2020-01-14 23:11:20 +01:00
Feniks 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
Andrii Doroshenko (Xrayez) 42567bffb9 Document `Engine.get_idle/physics_frames` methods 2020-01-14 22:32:32 +02:00
Rémi Verschelde 1bafd2d2c8
Merge pull request #35120 from Faless/docs/html5_restrictions
Update documentation to reflect HTML5 limitations.
2020-01-14 17:23:54 +01:00
Fabio Alessandrelli aa744aee7d Update documentation to reflect HTML5 limitations. 2020-01-14 15:42:47 +01:00
Tomasz Chabora c09b9c488f Complete documentation of some more classes 2020-01-14 13:19:39 +01:00
Rémi Verschelde ab97f78fa5 Revert "Enable Vsync via Compositor by default"
This reverts commit 9600fd5dde.

Add comment warning about possible implications of using this option.

Fixes #35038.
2020-01-13 09:33:27 +01:00
Rémi Verschelde 7f9bf5472c doc: Sync classref with current source 2020-01-12 14:30:21 +01:00
Rémi Verschelde 478ab8b45b
Merge pull request #34960 from johannesgunnar/spin_box-apply-method
Spinbox apply input method
2020-01-12 14:16:14 +01:00
Jóhannes Gunnar Þorsteinsson 083637a901 Add apply method to SpinBox 2020-01-11 10:47:51 +00:00
Rémi Verschelde d842557afe
Merge pull request #35001 from KoBeWi/nope
Add signal for LineEdit overflow event
2020-01-10 23:46:02 +01:00
Rémi Verschelde f39f62954e
Merge pull request #34999 from cajallen/master
Updated Array's sort_custom method documentation
2020-01-10 21:57:28 +01:00
Tomasz Chabora 60cd3df337 Add signal for LineEdit overflow event 2020-01-10 21:07:00 +01:00
Chris Bradfield 378c4895ae [DOCS] Corrections and clarifications to classref 2020-01-10 10:46:41 -08:00
cajallen 05bbbb1225 sort_custom description and example updated 2020-01-10 12:24:49 -06:00
Rémi Verschelde 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
Hugo Locurcio 74ae1ca616
Improve the `OS.is_debug_build()` documentation 2020-01-10 15:26:47 +01:00
Rémi Verschelde 673f4fabd8
Merge pull request #34962 from KoBeWi/randocs
Complete documentation of various classes
2020-01-10 14:41:30 +01:00
Tomasz Chabora 508e624b87 Complete documentation of various classes 2020-01-10 14:14:07 +01:00
Rémi Verschelde 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
Hugo Locurcio 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
Michael Alexsander 8708d44a50 Add option to disable loading scripts in ScriptCreateDialog 2020-01-09 13:09:23 -03:00
Rémi Verschelde 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
Hugo Locurcio afe39525fd
Improve the Environment class documentation
Co-authored-by: Clay John <claynjohn@gmail.com>
2020-01-08 20:34:57 +01:00
Rémi Verschelde 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
Rémi Verschelde 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
Michael Alexsander 8b5992f665 Make possible to edit the GraphEdit's selection rect colors 2020-01-07 23:20:48 -03:00
Michael Alexsander b81843ee6c Complete docs for GraphEdit/Node and PopupMenu 2020-01-07 22:05:32 -03:00
Hugo Locurcio 4fbcc19853
Complete the Environment class documentation
This closes #34846.
2020-01-07 17:41:17 +01:00
Krystof Klestil c475f11018 expose scroll_vertical and scroll_horizontal in TextEdit + documentation 2020-01-07 15:16:07 +01:00
Haoyu Qiu 5fc0a068d0 Rewording RichTextLabel::remove_line documentation 2020-01-07 08:29:10 +08:00
rainlizard 0a965300e7 doc: Document what happens to old script with Object.set_script() 2020-01-06 13:57:35 +01:00
Rémi Verschelde 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
Rémi Verschelde 7c3543380f
Merge pull request #34848 from clayjohn/DOCS-VisualServer
Finish documenting VisualServer
2020-01-06 08:38:32 +01:00
clayjohn 1905fdfbca Finish documenting VisualServer 2020-01-05 23:10:44 -08:00
Rémi Verschelde e85604e541
Merge pull request #34847 from YeldhamDev/splitcontainer_tabs_docs
Complete the SplitContainer and Tabs documentations
2020-01-06 08:05:04 +01:00
Rémi Verschelde 109f025d83
Merge pull request #34852 from timothyqiu/rtl-doc
Completes the RichTextLabel documentation
2020-01-06 08:04:29 +01:00
Rémi Verschelde 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
Haoyu Qiu 3deb209105 Completes the RichTextLabel documentation 2020-01-06 13:41:39 +08:00
Hugo Locurcio 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
Michael Alexsander 538baea208 Complete the SplitContainer and Tabs documentations 2020-01-05 20:03:08 -03:00
Rémi Verschelde d968d032e9
Merge pull request #34833 from clayjohn/DOCS-VisualServer
Document most VisualServer functions
2020-01-05 22:16:15 +01:00
clayjohn 566ffc2695 Document most VisualServer functions 2020-01-05 12:14:57 -08:00
Rémi Verschelde 482fdfb7f0
Merge pull request #34812 from clayjohn/DOCS-VisualServer
Updated many VisualServer functions
2020-01-05 09:28:47 +01:00
clayjohn 35d288b2ef Updated many VisualServer functions 2020-01-04 16:59:38 -08:00
Rémi Verschelde 8662b74bd6
Merge pull request #34820 from timothyqiu/doc-tree
Improves Tree documentation
2020-01-05 00:04:17 +01:00
Hugo Locurcio 6e79d683fa
Document the return value of `Object.get()` with a nonexistent property 2020-01-04 20:16:10 +01:00
Haoyu Qiu 8a4104acb8 Improves Tree documentation 2020-01-04 20:25:40 +08:00
Michael Alexsander 7e6bfe6a8b Document TabContainer's "use_hidden_tabs_for_min_size" 2020-01-03 16:48:27 -03:00
Rémi Verschelde a18909f945 doc: Sync classref with current source 2020-01-03 15:09:09 +01:00
Rémi Verschelde 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
Hugo Locurcio 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
Rémi Verschelde 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
Ryan Roden-Corrent 98bbee3008
Add note about add_child and owner.
Resolves #34739.
2020-01-02 21:50:31 -05:00
Rémi Verschelde dc2e4cc804
Merge pull request #34736 from cbscribe/kcc_doc_fixes
[DOCS] Class reference typos and fixes.
2020-01-02 20:22:38 +01:00
Chris Bradfield ab11916822 [DOCS] Class reference typos and fixes. 2020-01-02 10:31:16 -08:00
Haoyu Qiu 4d727f1ee6 Allows to doc vararg method return type as void 2020-01-02 21:37:26 +08:00
PouleyKetchoupp 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
Haoyu Qiu 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
Rémi Verschelde 97ebde45d5
Merge pull request #34572 from KoBeWi/I_give_up
Make new ScrollContainer focus behavior optional
2019-12-30 19:00:57 +01:00
Rémi Verschelde 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
Rémi Verschelde 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
Rémi Verschelde 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
Rémi Verschelde 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
Rémi Verschelde 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
Tomasz Chabora cc72885107 Make new ScrollContainer focus behavior optional 2019-12-30 16:40:02 +01:00
Rémi Verschelde 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
Rémi Verschelde 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
Rémi Verschelde 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
Rémi Verschelde 46bc05c5ac
Merge pull request #34576 from rcorre/imgeo-coords
Clarify ImmediateGeometry.add_vertex.
2019-12-30 16:25:21 +01:00
Rémi Verschelde df2968de26
Merge pull request #34571 from rcorre/array_returns
Be more specific about array return values.
2019-12-30 16:22:30 +01:00
Hugo Locurcio 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
Fabian Keller d2690b37fd
shadow_item_cull_mask should reference light mask 2019-12-29 19:06:18 +01:00
Hugo Locurcio 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
Chris Bradfield bc234ce0ae [Docs] Description updates for Node2D & Object 2019-12-26 10:24:29 -08:00
Lakshay Angrish fe9a4ff818 add area_shape_entered usage 2019-12-26 17:30:48 +05:30
Lakshay Angrish c37429b281 add AngelCode format in BitmapFont doc's description 2019-12-26 11:12:02 +05:30
Hugo Locurcio 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
willnationsdev e182aa0d32 Fix KinematicCollision docs mislabeling an ObjectID as an RID. 2019-12-24 15:35:58 -06:00
Ryan Roden-Corrent 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
Ryan Roden-Corrent 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
Rémi Verschelde 56d44aaac9
Merge pull request #34090 from Calinou/doc-improve-basis
Improve the Basis class documentation
2019-12-22 20:37:48 +01:00
Hugo Locurcio bb62c07fce
Improve the Basis class documentation 2019-12-22 18:04:51 +01:00
Hugo Locurcio 0bab51ab55
Fix the Node `process_priority` description to match actual behavior
This closes #34531.
2019-12-22 17:01:56 +01:00
Rémi Verschelde 4bec32a11e
Merge pull request #34400 from alexchond/alexchon
Document DUPLICATE_USE_INSTANCING #2770
2019-12-22 12:36:42 +01:00
Rémi Verschelde 18e4fb3548
Merge pull request #34413 from Zacxalot/vehiclewheel-tooltip
Update VehicleWheel.xml
2019-12-22 12:34:34 +01:00
Rémi Verschelde 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
Tomasz Chabora abbff65dc8 Mention that bbcode_text += string is a bad idea 2019-12-21 10:45:26 +01:00
Tomasz Chabora 2b1fb0375d Mention how to handle cancel in ConfirmationDialog 2019-12-21 00:19:16 +01:00
Rémi Verschelde b3a70f0b80
Merge pull request #34357 from clayjohn/DOCS-VisualServer
Updated docs for many VisualServer methods
2019-12-20 09:20:29 +01:00
clayjohn f88f762240 Updated docs for many VisualServer methods 2019-12-19 18:24:51 -08:00
alexchond e26b066871 DUPlICATE_USING_INSTANCE documentation update 2019-12-19 17:17:57 +02:00
Haoyu Qiu a58deee648 Updates docs of AABB and Plane 2019-12-18 15:14:38 +08:00
Rémi Verschelde 4f18c134b9
Merge pull request #34412 from flyingpimonster/docs-optionbutton
Docs: OptionButton
2019-12-18 07:59:32 +01:00
Zacxalot 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
James Westman 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
Hugo Locurcio 6cf1499eaf
Improve the `KEY_MASK_CMD` documentation 2019-12-17 18:26:21 +01:00
alexchond be3fc17603 Document DUPLICATE_USE_INSTANCING #2770 2019-12-17 13:41:36 +02:00
Rémi Verschelde c64c46db1d doc: Sync classref with current source 2019-12-17 11:43:07 +01:00
Rémi Verschelde f8ea390b52
Merge pull request #34269 from KoBeWi/scrolling_peeps
Scroll ScrollContainer to focused children
2019-12-16 14:03:21 +01:00
Rémi Verschelde 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
Tomasz Chabora 078e9c04d2 Mention how to add slots to GraphNode 2019-12-15 23:29:27 +01:00
Aaron Franke 1b8b380993
Document that translated does not behave like rotated or scaled 2019-12-15 12:31:08 -05:00
Rémi Verschelde 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
Fabio Alessandrelli 04c917899f Add Android NetSocket implementation.
Automatically acquire and release multicast lock when needed.
2019-12-14 18:10:36 +01:00
Fabio Alessandrelli 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
Rémi Verschelde 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
Hannah Crawford 59937e1c54 Updated get_zoom_hbox() documentation. 2019-12-14 14:02:15 +00:00
Danilo Costa Viana 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
Rémi Verschelde 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
Jonas Bernemann 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
Rémi Verschelde 9f68626fb2 doc: Sync classref with current source
Also apply clang-format.
2019-12-13 10:41:06 +01:00
Rémi Verschelde 1cd736951a
Merge pull request #34189 from aaronfranke/mesh-aabb
Expose Mesh get_aabb
2019-12-13 09:14:16 +01:00
Rémi Verschelde 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
Muller-Castro f9db01ec50 Fixed HTTPClient.xml:115 and 121 variant declaration 2019-12-12 15:40:17 -03:00
Rémi Verschelde 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
Tomasz Chabora 77a8657633 Scroll ScrollContainer to focused children 2019-12-11 14:29:36 +01:00
Aaron Franke a139104646
Expose Mesh get_aabb 2019-12-11 08:25:36 -05:00
Rémi Verschelde c868baf658
Merge pull request #34222 from Calinou/doc-collisionshapes
Improve the Shape/Shape2D classes documentation
2019-12-10 10:44:36 +01:00
Hugo Locurcio 16d612dccc
Improve the Shape/Shape2D classes documentation 2019-12-10 08:21:15 +01:00
Hugo Locurcio 3acbabca1e
Document the KinematicBody axis lock methods 2019-12-09 13:45:12 +01:00
Rémi Verschelde 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
Hugo Locurcio 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
Hugo Locurcio 7ae0e4be46
Improve the PCKPacker class documentation 2019-12-07 01:00:51 +01:00
Rémi Verschelde 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
Rémi Verschelde 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
Rémi Verschelde 643b37aaf0
Merge pull request #34086 from Calinou/doc-improve-stylebox
Improve the StyleBox class documentations
2019-12-07 00:10:57 +01:00
Hugo Locurcio 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
Hugo Locurcio f1a76a8820
Improve the StyleBox class documentations 2019-12-06 23:29:38 +01:00
Rémi Verschelde 4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
Hugo Locurcio 7c6c32b500
Document RichTextEffect and CharFXTransform 2019-12-06 22:50:29 +01:00
Rémi Verschelde 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
Rémi Verschelde 4b64ef88d8
Merge pull request #34132 from flyingpimonster/arvr-docs
Docs: ARVRController and ARVRInterface
2019-12-06 08:38:29 +01:00
James Westman 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
Rémi Verschelde 9a12b40100 doc: Fix and clarify AnimationPlayer play and stop descriptions
Closes #34125.
2019-12-05 21:56:31 +01:00
Rémi Verschelde 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
Eoin O'Neill f7f7544997 Added method binding for `multimesh_create` that was missing from VisualServer class. 2019-12-04 16:00:18 -08:00
TerminalJack e1dda5195c Added support for vertical syncing via the Windows OS compositor (DWM.) 2019-12-04 11:14:21 +01:00
Hugo Locurcio bc4dbcf793
Travis CI: Run `makerst.py` to check for documentation errors 2019-12-04 08:51:32 +01:00
bruvzg 0aebba2388
[ci skip] OS class documentations, adds platform compatibility notes. 2019-12-03 18:14:14 +02:00
Rémi Verschelde a74f0fd4cf doc: Fix markup errors 2019-12-03 10:26:20 +01:00
Rémi Verschelde d0243e9e0f
Merge pull request #34077 from Calinou/doc-improve-dynamicfont
Improve the DynamicFont class documentation
2019-12-03 10:18:15 +01:00
Rémi Verschelde dc3d8f0e45
Merge pull request #34076 from Calinou/doc-listener
Add documentation for the Listener class
2019-12-03 10:14:11 +01:00
Hugo Locurcio 673bd79a9e
Improve the DynamicFont class documentation 2019-12-03 09:56:11 +01:00
Hugo Locurcio c6c5a213cd
Add documentation for the Listener class 2019-12-03 09:38:26 +01:00
Hugo Locurcio 73149499c0
Improve the Camera class documentation
This makes the Camera class 100% documented.
2019-12-03 09:37:01 +01:00
Rémi Verschelde 10bae7c05b
Merge pull request #33857 from nekomatata/polygon-2d-antialiasing
Fixed antialiased option for Polygon2D
2019-12-03 07:51:16 +01:00
Rémi Verschelde 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
Aaron Franke 3231fca934
Add docs for is_equal_approx on structures 2019-11-30 16:52:27 -05:00
miere43 d747c61187 Fixed typo in docs for Script and GDScript classes ("exends" -> "extends") 2019-11-30 21:16:11 +03:00
James Westman 7ef16ca136 Docs: GridMap and MeshLibrary
The only methods left to document are resource_changed, set_clip, and
the methods dealing with baked meshes.
2019-11-29 18:21:34 -06:00
Rémi Verschelde 55676b16da makerst: Escape default values using reST markup
Otherwise the docs would complain about values like "godot_"
which reST tries to interpret as an identifier.
2019-11-29 14:25:37 +01:00
PouleyKetchoupp e6ebc43d72 Fixed antialiased option for Polygon2D / Line2D
Polygon2D:
The property wasn't used anymore after switching from canvas_item_add_polygon() to canvas_item_add_triangle_array() for drawing.

Line2D:
Added the same property as for Polygon2D & fixed smooth line drawing to use indices correctly.

Fixes #26823
2019-11-28 22:57:27 +01:00
Hugo Locurcio 21a3923410
Add an `OS.is_window_focused()` getter
This makes it possible to know whether the window is focused
at a given time, without having to track the focus state manually
using `NOTIFICATION_WM_FOCUS_IN` and `NOTIFICATION_WM_FOCUS_OUT`.

This partially addresses #33928.
2019-11-28 16:42:51 +01:00
Hugo Locurcio 77d95e3371
Document the `ViewportContainer.stretch_shrink` property 2019-11-27 16:40:40 +01:00
HaSa1002 5be5f65440 document popup behaviour 2019-11-27 11:47:19 +01:00
Hugo Locurcio 639c9b3a35
Only display Environment sky rotation in degrees in the Inspector
This makes it consistent with Spatial.
2019-11-26 18:57:29 +01:00
Rémi Verschelde 934f6f2529
Merge pull request #33867 from rcorre/get_node_docs
Clarify get_node vs get_node_or_null.
2019-11-25 14:35:45 +01:00
Rémi Verschelde 967cc2c014
Merge pull request #33862 from Faless/net/http_request_chunk_size
Add download_chunk_size property to HTTPRequest.
2019-11-25 14:29:59 +01:00
Fabio Alessandrelli ed19b4076e Add download_chunk_size property to HTTPRequest.
This allows setting the `read_chunk_size` of the internal HTTPClient.
This is important to reduce the allocation overhead and number of file
writes when downloading large files, allowing for better download speed.
2019-11-24 19:32:20 +01:00
Robert Colton c99f6453b9
Update Viewport.xml
Add description for gui_is_dragging to document drag and drop behavior.
2019-11-24 10:45:04 -05:00
Rémi Verschelde ab3bccdb78 Fix typos with codespell
Using codespell 1.16.0.

Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
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
```
2019-11-22 08:35:03 +01:00
Benjamin Navarro b81f9f777f Better description of the binds parameter of connect
Now states how binds are handled if they are used together with parameters passed to emit_signal
2019-11-21 09:15:58 +01:00
merumelu 94fc676019 Editor: fix typo in VCS plugin method names 2019-11-19 15:11:03 +01:00
Rémi Verschelde cc025fc8e7
Merge pull request #33663 from Calinou/add-node-get-process-priority
Implement `Node::get_process_priority()` and its associated property
2019-11-17 21:43:28 +01:00
Hugo Locurcio ae76c62601
Implement `Node::get_process_priority()` and its associated property
This closes #33660.
2019-11-17 17:48:50 +01:00
Rémi Verschelde f392c4ea7a
Merge pull request #33658 from NeoSpark314/rename_ext_msaa
Rename External MSAA to AndroidVR MSAA
2019-11-16 22:52:51 +01:00
Holger Dammertz 1b9c2ec92e Rename External MSAA to AndroidVR MSAA
A new external MSAA setting was introduced in https://github.com/godotengine/godot/pull/33518
that fixed issues on GLES2 and Oculus Mobile VR. To avoid misunderstanding it was suggested
by @BastiaanOlij and discussed on discord to rename it to AndroidVR.
2019-11-16 15:36:43 +01:00
willnationsdev db0082534c Added more in-depth examples of NodePaths in API docs. 2019-11-13 15:14:50 -06:00
Rémi Verschelde d3a852f124
Merge pull request #33591 from zaksnet/fix-string-docs-split
Fix split/rsplit docs
2019-11-13 14:03:14 +01:00
Zak 79aca6b0c0 Fix split/rsplit docs 2019-11-13 14:58:19 +02:00
Rémi Verschelde 35444576ff
Merge pull request #33576 from merumelu/doc-reload-current-scene
Doc: Add return values for SceneTree::reload_current_scene
2019-11-12 23:17:51 +01:00
IlyaStuurFedorov fa45fdb5f5 doc: PCKPacker class example code 2019-11-12 23:15:29 +01:00
merumelu 3de002db30 Doc: Add return values for SceneTree::reload_current_scene 2019-11-12 16:43:31 +01:00
Rémi Verschelde 067c259ef1 doc: Sync classref with current source 2019-11-11 17:25:05 +01:00
Hugo Locurcio ecd572073c
Mention that `Dictionary.hash()` can be used for equality comparisons
See #27615.
2019-11-11 14:18:11 +01:00
Rémi Verschelde 4b8feff594
Merge pull request #33518 from BastiaanOlij/msaa_ext_modes
Add MSAA mode for Quest
2019-11-11 11:46:50 +01:00
Bastiaan Olij 4e2343160c Add special external MSAA modes for GLES2 Rift S/Quest and OpenXR optimisation 2019-11-11 21:02:06 +11:00
Rémi Verschelde 43fec5806d
Merge pull request #33453 from Calinou/expose-low-processor-mode-sleep-usec
Expose the `OS.low_processor_usage_mode_sleep_usec` property
2019-11-11 08:11:30 +01:00
Rémi Verschelde 723dceb727
Merge pull request #33496 from QbieShay/spring-arm-doc
Added documentation for SpringArm doc
2019-11-11 06:47:11 +01:00
QbieShay 6d27c50ae7 Added documentation for SpringArm doc 2019-11-10 14:21:06 +01:00
Rémi Verschelde 6c557b8bdf Camera: Don't set default value for project_position
A z_depth of 0 returns the camera position, which is not really useful.
This also makes the API breakage from 3.1 clearer as 3.1 code will now
fail to compile, so users will have to adapt and use the new parameter.

For the reference, in 3.1, the z_depth was hardcoded to the near plane.

Closes #33493.
2019-11-10 00:17:26 +01:00
Rémi Verschelde 0ab0d11c17
Merge pull request #33464 from KoBeWi/backdroid
Clarify how to handle go back button on mobile
2019-11-09 07:44:48 +01:00
Tomasz Chabora 5d618b0570 Clarify how to handle go back button on mobile 2019-11-09 00:15:50 +01:00
Tomasz Chabora 2bde99f790 Fix some small text mistakes 2019-11-08 23:31:29 +01:00
Hugo Locurcio e6d53ba75f
Expose the `OS.low_processor_usage_mode_sleep_usec` property
This makes it possible to change it at runtime in projects.
2019-11-08 18:53:25 +01:00
Rémi Verschelde 9d4e596c69 doc: Sync classref with current source
Fix incomplete binding.
2019-11-08 16:00:01 +01:00
Gilles Roudière 12c2363290 Clarify shape_centered property 2019-11-08 11:11:45 +01:00
Rémi Verschelde 1f76229378 doc: Sync classref with current source 2019-11-08 08:33:48 +01:00
Rémi Verschelde e4d734725a
Merge pull request #33412 from Calinou/doc-httprequest-example
Add an HTTPRequest usage example to the class reference
2019-11-07 21:37:21 +01:00
Yuri Roubinsky 4c4172ec92 Added link to raycasting tutorial to RayCast/RayCast2D 2019-11-07 22:47:50 +03:00
Hugo Locurcio 06fc43d41c
Add an HTTPRequest usage example to the class reference
This also adds a link to the "Making HTTP requests" tutorial.
2019-11-07 16:49:21 +01:00
Rémi Verschelde 18d06f4d4f
Merge pull request #32900 from willnationsdev/variant-docs
Updated Variant docs with more detailed info/tuts.
2019-11-07 13:15:34 +01:00
Rémi Verschelde 1e8b7a160f
Merge pull request #31209 from ReyAnthony/master
Added more details for set_drag_preview()
2019-11-07 13:14:32 +01:00
Rémi Verschelde 121fb46ab9 Clarify that String.insert returns a copy
Supersedes and closes #32620.
2019-11-07 13:12:06 +01:00
Anthony Rey e4b97b4614 [Doc] Added more details for set_drag_preview() 2019-11-07 12:43:04 +01:00
Rémi Verschelde ed373a60b1
Merge pull request #30556 from kawa-yoiko/astar-directed
Improve support for directed graphs in A*; docs update included
2019-11-07 12:33:27 +01:00
Hugo Locurcio 8ca0f1a71c
Remove unused `editor/active` project setting
This closes #33322.
2019-11-04 14:35:46 +01:00
Rémi Verschelde 60182d6b5a
Merge pull request #33261 from Jummit/document-tilemap
Finish TileMap documentation
2019-11-02 23:09:01 +01:00
Rémi Verschelde ab2881bca1
Merge pull request #33243 from Muller-Castro/BackBufferCopyDescription
Make BackBufferCopy's description more specific
2019-11-02 19:31:57 +01:00
Rémi Verschelde 79918eca30
Merge pull request #33151 from thiagoamendola/doc_setpixelv
Add documentation for Image's set_pixelv method
2019-11-02 19:30:57 +01:00
Thiago Amendola ecb4c70ed3 Add documentation for Image's set_pixelv method 2019-11-02 15:06:47 -03:00
PouleyKetchoupp 52e799b6d4 Code format for true/false/null to make documentation consistent 2019-11-02 12:14:15 +01:00
Jummit b90ec3b442 finish TileMap docs 2019-11-02 11:49:40 +01:00
Muller-Castro 5bf08ae836 Make BackBufferCopy's description more specific
The current description can be confusing for those who didn't mess with shaders yet and couldn't find SCREEN_TEXTURE and texture() in the SHIFT+F1 panel
2019-11-01 19:48:32 -03:00
Rémi Verschelde a49c8d4a2b
Merge pull request #33202 from nekomatata/text-edit-search-usability
Improved TextEdit search usability & documentation
2019-11-01 14:10:00 +01:00
Rémi Verschelde 83d393a71a
Merge pull request #33209 from Jummit/soft-body-tutorial
Link SoftBody tutorial in docs
2019-11-01 14:04:50 +01:00
Rémi Verschelde 962fc725c0
Merge pull request #33210 from nekomatata/pool-array-empty
Added empty() function to pool array types
2019-11-01 14:04:16 +01:00
Rémi Verschelde 81b53f5a5c
Merge pull request #33211 from drentsoft/os_midi_documentation_branch
Added documentation for the OS class MIDI functions.
2019-11-01 14:04:01 +01:00
Rémi Verschelde d93201b27f
Merge pull request #33229 from Jummit/document-force_update_transform
Document force_update_transform
2019-11-01 14:03:01 +01:00
Jummit 2166437869 document force_update_transform 2019-11-01 10:37:39 +01:00
Jummit ce61bff759 link SoftBody tutorial in docs and add ray_pickable property 2019-11-01 08:51:25 +01:00
Derwent Ready (drentsoft) 1758a6f494 Added link to Area2D tutorial in documentation. 2019-10-31 20:59:13 +00:00
Derwent Ready (drentsoft) 1e07ab8564 Added documentation for the OS class MIDI functions. 2019-10-31 16:52:55 +00:00
PouleyKetchoupp 475115c0c3 Added empty() function to pool array types 2019-10-31 16:27:32 +01:00
PouleyKetchoupp d29c8ab81b Improved TextEdit search usability & documentation 2019-10-31 12:35:23 +01:00
Rémi Verschelde ac38f0782f
Merge pull request #33195 from conankzhang/doc-project-settings
Add descriptions to set_initial_value and set_setting.
2019-10-31 08:04:46 +01:00
conankzhang e72d6cf54a Add descriptions to set_initial_value and set_setting. 2019-10-30 23:39:24 -07:00
conankzhang d69ed2fc55 Add descriptions to clear and copy_theme. 2019-10-30 23:04:58 -07:00
bruvzg f675621725
[macOS, Windows, X11] Add graphic tablet pen pressure and tilt support to InputEventMouseMotion event. 2019-10-30 14:42:21 +02:00
Rémi Verschelde 924db5fa58
Merge pull request #33176 from conankzhang/doc-spatial-scale
Add descriptions to scale functions.
2019-10-30 13:25:51 +01:00
conankzhang 29844a5862 Add descriptions to scale functions. 2019-10-30 03:19:08 -07:00
conankzhang 709c1bf051 Add descriptions to setting and getting draw pass meshes. 2019-10-30 01:09:26 -07:00
Michael Alexsander d92123ed97 Add "panel" style to PopupDialog 2019-10-27 19:45:03 -03:00
Rémi Verschelde 3d25a403ef
Merge pull request #32748 from SamuelDeboni/doc-VisualShader
Added documentation for VisualShader
2019-10-26 23:05:44 +02:00
Rémi Verschelde aa0fa6b14f doc: Sync classref with current source 2019-10-26 16:40:41 +02:00
Rémi Verschelde dea24f50c7
Merge pull request #33038 from Calinou/makerst-add-separators
makerst: Separate signals/enums/properties/methods with a line
2019-10-25 23:30:58 +02:00
Hugo Locurcio a57c265266
Document `override.cfg` behavior in the ProjectSettings class 2019-10-25 21:54:38 +02:00
20kdc 170668d92e Document AnimationPlayer's quirks in regards to play updating on next process & similar. (Squashed Edition) 2019-10-24 20:11:12 +01:00
Hugo Locurcio c2e5ef4cec
makerst: Separate signals/enums/properties/methods with a line 2019-10-24 19:06:09 +02:00
Rémi Verschelde 4e29faaeea
Merge pull request #32600 from cagdasc/3.2-auto-permission-manager
Add request defined permissions in AndroidManifest.xml
2019-10-23 08:02:21 +02:00
Rémi Verschelde 29990d0b1e
Merge pull request #32994 from Calinou/http-document-body-length-caveats
Mention body length getter caveats in HTTPClient and HTTPRequest
2019-10-23 06:50:41 +02:00
Cagdas 0088385556 Add request permission automatically at android 2019-10-22 22:52:13 +03:00
Rémi Verschelde 9f28803927
Merge pull request #32940 from nekomatata/text-edit-clear-colors
TextEdit syntax highlighting fixes
2019-10-22 20:40:20 +02:00