Commit Graph

2386 Commits

Author SHA1 Message Date
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