VisualScriptReturn.xml 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Exits a function and returns an optional value.
  5. </brief_description>
  6. <description>
  7. Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value.
  8. [b]Input Ports:[/b]
  9. - Sequence
  10. - Data (variant): [code]result[/code] (optional)
  11. [b]Output Ports:[/b]
  12. none
  13. </description>
  14. <tutorials>
  15. </tutorials>
  16. <demos>
  17. </demos>
  18. <methods>
  19. <method name="get_return_type" qualifiers="const">
  20. <return type="int" enum="Variant.Type">
  21. </return>
  22. <description>
  23. </description>
  24. </method>
  25. <method name="is_return_value_enabled" qualifiers="const">
  26. <return type="bool">
  27. </return>
  28. <description>
  29. </description>
  30. </method>
  31. <method name="set_enable_return_value">
  32. <return type="void">
  33. </return>
  34. <argument index="0" name="enable" type="bool">
  35. </argument>
  36. <description>
  37. </description>
  38. </method>
  39. <method name="set_return_type">
  40. <return type="void">
  41. </return>
  42. <argument index="0" name="type" type="int" enum="Variant.Type">
  43. </argument>
  44. <description>
  45. </description>
  46. </method>
  47. </methods>
  48. <members>
  49. <member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled">
  50. If [code]true[/code] the [code]return[/code] input port is available.
  51. </member>
  52. <member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type">
  53. The return value's data type.
  54. </member>
  55. </members>
  56. <constants>
  57. </constants>
  58. </class>