VisualScriptYieldSignal.xml 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptYieldSignal" inherits="VisualScriptNode" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. A Visual Script node yielding for a signal.
  5. </brief_description>
  6. <description>
  7. [VisualScriptYieldSignal] will pause the function execution until the provided signal is emitted.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. </methods>
  13. <members>
  14. <member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
  15. The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE].
  16. </member>
  17. <member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">
  18. [code]call_mode[/code] determines the target object to wait for the signal emission. See [enum CallMode] for options.
  19. </member>
  20. <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
  21. The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH].
  22. </member>
  23. <member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
  24. The signal name to be waited for.
  25. </member>
  26. </members>
  27. <constants>
  28. <constant name="CALL_MODE_SELF" value="0" enum="CallMode">
  29. A signal from this [Object] will be used.
  30. </constant>
  31. <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
  32. A signal from the given [Node] in the scene tree will be used.
  33. </constant>
  34. <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
  35. A signal from an instanced node with the given type will be used.
  36. </constant>
  37. </constants>
  38. </class>