Commit graph

3621 commits

Author SHA1 Message Date
Rémi Verschelde 75d03f1fbd
Merge pull request #46446 from Faless/js/4.x_jsdoc
[HTML5] Document Engine and EngineConfig (jsdoc).
2021-02-26 15:31:44 +01:00
Fabio Alessandrelli 472482013e [HTML5] Add jsdoc2rst tool.
A template for `jsdoc` that generat the HTML5 public classref.

The script can be run via `npm run docs` to print to stdout.

You can dry run via `npm run docs -- --d dry-run` or write to file via
`npm run docs -- -d /path/to/file.rst`

Also update Makefile in `doc/` and add dry run test to CI.
2021-02-26 11:33:59 +01:00
Haoyu Qiu 31243e377f Fixes typo in Array::bsearch_custom doc 2021-02-26 18:01:08 +08:00
Emmanuel Leblond 60d2c1fd47
Remove GDScript bindings for OS.get/set_exit_code, SceneTree.quit(<exit_code>) should be used instead 2021-02-25 18:34:50 +01:00
Rémi Verschelde f01e95eb55
Merge pull request #46416 from nekomatata/draw-collision-outline-option
Added option in project settings to draw Shape2D outlines
2021-02-25 17:15:22 +01:00
PouleyKetchoupp c4b116cff7 Added option in project settings to draw Shape2D outlines
Disabling collision outlines can be useful for performance when the game
is running and many collision shapes are displayed.
2021-02-25 07:52:50 -07:00
Hugo Locurcio 355803db1b
Improve the OS.get_environment()/OS.set_environment() documentation 2021-02-25 15:38:51 +01:00
Bastiaan Olij 4c8f5b998f Expose set_environment to GDScript 2021-02-25 23:36:14 +11:00
Rémi Verschelde 305683f83b
Merge pull request #46360 from nmrkr/drag-preview-crash-after-free
Fix crash during drag if user queue_free'd the drag preview
2021-02-24 22:43:53 +01:00
Delf Neumärker eaa04c1a22
Fix crash during drag if user freed the drag preview 2021-02-24 20:59:17 +01:00
abaire 61cc1c8624 Relaxes Node naming constraints in glTF documents to match the Editor. 2021-02-24 08:22:27 -08:00
Rémi Verschelde a527c6856b
Merge pull request #46045 from bruvzg/text_server_bmp_create
[TextServer] Restores bitmap font dynamic construction functions.
2021-02-24 12:55:36 +01:00
Aaron Franke 548de64742
Use a more specific type for Area2D/3D body signals 2021-02-24 00:05:54 -05:00
Rémi Verschelde cb29e6c49c
Merge pull request #45994 from Jummit/expose-edit-selected
Expose edit_selected in Tree
2021-02-22 16:29:03 +01:00
Jummit 13fb24cb6f expose edit_selected in Tree 2021-02-22 15:50:21 +01:00
Rémi Verschelde 8107cbd66e
Merge pull request #45934 from angad-k/fix-smoothstep-function-documentation
fix minor issue in smooth step function's documentation
2021-02-22 12:38:47 +01:00
Rémi Verschelde 40191a748b
Merge pull request #46253 from asmaloney/docs-theme
[docs] Clarification on theme's get_stylebox
2021-02-22 10:35:35 +01:00
Hugo Locurcio 159581739a
Document theming a SpinBox's background
This closes #46248.
2021-02-21 19:32:11 +01:00
Hugo Locurcio f6087d3f2b
Document that Button doesn't interpret touch input (= no multitouch)
TouchScreenButton should be used for gameplay actions instead.
2021-02-21 00:30:21 +01:00
Andy Maloney d397c32169 [docs] Clarification on theme's get_stylebox
Remove reference to "icon" (must have been a copy-paste error) & clarify where to find out what names & node_types are valid.
2021-02-20 10:10:28 -05:00
Aaron Franke 78de8a762b
Update documentation for the new ProcessMode 2021-02-19 10:22:09 -05:00
Rémi Verschelde efddb8a0cb
Merge pull request #46194 from Calinou/os-delay-no-negative
Don't allow negative values for `OS.delay_usec()`/`OS.delay_msec()`
2021-02-19 15:14:36 +01:00
Rémi Verschelde bc395c2549
Merge pull request #46221 from akien-mga/doc-sync-classref
doc: Sync classref with current source
2021-02-19 15:06:50 +01:00
Rémi Verschelde 0d1d719178 doc: Sync classref with current source
And fix various bogus bindings following previous PRs.
2021-02-19 14:39:14 +01:00
Rémi Verschelde aaaaaf5bb6
Merge pull request #46219 from pycbouh/doc-editor-plugin-build
Add documentation for EditorPlugin's build method
2021-02-19 13:59:00 +01:00
Rémi Verschelde b84f65f13c
Merge pull request #44737 from KoBeWi/touch_shape_screen_centered_button
Fix shape_centered property in TouchScreenButton
2021-02-19 13:45:23 +01:00
Yuri Sizov 724ed88215 Add documentation for EditorPlugin's build method 2021-02-19 15:42:41 +03:00
Hugo Locurcio 76f1f9b3c5
Don't allow negative values for OS.delay_usec()/OS.delay_msec()
This closes #46190.
2021-02-18 23:01:45 +01:00
bruvzg 3e0262509f
Move tablet driver API from OS to DisplayServer. 2021-02-18 17:12:24 +02:00
Jitesh c3be0c2c04 Add animation_finished signal and fix frame_changed signal for AnimatedSprite3D
Fixes #40301.
Fixes #45947.
2021-02-17 15:13:47 +01:00
JestemStefan 2c71ff1119
Added signed_angle_to for Vector3 2021-02-16 05:07:33 -05:00
PouleyKetchoupp 4586357dde Expose RichTextLabel selection to script
Expose existing get_selection_text and add methods to get the current
selection index from and index to.
2021-02-15 17:26:58 -07:00
Rémi Verschelde 9335f4de70
Merge pull request #45991 from goostengine/makerst-filter
makerst: Add an option to filter which XML classes to output
2021-02-15 13:46:24 +01:00
Andrii Doroshenko (Xrayez) 7fcdd15f0c makerst: Add an option to filter which XML classes to output
Usage:
```
# Output `VisualScript` classes only (found in `modules/visual_script`)
python doc/tools/makerst.py "doc/classes" "modules" --filter "visual_script"

# Output CSG classes only (found in `modules/csg`)
python doc/tools/makerst.py "doc/classes" "modules" --filter "csg"
```
2021-02-15 14:28:11 +02:00
Rémi Verschelde e13312db79
Merge pull request #46028 from Beuc/patch-passby
doc: explain TouchScreenButton passby mode
2021-02-15 12:54:25 +01:00
Sylvain Beucler 9e21077fad doc: explain TouchScreenButton passby mode 2021-02-15 11:45:58 +01:00
Rémi Verschelde 3f6295a1ed
Merge pull request #45855 from hoontee/fix-45718
Implement CollisionPolygon3D margin
2021-02-15 11:23:15 +01:00
bruvzg bee718f1af
[Text Server] Restores bitmap font dynamic construction functions. 2021-02-15 10:46:49 +02:00
bruvzg f4d095cdd3
[TextServer] Restore character and space extra spacing support. 2021-02-15 10:46:23 +02:00
bruvzg d78336c65e
[CTL] Add missing font outline drawing routines and theme constants. 2021-02-14 14:11:44 +02:00
Hugo Locurcio ab397460e9
Expose a File.flush() method to scripting
This can be used to ensure a file has its contents saved
even if the project crashes or is killed by the user
(among other use cases).

See discussion in #29075.
2021-02-13 01:37:16 +01:00
Angad Kambli 892060fa47 fix minor issue in smooth step function's documentation 2021-02-13 02:12:58 +05:30
Emily 7368bc534a fixed typo in packedscene 2021-02-11 13:22:44 -08:00
hoontee fbb1ef759c Implement CollisionPolygon3D margin 2021-02-11 11:58:37 -06:00
Rémi Verschelde 604188c411
Merge pull request #45870 from gongpha/graphedit-connection-update
Update GraphEdit when GraphNode's slot is updated
2021-02-11 13:11:50 +01:00
Rémi Verschelde dca3ce441a
Merge pull request #45846 from rcorre/importplugin_doc
Improve EditorImportPlugin docs.
2021-02-11 12:24:48 +01:00
Ryan Roden-Corrent 9676650f2f Clarify EditorImportPlugin.get_visible_name.
According to the docs at
https://docs.godotengine.org/en/stable/tutorials/plugins/editor/import_plugins.html#the-editorimportplugin-class

> The get_visible_name() method is responsible for returning the name of
> the type it imports and it will be shown to the user in the Import dock.
> You should choose this name as a continuation to "Import as", e.g.
> "Import as Silly Material"

I've verified Godot's behavior reflects this, so the code examples
should reflect this.

Also document propagating save error in EditorImportPlugin.

It seems that the suggested code ignores any error from
`ResourceSaver.save`, but I think we should return it.
2021-02-11 11:13:17 +01:00
Kongfa Waroros fe6c8d48e6 Update GraphEdit when GraphNode's slot is updated 2021-02-11 01:07:54 +07:00
Rémi Verschelde c31bceb5f5
Merge pull request #45797 from madmiraal/add-new-sdl-keywords
Add support for new SDL gamecontroller keywords.
2021-02-08 13:47:01 +01:00
Rémi Verschelde e2a80a4be3
Merge pull request #43245 from HaSa1002/docs-object
Docs: Object: Use new signal syntax and port to C#
2021-02-08 12:53:44 +01:00
Rémi Verschelde 9b623635c8
doc: Sync classref with current source 2021-02-08 12:34:28 +01:00
Marcel Admiraal 3d479d086c Add support for new SDL gamecontroller keywords. 2021-02-07 16:09:32 +00:00
Hugo Locurcio b8df8b1043
Improve the SurfaceTool.generate_normals() documentation 2021-02-07 16:11:17 +01:00
Rémi Verschelde d93f75fae5
Merge pull request #45698 from KoBeWi/callables_are_love_callables_are_life
Change sort_custom/bsearch_custom to use Callables
2021-02-05 09:30:19 +01:00
Rémi Verschelde 69152af45d doc: Don't bind argument names with p_ prefix
This prefix is used in the C++ codebase, not in the scripting API.
2021-02-04 14:45:06 +01:00
Rémi Verschelde 444f57210e
Merge pull request #42721 from Paulb23/update_syntax_highlighting_docs
Update SyntaxHighlighter documentation
2021-02-04 14:44:21 +01:00
kobewi fb83d905da Change sort_custom/bsearch_custom to use Callables 2021-02-04 14:37:52 +01:00
Rémi Verschelde 5f8f049ddb
Merge pull request #45674 from Calinou/doc-file-endian-swap
Improve the `File.endian_swap` documentation
2021-02-03 18:38:20 +01:00
Rémi Verschelde cc95e2c6a6
Merge pull request #45593 from lyuma/audio_effect_capture
Add AudioEffectCapture
2021-02-02 22:14:58 +01:00
Hugo Locurcio c5f0db45df
Improve the File.endian_swap documentation 2021-02-02 21:59:55 +01:00
Lyuma d800329d16 Add AudioEffectCapture
AudioEffectCapture allows access to the microphone and other audio on an audio bus in real-time.

Co-Authored-By: K. S. Ernest (iFire) Lee <ernest.lee@chibifire.com>
2021-02-02 09:22:16 -08:00
Aaron Franke f55445079a
Replace ColorN and from HTML with a string constructor 2021-02-01 17:27:19 -05:00
Rémi Verschelde 13c0e48791
Merge pull request #45137 from Calinou/doc-control-gallery
Reference the control gallery image in the Control class documentation
2021-02-01 20:49:30 +01:00
nemerle 022c2952fc Node::replace_by was not copying node properties - removed the dead code.
The code to copy node properties to the new node never worked, so there is no reason to keep the useless bits in there
2021-02-01 16:47:27 +01:00
Rémi Verschelde d811f86102
Merge pull request #45281 from Chaosus/vs_unify
Unified several visual shader nodes
2021-02-01 08:56:03 +01:00
Hugo Locurcio 200f1cf015
Reference the control gallery image in the Control class documentation
Like the Tween cheatsheet or Color constants cheatsheet, this references
a "cheatsheet" image from the documentation repository.
2021-01-29 18:05:04 +01:00
kleonc e62ec6c6b1 Docs: Fix TileMap::map_to_world description 2021-01-29 12:38:21 +01:00
James Westman 2f5164d78c
docs: Add TreeItem method descriptions 2021-01-28 22:34:29 -06:00
Aaron Franke e829b7aee4
Unify URI encoding/decoding and add to C#
http_escape and percent_encode have been unified into uri_encode, and http_unescape and percent_decode have been unified into uri_decode.
2021-01-28 07:45:01 -05:00
Aaron Franke a3e3bf8227
Make hex_to_int and bin_to_int handle the prefix automatically
Also add BinToInt to C#
2021-01-28 07:43:53 -05:00
Rémi Verschelde fb01d057af
doc: Sync classref with current source 2021-01-28 11:26:37 +01:00
Rémi Verschelde 964c14580c
Merge pull request #43790 from Chaosus/rename_ord_at
Renamed String.ord_at to unicode_at
2021-01-27 19:42:31 +01:00
Yuri Roubinsky 64971bcc8a Added missed Button font_hover_pressed_color style 2021-01-27 10:44:53 +03:00
Yuri Roubinsky 6d82898470 Reveals Button "icon_color" style properties to the user 2021-01-26 22:05:59 +03:00
Yuri Roubinsky 38a5d22079 Renamed String.ord_at to unicode_at 2021-01-26 20:36:12 +03:00
Rémi Verschelde d6765c8d8b
Merge pull request #44732 from Calinou/os-add-get-thread-caller-id
Add an `OS.get_thread_caller_id()` method
2021-01-26 15:54:25 +01:00
Rémi Verschelde 34eb5638d3
Merge pull request #44624 from Calinou/doc-array-hash
Improve the `Array.hash()` documentation
2021-01-26 15:53:35 +01:00
Rémi Verschelde 6bea301533
Merge pull request #44678 from Calinou/doc-videoplayer-html5-performance
Document the expected low performance of VideoPlayer on HTML5
2021-01-26 15:40:02 +01:00
Rémi Verschelde 392d90fa65
Merge pull request #45368 from Xrayez/doc-tilemap-collider-shape-metadata
Document shape metadata for `TileMap`
2021-01-26 15:23:23 +01:00
Nils Reid 3e94c23fa5 Exposed find_next_valid_focus and find_prev_valid_focus. 2021-01-26 08:19:20 +01:00
Rémi Verschelde 3d1dd195d4
Merge pull request #45458 from Calinou/doc-array-push-pop-front-performance
Document low performance of `Array.push_front()` and `Array.pop_front()`
2021-01-26 00:27:08 +01:00
Rémi Verschelde 6cba658934
Merge pull request #44194 from madmiraal/fix-font_selected_color
Change themes font_color_selected to font_selected_color
2021-01-26 00:03:40 +01:00
Hugo Locurcio 7ce3cc0478
Document low performance of Array.push_front() and Array.pop_front() 2021-01-26 00:02:55 +01:00
Rémi Verschelde 38db12b45a
Merge pull request #45398 from Calinou/doc-resource-name-usage
Document a built-in use of `Resource.resource_name`
2021-01-25 21:40:12 +01:00
Rémi Verschelde babdffe174
Merge pull request #45394 from rcorre/timer-cleanup
Clarify that create_timer does not require cleanup.
2021-01-25 21:10:39 +01:00
Ryan Roden-Corrent 6e7e4f82ec
Clarify that create_timer does not require cleanup.
This is how I would expect it to work, but the docs didn't clarify, so I
had to check the source just to make sure I wasn't responsible for
freeing the timer:

d39f6386ce/scene/main/scene_tree.cpp (L473)
2021-01-25 08:05:09 -05:00
Hugo Locurcio 1b03f3f72b
Document that the high-level multiplayer API is only for Godot servers 2021-01-25 01:59:28 +01:00
Marcel Admiraal 8eb39f4e8b Change themes *_color_* to *_*_color
Changed:
font_color_accel -> font_accelerator_color
font_color_bg -> font_unselected_color
font_color_disabled -> font_disabled_color
font_color_fg -> font_selected_color
font_color_hover -> font_hover_color
font_color_hover_pressed -> font_hover_pressed_color
font_color_pressed -> font_pressed_color
font_color_readonly -> font_readonly_color
font_color_selected -> font_selected_color
font_color_shadow -> font_shadow_color
font_color_uneditable -> font_uneditable_color
icon_color_disabled -> icon_disabled_color
icon_color_hover -> icon_hover_color
icon_color_hover_pressed -> icon_hover_pressed_color
icon_color_normal -> icon_normal_color
icon_color_pressed -> icon_pressed_color

Also includes:
font_outline_modulate -> font_outline_color
tab_fg -> tab_selected
tab_bg -> tab_unselected
2021-01-24 06:28:49 +00:00
Hugo Locurcio 1a606b1a04
Document a built-in use of Resource.resource_name 2021-01-23 21:33:48 +01:00
Andrii Doroshenko (Xrayez) 0c2dbd01dc Document shape metadata for TileMap 2021-01-22 20:03:09 +02:00
Yuri Roubinsky 4618e09f3b
Added SDF nodes to visual shader 2021-01-18 15:04:54 +01:00
Yuri Roubinsky de5a8128d7 Unified several visual shader nodes 2021-01-18 13:32:12 +03:00
bruvzg e4651a44ab
RichTextLabel: adds separate get_total_x_count, get_visible_x_count and scroll_to_x functions for wrapped lines and paragraphs (newlines). 2021-01-18 11:26:55 +02:00
Andrii Doroshenko (Xrayez) b4675973fd Document GPU particles visibility rect/aabb behavior 2021-01-16 17:37:17 +02:00
Rémi Verschelde c7fb7674c8
Merge pull request #44805 from Chaosus/vs_convert
Add convert options between constants and uniforms in visual shaders
2021-01-15 16:58:26 +01:00
Rémi Verschelde 1ffe3ed47a
Merge pull request #33685 from Scony/improve-item-lists-add-item-methods
ItemList's add_(icon_)item method returns id of added item
2021-01-15 16:24:20 +01:00
Rémi Verschelde ee41c58b4a
Merge pull request #38578 from Phischermen/transform-notification-doc_update
Mention gotcha about how gizmos affect transform notifications
2021-01-15 16:17:26 +01:00
Rémi Verschelde fa5ead4db7
Merge pull request #42713 from madmiraal/fix-42614
Update area-body_shape_entered-exited signal documentation.
2021-01-15 13:00:23 +01:00
Rémi Verschelde 64ba83a096
Merge pull request #44870 from alexpech12/fix-rich-text-label-set-visible-characters
Keep RichTextLabel visible character properties in sync
2021-01-15 00:59:26 +01:00
Rémi Verschelde 011d201046
Merge pull request #43923 from madmiraal/fix-43588
Fix cast_motion sometimes failing
2021-01-14 20:44:19 +01:00