浏览代码

Merge pull request #19921 from ttencate/yield_docs

Document return value of yield() with signals
Max Hilbrunner 7 年之前
父节点
当前提交
f8200d020a
共有 1 个文件被更改,包括 3 次插入2 次删除
  1. 3 2
      doc/classes/@GDScript.xml

+ 3 - 2
doc/classes/@GDScript.xml

@@ -1145,8 +1145,9 @@
 			<argument index="1" name="signal" type="String" default="&quot;&quot;">
 			</argument>
 			<description>
-				Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state.
-				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.
+				Stops the function execution and returns the current suspended state to the calling function.
+				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>
 		</method>
 	</methods>