mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove type hint from the @GDScript class documentation

Browse Source 
The current consensus in the Godot documentation is to avoid using
type hints unless they're relevant to the behavior explained.
This commit is contained in:
Hugo Locurcio 2019-11-26 19:09:28 +01:00
parent ef1008e53a
commit 4f14a1f59c
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/gdscript/doc_classes/@GDScript.xml
View File

@ -1365,7 +1365,7 @@
If passed an object and a signal, the execution is resumed when the object emits the given signal. In this case, [code]yield()[/code] returns the argument passed to [code]emit_signal()[/code] if the signal takes only one argument, or an array containing all the arguments passed to [code]emit_signal()[/code] if the signal takes multiple arguments.
You can also use [code]yield[/code] to wait for a function to finish:
[codeblock]
func _ready -> void:
func _ready():
yield(do_something(), "completed")
yield(do_something_else(), "completed")
print("All functions are done!")