VisualScriptNode.xml 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptNode" inherits="Resource" category="Core" version="3.0-alpha">
  3. <brief_description>
  4. A node which is part of a [VisualScript].
  5. </brief_description>
  6. <description>
  7. A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_default_input_value" qualifiers="const">
  15. <return type="Variant">
  16. </return>
  17. <argument index="0" name="port_idx" type="int">
  18. </argument>
  19. <description>
  20. Returns the default value of a given port. The default value is used when nothing is connected to the port.
  21. </description>
  22. </method>
  23. <method name="get_visual_script" qualifiers="const">
  24. <return type="VisualScript">
  25. </return>
  26. <description>
  27. Returns the [VisualScript] instance the node is bound to.
  28. </description>
  29. </method>
  30. <method name="ports_changed_notify">
  31. <return type="void">
  32. </return>
  33. <description>
  34. Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] .
  35. </description>
  36. </method>
  37. <method name="set_default_input_value">
  38. <return type="void">
  39. </return>
  40. <argument index="0" name="port_idx" type="int">
  41. </argument>
  42. <argument index="1" name="value" type="Variant">
  43. </argument>
  44. <description>
  45. Change the default value of a given port.
  46. </description>
  47. </method>
  48. </methods>
  49. <members>
  50. <member name="_default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values">
  51. </member>
  52. </members>
  53. <signals>
  54. <signal name="ports_changed">
  55. <description>
  56. Emitted when the available input/output ports are changed.
  57. </description>
  58. </signal>
  59. </signals>
  60. <constants>
  61. </constants>
  62. </class>