summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-11-26 19:09:28 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-11-26 19:13:55 +0100
commit4f14a1f59cb876300411669fa2310d10fbf3584e (patch)
tree7d9cf18e04ea31fb8ee0ef3821140cd3a2e6d625 /modules
parentef1008e53a1409ea34911c293c7fb8ac2b96245e (diff)
Remove type hint from the @GDScript class documentation
The current consensus in the Godot documentation is to avoid using type hints unless they're relevant to the behavior explained.
Diffstat (limited to 'modules')
-rw-r--r--modules/gdscript/doc_classes/@GDScript.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml
index 10eb719235..a22d18b970 100644
--- a/modules/gdscript/doc_classes/@GDScript.xml
+++ b/modules/gdscript/doc_classes/@GDScript.xml
@@ -1365,17 +1365,17 @@
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!")
func do_something():
print("Something is done!")
-
+
func do_something_else():
print("Something else is done!")
-
+
# prints:
# Something is done!
# Something else is done!