VisualScriptYieldSignal.xml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptYieldSignal" inherits="VisualScriptNode" version="4.0">
  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. <members>
  12. <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&amp;&quot;Object&quot;">
  13. The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE].
  14. </member>
  15. <member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">
  16. [code]call_mode[/code] determines the target object to wait for the signal emission. See [enum CallMode] for options.
  17. </member>
  18. <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
  19. The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH].
  20. </member>
  21. <member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="&amp;&quot;&quot;">
  22. The signal name to be waited for.
  23. </member>
  24. </members>
  25. <constants>
  26. <constant name="CALL_MODE_SELF" value="0" enum="CallMode">
  27. A signal from this [Object] will be used.
  28. </constant>
  29. <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
  30. A signal from the given [Node] in the scene tree will be used.
  31. </constant>
  32. <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
  33. A signal from an instanced node with the given type will be used.
  34. </constant>
  35. </constants>
  36. </class>