summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-08-24 15:41:57 +0200
committerGitHub <noreply@github.com>2022-08-24 15:41:57 +0200
commita4a4402201ff3a9f2dc6be062c45840176812439 (patch)
tree71c97ee71f390507ef3296942ad1f27d393ab100 /modules/visual_script/doc_classes/VisualScriptFunctionState.xml
parent78f3e4cb6a2bf6136caa63defa139e41d9b36953 (diff)
parentb1f392c25e214b331f87737d9e27aad30e95f201 (diff)
Merge pull request #64822 from akien-mga/sunset-visual-script
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptFunctionState.xml')
-rw-r--r--modules/visual_script/doc_classes/VisualScriptFunctionState.xml35
1 files changed, 0 insertions, 35 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
deleted file mode 100644
index 03fef9c13b..0000000000
--- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualScriptFunctionState" inherits="RefCounted" version="4.0" 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" />
- <param index="0" name="obj" type="Object" />
- <param index="1" name="signals" type="String" />
- <param 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" />
- <param index="0" name="args" type="Array" default="[]" />
- <description>
- Resumes the function to run from the point it was yielded.
- </description>
- </method>
- </methods>
-</class>