VisualScriptFunctionState.xml 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptFunctionState" inherits="Reference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. A Visual Script node representing a function state.
  5. </brief_description>
  6. <description>
  7. [VisualScriptFunctionState] is returned from [VisualScriptYield] and can be used to resume a paused function call.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="connect_to_signal">
  13. <return type="void" />
  14. <argument index="0" name="obj" type="Object" />
  15. <argument index="1" name="signals" type="String" />
  16. <argument index="2" name="args" type="Array" />
  17. <description>
  18. Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
  19. </description>
  20. </method>
  21. <method name="is_valid" qualifiers="const">
  22. <return type="bool" />
  23. <description>
  24. Returns whether the function state is valid.
  25. </description>
  26. </method>
  27. <method name="resume">
  28. <return type="Variant" />
  29. <argument index="0" name="args" type="Array" default="null" />
  30. <description>
  31. Resumes the function to run from the point it was yielded.
  32. </description>
  33. </method>
  34. </methods>
  35. <constants>
  36. </constants>
  37. </class>