VisualScriptFunctionState.xml 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptFunctionState" inherits="Reference" version="3.4">
  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. </return>
  15. <argument index="0" name="obj" type="Object">
  16. </argument>
  17. <argument index="1" name="signals" type="String">
  18. </argument>
  19. <argument index="2" name="args" type="Array">
  20. </argument>
  21. <description>
  22. Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
  23. </description>
  24. </method>
  25. <method name="is_valid" qualifiers="const">
  26. <return type="bool">
  27. </return>
  28. <description>
  29. Returns whether the function state is valid.
  30. </description>
  31. </method>
  32. <method name="resume">
  33. <return type="Variant">
  34. </return>
  35. <argument index="0" name="args" type="Array" default="null">
  36. </argument>
  37. <description>
  38. Resumes the function to run from the point it was yielded.
  39. </description>
  40. </method>
  41. </methods>
  42. <constants>
  43. </constants>
  44. </class>