1
0
mirror of https://github.com/godotengine/godot.git synced 2025-12-03 16:55:53 +00:00
Files
godot/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
Rémi Verschelde 32ddd4f4e0 Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).

(cherry picked from commit 81064cc239)
2024-09-11 12:41:48 +02:00

38 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionState" inherits="Reference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<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>
<methods>
<method name="connect_to_signal">
<return type="void" />
<argument index="0" name="obj" type="Object" />
<argument index="1" name="signals" type="String" />
<argument index="2" name="args" type="Array" />
<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" />
<description>
Returns whether the function state is valid.
</description>
</method>
<method name="resume">
<return type="Variant" />
<argument index="0" name="args" type="Array" default="null" />
<description>
Resumes the function to run from the point it was yielded.
</description>
</method>
</methods>
<constants>
</constants>
</class>