Commit Graph

2631 Commits

Author SHA1 Message Date
Rémi Verschelde 49eef1180b
Merge pull request #36135 from akien-mga/doc-update
doc: Sync classref with current source
2020-02-12 13:29:44 +01:00
Rémi Verschelde 0e3d625737 doc: Sync classref with current source
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.

Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00
Hanif Bin Ariffin 7bc1dc828f Remove deprecated Color::gray
It was marked to be removed in Godot 3.1.

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-02-12 11:22:33 +01:00
Juan Linietsky 9b0dd4f571 A lot of progress with canvas rendering, still far from working. 2020-02-11 11:53:27 +01:00
Rémi Verschelde 6fb6405408
Merge pull request #36072 from RandomShaper/imvu/configfile_parse
Add ConfigFile::parse()
2020-02-11 09:21:45 +01:00
Rémi Verschelde 2dd73b1ffa
Merge pull request #34776 from AndreaCatania/nav_pr
Integrated the new `NavigationServer` and `NavigationServer2D`
2020-02-10 16:25:21 +01:00
Duroxxigar 383c583a0b Documented the new NavigationServer and all its associated nodes (2D and 3D) 2020-02-10 15:24:06 +01:00
muiroc e51c6a0d28 Allow per pixel transparency in javascript platform 2020-02-10 14:27:30 +01:00
Pedro J. Estébanez e5bd3b707f Add ConfigFile::parse() 2020-02-10 11:12:33 +01:00
Rémi Verschelde 0f80df0dc4
Merge pull request #35858 from MostafaMTH/doc_editor_inspector
Brief and Description for Editor Inspector
2020-02-09 12:55:13 +01:00
Rémi Verschelde 51863f6e1e Merge pull request #35808 from clayjohn/unexpose-compress-base
Unexpose ARRAY_COMPRESS_BASE
2020-02-09 12:54:24 +01:00
Rémi Verschelde 7f95e027b4
Merge pull request #35814 from timothyqiu/line-edit-shortcut
Adds CTRL-A CTRL-E support to LineEdit on macOS
2020-02-09 12:51:59 +01:00
Rémi Verschelde de932a5285 doc: Sync classref with current source 2020-02-09 00:34:08 +01:00
Hugo Locurcio 95f6be365a
Update EditorSceneImporterAssimp description to reflect current status 2020-02-08 21:46:10 +01:00
Rémi Verschelde 6b42d83ff1
Merge pull request #35950 from Chaosus/vs_scalar_uniform_range
Implemented hint_range for VisualShaderNodeScalarUniform
2020-02-07 20:45:40 +01:00
Rémi Verschelde 3fba20141b
Merge pull request #35925 from seenloitering/doc-Skeleton2D
Add documentation for Skeleton2D
2020-02-07 17:44:14 +01:00
Yuri Roubinsky 22ad83edae Implemented hint_range for VisualShaderNodeScalarUniform 2020-02-07 17:04:24 +03:00
Haoyu Qiu 7a41c44be2 Completes doc for ItemList and Tree 2020-02-07 12:52:53 +08:00
Yuri Roubinsky d9b39abbeb Fixed Grammer 2020-02-06 22:00:48 +02:00
Rémi Verschelde c358399f81
Merge pull request #35911 from clayjohn/DOCS-misc3
Finish documenting BakedLightmap and TextureLayered
2020-02-05 21:05:34 +01:00
clayjohn 5643bc71f7 Finish documenting BakedLightmap and TextureLayered 2020-02-05 08:13:34 -08:00
Rémi Verschelde 0317d49951
Merge pull request #35807 from Calinou/improve-doc-status-output
Improve the `doc_status.py` console output
2020-02-05 16:59:16 +01:00
seenloitering 9151992432 Add documentation for Skeleton2D
Signal bone_setup_changed remains undocumented. I took a quick look at
the cpp code, but its purpose remained unclear to me. If anyone can
steer me in the right direction, I'm happy to flesh this out.
2020-02-05 07:19:27 -05:00
Haoyu Qiu db42d5ddff Completes doc for button classes 2020-02-05 08:44:16 +08:00
Rémi Verschelde 0edcb8ed58
Merge pull request #35809 from clayjohn/DOCS-update-version
Update docs to version 4.0
2020-02-01 19:42:31 +01:00
Haoyu Qiu 4774043f8e Adds CTRL-A CTRL-E support to LineEdit on macOS 2020-02-01 13:35:16 +08:00
clayjohn 57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08:00
clayjohn be39808b00 Unexpose ARRAY_COMPRESS_BASE 2020-01-31 16:29:46 -08:00
Hugo Locurcio 7c3f6b2870
Improve the `doc_status.py` console output
- Duplicate the header when the `-a` flag is enabled. Since lots of
  items are displayed in this case, this helps the user remember
  which column is which without having to scroll back to the top.
- Bolden the overall percentages for easier visual grepping.
2020-02-01 00:24:39 +01:00
Hugo Locurcio 1de9118c5f
doc: Add an example for `Array.sort()`
This may help people understand the difference between alphabetical
and natural order more quickly.
2020-01-31 21:23:09 +01:00
Rémi Verschelde dfcfa7d256
Merge pull request #35790 from Calinou/doc-animationplayer-vs-tween
doc: Add a short AnimationPlayer versus Tween comparison
2020-01-31 18:29:34 +01:00
Hugo Locurcio 810b1341ce
doc: Add a short AnimationPlayer versus Tween comparison
Many newcomers are confused about which one to choose for animating
properties. This should help clarify the situation with regards
to AnimationPlayer versus Tween.
2020-01-31 18:00:15 +01:00
Hugo Locurcio c9946bc87e
Improve the CheckBox and CheckButton class documentations
This makes the CheckBox and CheckButton classes 100% documented.
2020-01-31 13:17:20 +01:00
Rémi Verschelde 68eae6b6e9 Fix some URLs to use HTTPS when available 2020-01-29 02:48:10 +01:00
Hugo Locurcio 8ea77b96b2
Mention 2D polygon limits and how to increase them in the documentation
This closes #21793.
2020-01-28 22:04:29 +01:00
Rémi Verschelde 658e44ee01 doc: Sync classref with current source
Fix a few typos.
2020-01-28 10:58:48 +01:00
Yuri Roubinsky 766d1ef276 Docs for some nodes in visual shader(part 2) 2020-01-28 12:16:09 +03:00
Yuri Roubinsky 9705d5587e Hide "control" methods from VisualShaderNodeGroupBase 2020-01-28 10:24:59 +03:00
Yuri Roubinsky 274f1d8610 Hide "editable" property from VisualShaderNodeGroupBase public interface 2020-01-28 09:43:07 +03:00
Yuri Roubinsky 796484d761 Added missing property "size" to VisualShaderNodeGroupBase 2020-01-27 19:18:48 +03:00
Yuri Roubinsky 3479cf4b42 Removed unused method "build" from VisualShaderNodeExpression 2020-01-27 18:24:39 +03:00
Tomasz Chabora 21dd35b611 Document theme_items of multiple classes 2020-01-27 02:15:37 +01:00
Hugo Locurcio 75185f87a3
doc: Remove mention of nonexistent StaticBody simulated motion mode
The StaticBody2D documentation doesn't mention it, so it doesn't need
to be touched.

This closes #30560.
2020-01-26 20:18:22 +01:00
Rémi Verschelde 4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property
doc: Drop unused 'category' property from header
2020-01-26 16:34:13 +01:00
Rémi Verschelde 09ced94dd4 doc: Do not expose Variant::NIL as a type in the class reference
Fix signals Variant arguments incorrectly listed as Nil.

Fixes #12520.
2020-01-26 16:08:11 +01:00
Rémi Verschelde 2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
Rémi Verschelde 3697ea799c doc: Document all remaining ProjectSettings 2020-01-26 13:37:21 +01:00
Rémi Verschelde fe26e53065
Merge pull request #35581 from akien-mga/doc-color-constants
doc: Document named color constants
2020-01-26 13:36:44 +01:00
Rémi Verschelde cbdbfb00ca doc: Document named color constants
Busywork but it's good for our completion rate :)
2020-01-26 12:08:16 +01:00
Rémi Verschelde bb6c0d3e8b doc: Complete documentation for VideoStreams
Also quick clean up of the matching C++ files.
2020-01-26 11:29:07 +01:00
Rémi Verschelde bd605a5701
Merge pull request #35566 from Xrayez/doc-parse-property-return
Document the return value of `EditorInspectorPlugin.parse_property`
2020-01-26 10:17:57 +01:00
Rémi Verschelde 6a5c8c8672
Merge pull request #35574 from clayjohn/DOCS-odds-n-ends
Complete various class references
2020-01-26 10:08:55 +01:00
clayjohn c5700f7464 Complete various class references 2020-01-26 00:27:51 -08:00
Rémi Verschelde 1b3eb41622
Merge pull request #35561 from clayjohn/GLES3-irradiance-max
Add project setting for max irradiance size
2020-01-26 09:16:21 +01:00
Andrii Doroshenko (Xrayez) 06933f5d80 Document the return value of `EditorInspectorPlugin.parse_property` 2020-01-26 02:04:33 +02:00
Rémi Verschelde be1bc53d42
Merge pull request #35560 from clayjohn/DOCS-sky-radiance
Add warning for radiance_size
2020-01-25 23:01:58 +01:00
clayjohn 7215019020 Add warning for radiance_size 2020-01-25 13:28:32 -08:00
clayjohn eb5cb5d016 Add project setting for max irradiance size 2020-01-25 13:27:13 -08:00
Rémi Verschelde 8896ce1c0a
Merge pull request #35559 from Calinou/doc-inputeventkey-string
Document how to get a human-readable string from an InputEventKey
2020-01-25 21:52:35 +01:00
Hugo Locurcio 7a0c37c3f5
Document how to get a human-readable string from an InputEventKey 2020-01-25 20:13:18 +01:00
Hugo Locurcio 33f37cfd19
Document how to get chamfered corners with StyleBoxFlat 2020-01-25 20:04:23 +01:00
Rémi Verschelde a61f5a7520
Merge pull request #35535 from Calinou/doc-projectsettings-runtime-physics
Document how to change the default gravity at runtime
2020-01-25 18:16:34 +01:00
Hugo Locurcio 1b9b07e658
Document how to change the default gravity at runtime
Changing the default gravity at runtime isn't exactly obvious,
so it makes sense to add a code sample.
2020-01-25 16:28:28 +01:00
Rémi Verschelde e61edd69ea
Merge pull request #35523 from searetseltev/master
Update ScrollContainer.xml
2020-01-24 21:53:57 +01:00
Roi Valcárcel 4f0401d05d Update ScrollContainer.xml
Add missing descriptions to ScrollContainer documentation
2020-01-24 17:21:53 +01:00
Tomasz Chabora 25ea912d96 Count theme items in doc_status.py 2020-01-24 14:23:58 +01:00
Rémi Verschelde 97cc2e53f6 makerst: Escape reST markup after enums
Fixes #35501.
2020-01-24 13:08:36 +01:00
Yuri Roubinsky ce43c92208 Docs for some nodes in visual shader
Fix typo in `VisualShaderNodeCompare.ComparisonType` name.
2020-01-23 22:39:00 +01:00
Rémi Verschelde c66144738b
Merge pull request #35483 from YeldhamDev/doc_comment_spaces_removal
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 21:58:12 +01:00
Michael Alexsander c4745c96d7 Remove unnecessary extra spaces before comments in code examples. 2020-01-23 14:41:49 -03:00
Michael Alexsander e1a9a3328d Remove unnecessary parenthesis from code examples 2020-01-23 14:15:39 -03:00
clayjohn 6b66957b85 Finish documenting CSG* and *probes 2020-01-23 13:54:17 +01:00
Rémi Verschelde ba177ccaec doc: Misc updates for AnimationNode* and others
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
2020-01-23 12:37:33 +01:00
Hugo Locurcio 90a1f8d8a7
Make `OS.execute()` blocking by default if not specified
This makes `OS.execute()` calls quicker to set up when calling programs
in a blocking fashion.
2020-01-23 01:26:32 +01:00
Bojidar Marinov b4770c0a27
Add settings from SceneTree in the documentation
Fixes #35439
2020-01-22 22:37:56 +02:00
Bojidar Marinov 387ee7d763
Get real default values for project settings in documentation
Also, ignore custom project settings and values for input/ entries

Fixes #34154
2020-01-22 15:57:10 +02:00
Rémi Verschelde 829d21f1c2
Merge pull request #35352 from Feniks-Gaming/BetterDictionary
Improve dictionary description
2020-01-22 13:20:41 +01:00
Rémi Verschelde de543d18e8
Merge pull request #35389 from clayjohn/DOCS-materials
Finish up docs for materials
2020-01-22 07:41:33 +01:00
clayjohn f2ece82480 Finish up docs for materials 2020-01-21 19:28:32 -08:00
Rémi Verschelde 1508cc4051
Merge pull request #35363 from ericrybick/33106-importing-textureAtlas-cuts-out-the-sprites
Fix AtlasPacker ignoring semi-transparent pixels
2020-01-21 00:13:12 +01:00
Eric Rybicki 439e0027ec Fix AtlasPacker ignoring semi-transparent pixels
Fixes #33106
2020-01-20 22:43:38 +01:00
Feniks 6e24933115 Improve dictionary description
I improved dictionary description to ad some real life examples and expand on it a little bit so person who never seen dictionary can understand it better seeing them for a first time here. 
I also added note about the way to compare dictionaries  as it can catch people of guard because common assumption is that it works the same as comparing Arrays when it does not.
2020-01-20 20:36:59 +00:00
Rémi Verschelde 837adb30fd Revert "Exposes capture methods to AudioServer + documentation" #30468
Reverts the following commits:

- c81ec6f26d40b70283958a4ef3e216fb32cbaf14:
  "Exposes capture methods to AudioServer, variable renames for
  consistency, added documentation."
- 47c558b98abf842910c780294314326662410cdf:
  "Expose audio callbacks as signals."
- dabaa11b3c451e9b8f2cca7e563bd9ec51edb169:
  "Fix to make sure the capture buffers are deallocated at shutdown.
  Silences warnings."

Some documentation improvements were kept for pre-existing methods.

See rationale for reverting these changes in #30468.
2020-01-20 13:18:01 +01:00
Rémi Verschelde c0595206dd makerst: Use code markup for default values/overrides
Fixes godotengine/godot-docs#3071.
2020-01-20 12:38:08 +01:00
Rémi Verschelde adb6734b49 doc: Sync classref with current source 2020-01-19 23:19:29 +01:00
Rémi Verschelde 62d656ea06
Merge pull request #35327 from KoBeWi/globalization
Mention that KinematicCollisions use global coords
2020-01-19 22:25:10 +01:00
Rémi Verschelde cb088e391e
Merge pull request #35300 from Feniks-Gaming/GraphNodeDesc
Improve Description of GraphNode
2020-01-19 22:19:41 +01:00
Tomasz Chabora 5a75c4a840 Mention that KinematicCollisions use global coords 2020-01-19 20:22:31 +01:00
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