class_visualscript.rst 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScript.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScript:
  5. VisualScript
  6. ============
  7. **Inherits:** :ref:`Script<class_script>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A script implemented in the Visual Script programming environment.
  12. Member Functions
  13. ----------------
  14. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`add_custom_signal<class_VisualScript_add_custom_signal>` **(** :ref:`String<class_string>` name **)** |
  16. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`add_function<class_VisualScript_add_function>` **(** :ref:`String<class_string>` name **)** |
  18. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`add_node<class_VisualScript_add_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`VisualScriptNode<class_visualscriptnode>` node, :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** |
  20. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`add_variable<class_VisualScript_add_variable>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` default_value=null, :ref:`bool<class_bool>` export=false **)** |
  22. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`custom_signal_add_argument<class_VisualScript_custom_signal_add_argument>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`String<class_string>` argname, :ref:`int<class_int>` index=-1 **)** |
  24. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`custom_signal_get_argument_count<class_VisualScript_custom_signal_get_argument_count>` **(** :ref:`String<class_string>` name **)** const |
  26. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_string>` | :ref:`custom_signal_get_argument_name<class_VisualScript_custom_signal_get_argument_name>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const |
  28. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`custom_signal_get_argument_type<class_VisualScript_custom_signal_get_argument_type>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const |
  30. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`custom_signal_remove_argument<class_VisualScript_custom_signal_remove_argument>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** |
  32. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`custom_signal_set_argument_name<class_VisualScript_custom_signal_set_argument_name>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`String<class_string>` argname **)** |
  34. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`custom_signal_set_argument_type<class_VisualScript_custom_signal_set_argument_type>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` type **)** |
  36. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`custom_signal_swap_argument<class_VisualScript_custom_signal_swap_argument>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)** |
  38. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`data_connect<class_VisualScript_data_connect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** |
  40. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | void | :ref:`data_disconnect<class_VisualScript_data_disconnect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** |
  42. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`int<class_int>` | :ref:`get_function_node_id<class_VisualScript_get_function_node_id>` **(** :ref:`String<class_string>` name **)** const |
  44. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`Vector2<class_vector2>` | :ref:`get_function_scroll<class_VisualScript_get_function_scroll>` **(** :ref:`String<class_string>` name **)** const |
  46. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`VisualScriptNode<class_visualscriptnode>` | :ref:`get_node<class_VisualScript_get_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
  48. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Vector2<class_vector2>` | :ref:`get_node_position<class_VisualScript_get_node_position>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
  50. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`Variant<class_variant>` | :ref:`get_variable_default_value<class_VisualScript_get_variable_default_value>` **(** :ref:`String<class_string>` name **)** const |
  52. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`bool<class_bool>` | :ref:`get_variable_export<class_VisualScript_get_variable_export>` **(** :ref:`String<class_string>` name **)** const |
  54. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`Dictionary<class_dictionary>` | :ref:`get_variable_info<class_VisualScript_get_variable_info>` **(** :ref:`String<class_string>` name **)** const |
  56. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`bool<class_bool>` | :ref:`has_custom_signal<class_VisualScript_has_custom_signal>` **(** :ref:`String<class_string>` name **)** const |
  58. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`bool<class_bool>` | :ref:`has_data_connection<class_VisualScript_has_data_connection>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const |
  60. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`bool<class_bool>` | :ref:`has_function<class_VisualScript_has_function>` **(** :ref:`String<class_string>` name **)** const |
  62. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`bool<class_bool>` | :ref:`has_node<class_VisualScript_has_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
  64. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`bool<class_bool>` | :ref:`has_sequence_connection<class_VisualScript_has_sequence_connection>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** const |
  66. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`bool<class_bool>` | :ref:`has_variable<class_VisualScript_has_variable>` **(** :ref:`String<class_string>` name **)** const |
  68. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`remove_custom_signal<class_VisualScript_remove_custom_signal>` **(** :ref:`String<class_string>` name **)** |
  70. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`remove_function<class_VisualScript_remove_function>` **(** :ref:`String<class_string>` name **)** |
  72. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`remove_node<class_VisualScript_remove_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** |
  74. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`remove_variable<class_VisualScript_remove_variable>` **(** :ref:`String<class_string>` name **)** |
  76. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`rename_custom_signal<class_VisualScript_rename_custom_signal>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
  78. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`rename_function<class_VisualScript_rename_function>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
  80. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`rename_variable<class_VisualScript_rename_variable>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
  82. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`sequence_connect<class_VisualScript_sequence_connect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** |
  84. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`sequence_disconnect<class_VisualScript_sequence_disconnect>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** |
  86. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`set_function_scroll<class_VisualScript_set_function_scroll>` **(** :ref:`String<class_string>` name, :ref:`Vector2<class_vector2>` ofs **)** |
  88. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`set_instance_base_type<class_VisualScript_set_instance_base_type>` **(** :ref:`String<class_string>` type **)** |
  90. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`set_node_position<class_VisualScript_set_node_position>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` position **)** |
  92. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`set_variable_default_value<class_VisualScript_set_variable_default_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
  94. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`set_variable_export<class_VisualScript_set_variable_export>` **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)** |
  96. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`set_variable_info<class_VisualScript_set_variable_info>` **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)** |
  98. +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. Signals
  100. -------
  101. - **node_ports_changed** **(** :ref:`String<class_string>` function, :ref:`int<class_int>` id **)**
  102. Emitted when the ports of a node are changed.
  103. Member Variables
  104. ----------------
  105. - :ref:`Dictionary<class_dictionary>` **data**
  106. Description
  107. -----------
  108. A script implemented in the Visual Script programming environment. The script exends the functionality of all objects that instance it.
  109. :ref:`Object.set_script<class_Object_set_script>` extends an existing object, if that object's class matches one of the script's base classes.
  110. You are most likely to use this class via the Visual Script editor or when writing plugins for it.
  111. Member Function Description
  112. ---------------------------
  113. .. _class_VisualScript_add_custom_signal:
  114. - void **add_custom_signal** **(** :ref:`String<class_string>` name **)**
  115. Add a custom signal with the specified name to the VisualScript.
  116. .. _class_VisualScript_add_function:
  117. - void **add_function** **(** :ref:`String<class_string>` name **)**
  118. Add a function with the specified name to the VisualScript.
  119. .. _class_VisualScript_add_node:
  120. - void **add_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`VisualScriptNode<class_visualscriptnode>` node, :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)**
  121. Add a node to a function of the VisualScript.
  122. .. _class_VisualScript_add_variable:
  123. - void **add_variable** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` default_value=null, :ref:`bool<class_bool>` export=false **)**
  124. Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
  125. .. _class_VisualScript_custom_signal_add_argument:
  126. - void **custom_signal_add_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`String<class_string>` argname, :ref:`int<class_int>` index=-1 **)**
  127. Add an argument to a custom signal added with :ref:`add_custom_signal<class_VisualScript_add_custom_signal>`.
  128. .. _class_VisualScript_custom_signal_get_argument_count:
  129. - :ref:`int<class_int>` **custom_signal_get_argument_count** **(** :ref:`String<class_string>` name **)** const
  130. Get the count of a custom signal's arguments.
  131. .. _class_VisualScript_custom_signal_get_argument_name:
  132. - :ref:`String<class_string>` **custom_signal_get_argument_name** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
  133. Get the name of a custom signal's argument.
  134. .. _class_VisualScript_custom_signal_get_argument_type:
  135. - :ref:`int<class_int>` **custom_signal_get_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
  136. Get the type of a custom signal's argument.
  137. .. _class_VisualScript_custom_signal_remove_argument:
  138. - void **custom_signal_remove_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)**
  139. Remove a specific custom signal's argument.
  140. .. _class_VisualScript_custom_signal_set_argument_name:
  141. - void **custom_signal_set_argument_name** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`String<class_string>` argname **)**
  142. Rename a custom signal's argument.
  143. .. _class_VisualScript_custom_signal_set_argument_type:
  144. - void **custom_signal_set_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` type **)**
  145. Change the type of a custom signal's argument.
  146. .. _class_VisualScript_custom_signal_swap_argument:
  147. - void **custom_signal_swap_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)**
  148. Swap two of the arguments of a custom signal.
  149. .. _class_VisualScript_data_connect:
  150. - void **data_connect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)**
  151. Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``.
  152. .. _class_VisualScript_data_disconnect:
  153. - void **data_disconnect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)**
  154. Disconnect two data ports previously connected with :ref:`data_connect<class_VisualScript_data_connect>`.
  155. .. _class_VisualScript_get_function_node_id:
  156. - :ref:`int<class_int>` **get_function_node_id** **(** :ref:`String<class_string>` name **)** const
  157. Returns the id of a function's entry point node.
  158. .. _class_VisualScript_get_function_scroll:
  159. - :ref:`Vector2<class_vector2>` **get_function_scroll** **(** :ref:`String<class_string>` name **)** const
  160. Returns the position of the center of the screen for a given function.
  161. .. _class_VisualScript_get_node:
  162. - :ref:`VisualScriptNode<class_visualscriptnode>` **get_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
  163. Returns a node given its id and its function.
  164. .. _class_VisualScript_get_node_position:
  165. - :ref:`Vector2<class_vector2>` **get_node_position** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
  166. Returns a node's position in pixels.
  167. .. _class_VisualScript_get_variable_default_value:
  168. - :ref:`Variant<class_variant>` **get_variable_default_value** **(** :ref:`String<class_string>` name **)** const
  169. Returns the default (initial) value of a variable.
  170. .. _class_VisualScript_get_variable_export:
  171. - :ref:`bool<class_bool>` **get_variable_export** **(** :ref:`String<class_string>` name **)** const
  172. Returns whether a variable is exported.
  173. .. _class_VisualScript_get_variable_info:
  174. - :ref:`Dictionary<class_dictionary>` **get_variable_info** **(** :ref:`String<class_string>` name **)** const
  175. Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage.
  176. .. _class_VisualScript_has_custom_signal:
  177. - :ref:`bool<class_bool>` **has_custom_signal** **(** :ref:`String<class_string>` name **)** const
  178. Returns whether a signal exists with the specified name.
  179. .. _class_VisualScript_has_data_connection:
  180. - :ref:`bool<class_bool>` **has_data_connection** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const
  181. Returns whether the specified data ports are connected.
  182. .. _class_VisualScript_has_function:
  183. - :ref:`bool<class_bool>` **has_function** **(** :ref:`String<class_string>` name **)** const
  184. Returns whether a function exists with the specified name.
  185. .. _class_VisualScript_has_node:
  186. - :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
  187. Returns whether a node exists with the given id.
  188. .. _class_VisualScript_has_sequence_connection:
  189. - :ref:`bool<class_bool>` **has_sequence_connection** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)** const
  190. Returns whether the specified sequence ports are connected.
  191. .. _class_VisualScript_has_variable:
  192. - :ref:`bool<class_bool>` **has_variable** **(** :ref:`String<class_string>` name **)** const
  193. Returns whether a variable exists with the specified name.
  194. .. _class_VisualScript_remove_custom_signal:
  195. - void **remove_custom_signal** **(** :ref:`String<class_string>` name **)**
  196. Remove a custom signal with the given name.
  197. .. _class_VisualScript_remove_function:
  198. - void **remove_function** **(** :ref:`String<class_string>` name **)**
  199. Remove a specific function and its nodes from the script.
  200. .. _class_VisualScript_remove_node:
  201. - void **remove_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)**
  202. Remove a specific node.
  203. .. _class_VisualScript_remove_variable:
  204. - void **remove_variable** **(** :ref:`String<class_string>` name **)**
  205. Remove a variable with the given name.
  206. .. _class_VisualScript_rename_custom_signal:
  207. - void **rename_custom_signal** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
  208. Change the name of a custom signal.
  209. .. _class_VisualScript_rename_function:
  210. - void **rename_function** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
  211. Change the name of a function.
  212. .. _class_VisualScript_rename_variable:
  213. - void **rename_variable** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
  214. Change the name of a variable.
  215. .. _class_VisualScript_sequence_connect:
  216. - void **sequence_connect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)**
  217. Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``.
  218. Unlike :ref:`data_connect<class_VisualScript_data_connect>`, there isn't a ``to_port``, since the target node can have only one sequence port.
  219. .. _class_VisualScript_sequence_disconnect:
  220. - void **sequence_disconnect** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_output, :ref:`int<class_int>` to_node **)**
  221. Disconnect two sequence ports previously connected with :ref:`sequence_connect<class_VisualScript_sequence_connect>`.
  222. .. _class_VisualScript_set_function_scroll:
  223. - void **set_function_scroll** **(** :ref:`String<class_string>` name, :ref:`Vector2<class_vector2>` ofs **)**
  224. Position the center of the screen for a function.
  225. .. _class_VisualScript_set_instance_base_type:
  226. - void **set_instance_base_type** **(** :ref:`String<class_string>` type **)**
  227. Set the base type of the script.
  228. .. _class_VisualScript_set_node_position:
  229. - void **set_node_position** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` position **)**
  230. Position a node on the screen.
  231. .. _class_VisualScript_set_variable_default_value:
  232. - void **set_variable_default_value** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)**
  233. Change the default (initial) value of a variable.
  234. .. _class_VisualScript_set_variable_export:
  235. - void **set_variable_export** **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)**
  236. Change whether a variable is exported.
  237. .. _class_VisualScript_set_variable_info:
  238. - void **set_variable_info** **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)**
  239. Set a variable's info, using the same format as :ref:`get_variable_info<class_VisualScript_get_variable_info>`.