Commit Graph

3580 Commits

Author SHA1 Message Date
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
Alexander Pech 463e2002ab Keep RichTextLabel visible character properties in sync
The RichTextLabel class is inconsistent in how it updates the
visible_characters and percent_visible properties when either is changed.

To keep both properties consistent, update percent_visible when setting the
visible_characters property.
For both properties, when setting one, notify change for the other.

Docs updated for member set_visible_characters on RichTextLabel class.
2021-01-14 21:32:41 +11:00
Andrii Doroshenko (Xrayez) e94f46dcdb Expose `Resource.emit_changed()` to script
Also known as `emit_signal("changed")`.
2021-01-13 16:27:58 +02:00
Rémi Verschelde 1218441b16
Merge pull request #44514 from madmiraal/split-os-execute
Split OS::execute into two methods
2021-01-12 16:17:04 +01:00
Rémi Verschelde 3bce846e0c
Merge pull request #45126 from groud/improve_undo_redo
Improve UndoRedo class
2021-01-12 15:50:09 +01:00
Gilles Roudière 831247b39c Improve UndoRedo class 2021-01-12 14:34:46 +01:00
TechnoPorg 81dc9be973
Fix incorrect parameter in audio_track_set_key_stream.
The description for audio_track_set_key_stream referenced a parameter called offset, which is not a parameter for that method. The description now references the correct parameter, stream.
2021-01-11 18:55:14 -06:00
Rémi Verschelde 8811a8eb4a
Merge pull request #45088 from skyace65/ReferenceResource
Remove the implication that references and resources are not objectes from their description
2021-01-11 15:45:44 +01:00
skyace65 dca298d22b Remove the implication that references and resources are not objected from their description 2021-01-11 08:22:16 -05:00
Andrii Doroshenko (Xrayez) a2c82bbf5f Clarify `lstrip()/rstrip()` methods in `String` for removed characters 2021-01-10 15:13:59 +02:00
Marcel Admiraal 5fa12da6f9 Rename the final parameter of area_shape_entered-exited local_shape. 2021-01-09 13:34:59 +00:00
Marcel Admiraal a77173b335 Update area-body_shape_entered-exited signal documentation. 2021-01-09 13:34:50 +00:00
Marcel Admiraal 2a74b388d0 Split OS::execute into two methods
1. execute(): Executes a command and returns the results.
2. create_process(): Creates a new process and returns the new process' id.
2021-01-09 10:03:23 +00:00
kobewi 84acafb2ce Clarify class_get_method_list() in release exports 2021-01-07 01:23:25 +01:00
Rémi Verschelde a3b76e26f3
doc: Sync classref with current source 2021-01-06 15:23:58 +01:00
Rémi Verschelde cdfcf68af9
Merge pull request #44925 from LoipesMas/str-docs
More explicit wording for str() function
2021-01-05 20:47:56 +01:00
LoipesMas 9c65927aeb More explicit wording for str() and print() functions 2021-01-05 20:00:26 +01:00
Hugo Locurcio fcb6ecaf21
Mention that the `delta` argument is in seconds in Node documentation 2021-01-05 19:14:37 +01:00
Rémi Verschelde 20b3ed07b9
Merge pull request #44929 from mrushyendra/astar_doc_fix
Explain use of weight_scale and distance in AStar pathfinding cost calcuation
2021-01-05 13:38:25 +01:00
Maganty Rushyendra f6634648ce Explain A Star pathfinding algorithm cost calcuation 2021-01-05 19:51:38 +08:00
Rémi Verschelde 0eb1123cf9
Merge pull request #44928 from mrushyendra/raise_doc_fix
[Doc] Specify order of drawing of Nodes in raise() description
2021-01-05 10:24:43 +01:00
Maganty Rushyendra a67ef5999d Specify order of drawing of Nodes in raise() description 2021-01-05 15:17:10 +08:00
Rémi Verschelde 215d18814e
doc: Sync classref with current source 2021-01-04 14:33:44 +01:00
HaSa1002 790f788833
Docs: Object: Use new signal syntax and port to C#
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
Co-authored-by: Ignacio Etcheverry <ignalfonsore@gmail.com>
2021-01-04 12:10:12 +01:00
Rémi Verschelde 7a16efc885
Merge pull request #42188 from Eoin-ONeill-Yokai/animationstateplayback/missing_binds
AnimationStateMachinePlayback: Added Missing Method Bindings
2021-01-02 11:01:13 +01:00
Eoin O'Neill 674fb52f52 StateMachinePlayback: Added missing bindings to `get_current_play_pos` and `get_current_length`.
This allows the user to query the AnimationNodeStateMachinePlayback's current
play position and total length of current animation state. These methods are currently
used in the editor plugin, but can also be useful for querying general playback state
information.

Added documentation for AnimationNodeStateMachinePlayback's `get_current_play_position`
2021-01-01 22:39:46 -08:00
Rémi Verschelde 96aff740fe
Merge pull request #44809 from Calinou/physics-render-layers-zero-index
Use zero-indexing for physics and render layer names
2021-01-01 23:37:37 +01:00
Rémi Verschelde 1ee69f29e5
Merge pull request #44817 from Calinou/doc-file-logging-desktop-override
Document the desktop-only file logging setting override
2021-01-01 23:03:34 +01:00
Rémi Verschelde b5334d14f7
Update copyright statements to 2021
Happy new year to the wonderful Godot community!

2020 has been a tough year for most of us personally, but a good year for
Godot development nonetheless with a huge amount of work done towards Godot
4.0 and great improvements backported to the long-lived 3.2 branch.

We've had close to 400 contributors to engine code this year, authoring near
7,000 commit! (And that's only for the `master` branch and for the engine code,
there's a lot more when counting docs, demos and other first-party repos.)

Here's to a great year 2021 for all Godot users 🎆
2021-01-01 20:19:21 +01:00
Hugo Locurcio bd0b7003e0
Document the desktop-only file logging setting override
This closes https://github.com/godotengine/godot-docs/issues/4505.
2020-12-30 18:39:50 +01:00
Hugo Locurcio f87d42f4ca
Use zero-indexing for physics and render layer names
The first layer is now Layer 0 instead of Layer 1, and the last
layer is now Layer 19 instead of Layer 20.

This helps reference physics and render layers from scripts since
layers start from 0 there.
2020-12-30 16:03:11 +01:00
Yuri Roubinsky c98c6eadbe Add convert options between constants and uniforms in visual shaders 2020-12-30 13:07:08 +03:00
Rémi Verschelde a06c569b12
Merge pull request #44710 from Calinou/doc-richtextlabel-no-entangled-tags
Document RichTextLabel not supporting entangled BBCode tags
2020-12-29 17:40:24 +01:00
Rémi Verschelde 3a9777cb3f
Merge pull request #44724 from Chaosus/popup_separator
Added optional id parameter to `PopupMenu::add_separator`
2020-12-29 17:39:44 +01:00
Rémi Verschelde 55c295c5d7
Merge pull request #44792 from KoBeWi/export_guide
Complete documentation of EditorExportPlugin
2020-12-29 15:03:31 +01:00
kobewi 8b231aff28 Complete documentation of EditorExportPlugin 2020-12-29 13:46:14 +01:00
Rémi Verschelde 848f5ba05c
Merge pull request #44762 from KoBeWi/offset_is_now_point_not_offset_point
Rename offset to point in remove_point()
2020-12-29 13:37:49 +01:00
Rémi Verschelde 2086acfacc
Merge pull request #44614 from madmiraal/rename-normalmap-normal_map
Consistently use normal_map
2020-12-29 10:39:56 +01:00
Rémi Verschelde 09212fba1e
Fix missed renamings from empty() to is_empty()
Those were missed in #44401 or added by later PRs.
2020-12-29 09:55:07 +01:00
Rémi Verschelde 652bdd573e
Merge pull request #43691 from bruvzg/ctl_dropcap
[Complex Text Layouts] Add drop-cap support to RTL.
2020-12-29 09:14:46 +01:00
Marcel Admiraal b4a190e0bc Consistently use normal_map 2020-12-29 08:04:19 +00:00