Commit graph

128 commits

Author SHA1 Message Date
Micky
c54e09a5a3 Overhaul some "uncommon" wording in class reference 2024-03-01 15:32:38 +01:00
Micky
03400d0326 Tweak SceneTree Documentation 2024-02-26 16:27:58 +01:00
Yuri Sizov
16d1d85a56 Merge pull request #78206 from alula/node-count-in-group
Add SceneTree.get_node_count_in_group()
2023-12-14 17:38:00 +01:00
Pedro J. Estébanez
ab01dc5a48 Enhance SceneTree.change_scene*() methods' docs 2023-11-24 11:25:21 +01:00
A Thousand Ships
a5fe392b78 Disallow nested custom multiplayers in SceneTree
Enables clearing the custom multiplayer
2023-09-25 14:59:05 +02:00
Mateus Elias
5030549c7b Add a note about create_tween() method of SceneTree class
Add note regarding SceneTree.create_tween() method behavior.

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Tomek <kobewi4e@gmail.com>
2023-08-31 17:50:15 -03:00
kobewi
0ce0c11b9e Clarify existence of groups 2023-08-16 11:03:18 +02:00
AttackButton
b02d25605d Clarify SceneTree.current_scene functionality 2023-08-07 14:34:20 +02:00
Yuri Sizov
e8df8c5e2c Merge pull request #78988 from RandomShaper/fix_change_scene
Reimplement scene change
2023-07-26 18:39:43 +02:00
Rémi Verschelde
81064cc239
Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
Rémi Verschelde
346f1ab86b
Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
Pedro J. Estébanez
4354cd8d41 Reimplement scene change 2023-07-04 13:29:50 +02:00
Ninni Pipping
e9c9285213 Clarify restrictions on nested MultiplayerAPI in SceneTree 2023-06-25 11:29:05 +02:00
Rémi Verschelde
d40c45ed99
Merge pull request #77688 from L4Vo5/clarify-deferred
Clear up misconceptions about when deferred things run in the docs
2023-06-22 10:29:56 +02:00
L4Vo5
01f887ee4f Clarify when things with _IDLE and _PHYSICS enums will run 2023-06-20 13:25:26 -03:00
L4Vo5
2747dd35e7 clarify the meaning of "deferred" 2023-06-18 00:46:58 -03:00
biswas08433
bad7edd5a4
doc: Clarify description of SceneTree.create_timer()
Added the 'emit' and the 'signal' word to the 'create_timer()' method description, regarding timer behavior.
2023-06-15 15:17:31 +02:00
Alula
bddf24645d
Add SceneTree.get_node_count_in_group() 2023-06-14 19:19:30 +02:00
Yuri Sizov
391eccca76 Validate code tags in documentation for potential params
Adds a check to make_rst to look for matches
between the text inside of the [code][/code] tag
and known param identifiers.
Fixes most of what was revealed.
2023-04-26 21:36:04 +02:00
Ninni Pipping
bd30847e59 Exposing more project settings for documentation 2023-03-15 14:25:40 +01:00
kobewi
9785b23a0a Discourage reusing Tweens 2023-03-04 19:51:52 +01:00
Rémi Verschelde
1c1524a651
Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
Raul Santos
7eb8325180
Fix C# examples in documentation
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
Juan Linietsky
e5f2c442c7 Add SceneTree.unload_current_scene()
Provides an obvious way to unload the currently loaded scene (which is nowhere to be found in the docs).
The SceneTree.change_scene_to() method must now always provide a valid PackedScene.

Fixes #63565.
2023-01-10 14:02:06 +01:00
Haoyu Qiu
3f2d6f5f6c Add note about GROUP_CALL_UNIQUE not considering arguments 2022-12-04 15:05:59 +08:00
Jason Yundt
69963ffaa3 Rename change_scene() and change_scene_to()
Before this change, the SceneTree had methods named “change_scene” and
“change_scene_to”. One of them accepted a String as a parameter and the
other accepted a PackedScene, but you couldn’t tell which one was which
just by looking at their names.

This change renames those two methods to “change_scene_to_file” and
“change_scene_to_packed”. These new names came from this suggestion [1].
These new names make the difference between the two methods more clear
and hint at the fact that there’s more than one change_scene method.

[1]: <https://github.com/godotengine/godot/issues/27640#issuecomment-1081870955>

Fixes #27640.
2022-09-07 17:06:33 -04:00
Xwdit
f350356183 Some improvements to the SceneTreeTimer 2022-09-03 11:44:11 +02:00
kobewi
1abdffe7a0 Replace Array return types with TypedArray 2 2022-08-23 23:21:32 +02:00
Hugo Locurcio
39ba2b335a
Document run-time SceneTree debug property changes not working correctly 2022-08-14 15:06:29 +02:00
Andy Maloney
1f72f48361 [doc] Use "param" instead of "code" to refer to parameters #3 2022-08-09 22:00:19 -04:00
Yuri Sizov
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
kobewi
831888aad5 Remove outdated line in call_group() description 2022-07-10 20:02:20 +02:00
smix8
e12e239ab4 Add Path2D/3D debug options
Add Path2D/3D debug options.
2022-06-20 17:32:05 +02:00
Haoyu Qiu
82fdad148f Make auto_accept_quit and quit_on_go_back properties 2022-05-14 18:18:26 +08:00
Hugo Locurcio
aabbb40009
Make {call,set,notify}_group() immediate by default
This results in less surprising behavior out of the box.

Internal usages were modified to keep the existing behavior
identical there.
2022-05-05 16:59:37 +02:00
kobewi
8187a777ce Small improvements to get_first_node_in_group() 2022-04-29 16:14:48 +02:00
Fabio Alessandrelli
aee2240d5f [Net] Allow branch-specific MultiplayerAPIs.
Removes custom_multiplayer from Node.
MultiplayerAPI overrides are now set at SceneTree level, and apply to
whole branches.
Impact on performance when using only the default multiplayer or
overriding it is minimal, the use of branches can likely be further
optimized by caching nodes and relevant MultiplayerAPI IDs.
2022-04-26 17:22:54 +02:00
Pierre-Thomas Meisels
63f7f44ccb Make vararg method bind no return and return
Type emit_signal exposed method return type

set UndoRedo add_do_method and add_undo_method exposed return void

Set TreeItem::_call_recursive_bind returns void

Set _rpc_bind and _rpc_id_bind returns void in Node

Set _call_group and _call_group_flags method returns void in SceneTree

Set godot-cpp-test CI flag to false
2022-03-30 11:43:12 +02:00
Igor Kordiukiewicz
b870b40d79 Remove files_dropped signal from SceneTree 2022-02-28 07:51:50 +01:00
Hugo Locurcio
b68dd2e189
Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
Rémi Verschelde
6c1bd4d227
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 13:02:21 +01:00
Duroxxigar
b2458ff575 Replace remaining usages of yield with new await keyword 2021-10-22 14:28:37 -04:00
Hugo Locurcio
f6d7f37592
Document null argument limitation with SceneTree.call_group() 2021-10-07 18:55:29 +02:00
Rémi Verschelde
862994a8ef
doc: Update links to latest documentation after content reorganization 2021-10-06 13:48:48 +02:00
kobewi
31ef94f2ec Improve call_group documentation 2021-09-16 02:22:45 +02:00
Max Hilbrunner
f4b088c2d7
Merge pull request #50207 from SirQuartz/patch-17
Add note to `SceneTree` about pausing
2021-09-15 23:56:23 +02:00
Max Hilbrunner
b1430d8c2d Docs: Remove references to (removed) RSETs 2021-09-08 14:37:22 +02:00
Rémi Verschelde
7adf4cc9b5
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
luz paz
3564c16cb8
Fix various typos with codespell
Found via `codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,fave,findn,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint`
2021-07-25 11:21:51 +02:00
Fabio Alessandrelli
31142ac3ee [Net] Remove most multiplayer hooks from SceneTree.
Use `multiplayer` or `get_multiplayer()` instead of `get_tree()`.
2021-07-12 15:28:01 +02:00