class_visualscript.rst 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  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. .. _class_VisualScript_node_ports_changed:
  102. - **node_ports_changed** **(** :ref:`String<class_string>` function, :ref:`int<class_int>` id **)**
  103. Emitted when the ports of a node are changed.
  104. Description
  105. -----------
  106. A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.
  107. :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.
  108. You are most likely to use this class via the Visual Script editor or when writing plugins for it.
  109. Member Function Description
  110. ---------------------------
  111. .. _class_VisualScript_add_custom_signal:
  112. - void **add_custom_signal** **(** :ref:`String<class_string>` name **)**
  113. Add a custom signal with the specified name to the VisualScript.
  114. .. _class_VisualScript_add_function:
  115. - void **add_function** **(** :ref:`String<class_string>` name **)**
  116. Add a function with the specified name to the VisualScript.
  117. .. _class_VisualScript_add_node:
  118. - 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 ) **)**
  119. Add a node to a function of the VisualScript.
  120. .. _class_VisualScript_add_variable:
  121. - void **add_variable** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` default_value=null, :ref:`bool<class_bool>` export=false **)**
  122. Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
  123. .. _class_VisualScript_custom_signal_add_argument:
  124. - 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 **)**
  125. Add an argument to a custom signal added with :ref:`add_custom_signal<class_VisualScript_add_custom_signal>`.
  126. .. _class_VisualScript_custom_signal_get_argument_count:
  127. - :ref:`int<class_int>` **custom_signal_get_argument_count** **(** :ref:`String<class_string>` name **)** const
  128. Get the count of a custom signal's arguments.
  129. .. _class_VisualScript_custom_signal_get_argument_name:
  130. - :ref:`String<class_string>` **custom_signal_get_argument_name** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
  131. Get the name of a custom signal's argument.
  132. .. _class_VisualScript_custom_signal_get_argument_type:
  133. - :ref:`int<class_int>` **custom_signal_get_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
  134. Get the type of a custom signal's argument.
  135. .. _class_VisualScript_custom_signal_remove_argument:
  136. - void **custom_signal_remove_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)**
  137. Remove a specific custom signal's argument.
  138. .. _class_VisualScript_custom_signal_set_argument_name:
  139. - void **custom_signal_set_argument_name** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`String<class_string>` argname **)**
  140. Rename a custom signal's argument.
  141. .. _class_VisualScript_custom_signal_set_argument_type:
  142. - void **custom_signal_set_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` type **)**
  143. Change the type of a custom signal's argument.
  144. .. _class_VisualScript_custom_signal_swap_argument:
  145. - void **custom_signal_swap_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)**
  146. Swap two of the arguments of a custom signal.
  147. .. _class_VisualScript_data_connect:
  148. - 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 **)**
  149. Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``.
  150. .. _class_VisualScript_data_disconnect:
  151. - 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 **)**
  152. Disconnect two data ports previously connected with :ref:`data_connect<class_VisualScript_data_connect>`.
  153. .. _class_VisualScript_get_function_node_id:
  154. - :ref:`int<class_int>` **get_function_node_id** **(** :ref:`String<class_string>` name **)** const
  155. Returns the id of a function's entry point node.
  156. .. _class_VisualScript_get_function_scroll:
  157. - :ref:`Vector2<class_vector2>` **get_function_scroll** **(** :ref:`String<class_string>` name **)** const
  158. Returns the position of the center of the screen for a given function.
  159. .. _class_VisualScript_get_node:
  160. - :ref:`VisualScriptNode<class_visualscriptnode>` **get_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
  161. Returns a node given its id and its function.
  162. .. _class_VisualScript_get_node_position:
  163. - :ref:`Vector2<class_vector2>` **get_node_position** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
  164. Returns a node's position in pixels.
  165. .. _class_VisualScript_get_variable_default_value:
  166. - :ref:`Variant<class_variant>` **get_variable_default_value** **(** :ref:`String<class_string>` name **)** const
  167. Returns the default (initial) value of a variable.
  168. .. _class_VisualScript_get_variable_export:
  169. - :ref:`bool<class_bool>` **get_variable_export** **(** :ref:`String<class_string>` name **)** const
  170. Returns whether a variable is exported.
  171. .. _class_VisualScript_get_variable_info:
  172. - :ref:`Dictionary<class_dictionary>` **get_variable_info** **(** :ref:`String<class_string>` name **)** const
  173. Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage.
  174. .. _class_VisualScript_has_custom_signal:
  175. - :ref:`bool<class_bool>` **has_custom_signal** **(** :ref:`String<class_string>` name **)** const
  176. Returns whether a signal exists with the specified name.
  177. .. _class_VisualScript_has_data_connection:
  178. - :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
  179. Returns whether the specified data ports are connected.
  180. .. _class_VisualScript_has_function:
  181. - :ref:`bool<class_bool>` **has_function** **(** :ref:`String<class_string>` name **)** const
  182. Returns whether a function exists with the specified name.
  183. .. _class_VisualScript_has_node:
  184. - :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
  185. Returns whether a node exists with the given id.
  186. .. _class_VisualScript_has_sequence_connection:
  187. - :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
  188. Returns whether the specified sequence ports are connected.
  189. .. _class_VisualScript_has_variable:
  190. - :ref:`bool<class_bool>` **has_variable** **(** :ref:`String<class_string>` name **)** const
  191. Returns whether a variable exists with the specified name.
  192. .. _class_VisualScript_remove_custom_signal:
  193. - void **remove_custom_signal** **(** :ref:`String<class_string>` name **)**
  194. Remove a custom signal with the given name.
  195. .. _class_VisualScript_remove_function:
  196. - void **remove_function** **(** :ref:`String<class_string>` name **)**
  197. Remove a specific function and its nodes from the script.
  198. .. _class_VisualScript_remove_node:
  199. - void **remove_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)**
  200. Remove a specific node.
  201. .. _class_VisualScript_remove_variable:
  202. - void **remove_variable** **(** :ref:`String<class_string>` name **)**
  203. Remove a variable with the given name.
  204. .. _class_VisualScript_rename_custom_signal:
  205. - void **rename_custom_signal** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
  206. Change the name of a custom signal.
  207. .. _class_VisualScript_rename_function:
  208. - void **rename_function** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
  209. Change the name of a function.
  210. .. _class_VisualScript_rename_variable:
  211. - void **rename_variable** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
  212. Change the name of a variable.
  213. .. _class_VisualScript_sequence_connect:
  214. - 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 **)**
  215. Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``.
  216. Unlike :ref:`data_connect<class_VisualScript_data_connect>`, there isn't a ``to_port``, since the target node can have only one sequence port.
  217. .. _class_VisualScript_sequence_disconnect:
  218. - 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 **)**
  219. Disconnect two sequence ports previously connected with :ref:`sequence_connect<class_VisualScript_sequence_connect>`.
  220. .. _class_VisualScript_set_function_scroll:
  221. - void **set_function_scroll** **(** :ref:`String<class_string>` name, :ref:`Vector2<class_vector2>` ofs **)**
  222. Position the center of the screen for a function.
  223. .. _class_VisualScript_set_instance_base_type:
  224. - void **set_instance_base_type** **(** :ref:`String<class_string>` type **)**
  225. Set the base type of the script.
  226. .. _class_VisualScript_set_node_position:
  227. - void **set_node_position** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` position **)**
  228. Position a node on the screen.
  229. .. _class_VisualScript_set_variable_default_value:
  230. - void **set_variable_default_value** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)**
  231. Change the default (initial) value of a variable.
  232. .. _class_VisualScript_set_variable_export:
  233. - void **set_variable_export** **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)**
  234. Change whether a variable is exported.
  235. .. _class_VisualScript_set_variable_info:
  236. - void **set_variable_info** **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)**
  237. Set a variable's info, using the same format as :ref:`get_variable_info<class_VisualScript_get_variable_info>`.