Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-31 21:51:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document remaining Visual Script classes

Browse source
This commit is contained in:
Tomasz Chabora 2020-10-12 19:37:50 +02:00 • committed by kobewi
parent 7bc52e56c0
commit 1054956461
21 changed files with 146 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
modules/visual_script/doc_classes/VisualScriptFunctionState.xml
View file

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionState" inherits="RefCounted" version="4.0">
<brief_description>
A Visual Script node representing a function state.
</brief_description>
<description>
[VisualScriptFunctionState] is returned from [VisualScriptYield] and can be used to resume a paused function call.
</description>
<tutorials>
</tutorials>
@ -17,12 +19,14 @@
<argument index="2" name="args" type="Array">
</argument>
<description>
Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the function state is valid.
</description>
</method>
<method name="resume">
@ -31,6 +35,7 @@
<argument index="0" name="args" type="Array" default="[]">
</argument>
<description>
Resumes the function to run from the point it was yielded.
</description>
</method>
</methods>