godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document return value of yield() with signals 

Fixes godotengine/godot-docs#1478

(cherry picked from commit 117c666fce)
This commit is contained in:
Thomas ten Cate 2018-07-02 21:25:51 +02:00 committed by Rémi Verschelde
parent bb5312d3f7
commit 5281636de4
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/@GDScript.xml
View File

@ -1137,8 +1137,9 @@
<argument index="1" name="signal" type="String" default="&quot;&quot;"> <argument index="1" name="signal" type="String" default="&quot;&quot;">
</argument> </argument>
<description> <description>
Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. Stops the function execution and returns the current suspended state to the calling function.
Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted. From the caller, call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. Within the resumed function, [code]yield()[/code] returns whatever was passed to the [code]resume()[/code] function call.
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.
</description> </description>
</method> </method>
</methods> </methods>