123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the VisualScript.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_VisualScript:
- VisualScript
- ============
- **Inherits:** :ref:`Script<class_Script>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- A script implemented in the Visual Script programming environment.
- Description
- -----------
- A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.
- :ref:`Object.set_script<class_Object_method_set_script>` extends an existing object, if that object's class matches one of the script's base classes.
- You are most likely to use this class via the Visual Script editor or when writing plugins for it.
- Tutorials
- ---------
- - :doc:`../tutorials/scripting/visual_script/index`
- Methods
- -------
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_custom_signal<class_VisualScript_method_add_custom_signal>` **(** :ref:`String<class_String>` name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_function<class_VisualScript_method_add_function>` **(** :ref:`String<class_String>` name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_node<class_VisualScript_method_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 ) **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_variable<class_VisualScript_method_add_variable>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` default_value=null, :ref:`bool<class_bool>` export=false **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`custom_signal_add_argument<class_VisualScript_method_custom_signal_add_argument>` **(** :ref:`String<class_String>` name, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` argname, :ref:`int<class_int>` index=-1 **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`custom_signal_get_argument_count<class_VisualScript_method_custom_signal_get_argument_count>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`custom_signal_get_argument_name<class_VisualScript_method_custom_signal_get_argument_name>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`custom_signal_get_argument_type<class_VisualScript_method_custom_signal_get_argument_type>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`custom_signal_remove_argument<class_VisualScript_method_custom_signal_remove_argument>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`custom_signal_set_argument_name<class_VisualScript_method_custom_signal_set_argument_name>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx, :ref:`String<class_String>` argname **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`custom_signal_set_argument_type<class_VisualScript_method_custom_signal_set_argument_type>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`custom_signal_swap_argument<class_VisualScript_method_custom_signal_swap_argument>` **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`data_connect<class_VisualScript_method_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 **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`data_disconnect<class_VisualScript_method_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 **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_function_node_id<class_VisualScript_method_get_function_node_id>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_function_scroll<class_VisualScript_method_get_function_scroll>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`VisualScriptNode<class_VisualScriptNode>` | :ref:`get_node<class_VisualScript_method_get_node>` **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_VisualScript_method_get_node_position>` **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`get_variable_default_value<class_VisualScript_method_get_variable_default_value>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_variable_export<class_VisualScript_method_get_variable_export>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_variable_info<class_VisualScript_method_get_variable_info>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_custom_signal<class_VisualScript_method_has_custom_signal>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_data_connection<class_VisualScript_method_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| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_function<class_VisualScript_method_has_function>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_node<class_VisualScript_method_has_node>` **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_sequence_connection<class_VisualScript_method_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| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_variable<class_VisualScript_method_has_variable>` **(** :ref:`String<class_String>` name **)** |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_custom_signal<class_VisualScript_method_remove_custom_signal>` **(** :ref:`String<class_String>` name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_function<class_VisualScript_method_remove_function>` **(** :ref:`String<class_String>` name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_node<class_VisualScript_method_remove_node>` **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_variable<class_VisualScript_method_remove_variable>` **(** :ref:`String<class_String>` name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`rename_custom_signal<class_VisualScript_method_rename_custom_signal>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`rename_function<class_VisualScript_method_rename_function>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`rename_variable<class_VisualScript_method_rename_variable>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`sequence_connect<class_VisualScript_method_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 **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`sequence_disconnect<class_VisualScript_method_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 **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_function_scroll<class_VisualScript_method_set_function_scroll>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` ofs **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_instance_base_type<class_VisualScript_method_set_instance_base_type>` **(** :ref:`String<class_String>` type **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_node_position<class_VisualScript_method_set_node_position>` **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_variable_default_value<class_VisualScript_method_set_variable_default_value>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_variable_export<class_VisualScript_method_set_variable_export>` **(** :ref:`String<class_String>` name, :ref:`bool<class_bool>` enable **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_variable_info<class_VisualScript_method_set_variable_info>` **(** :ref:`String<class_String>` name, :ref:`Dictionary<class_Dictionary>` value **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_VisualScript_signal_node_ports_changed:
- - **node_ports_changed** **(** :ref:`String<class_String>` function, :ref:`int<class_int>` id **)**
- Emitted when the ports of a node are changed.
- Method Descriptions
- -------------------
- .. _class_VisualScript_method_add_custom_signal:
- - void **add_custom_signal** **(** :ref:`String<class_String>` name **)**
- Add a custom signal with the specified name to the VisualScript.
- ----
- .. _class_VisualScript_method_add_function:
- - void **add_function** **(** :ref:`String<class_String>` name **)**
- Add a function with the specified name to the VisualScript.
- ----
- .. _class_VisualScript_method_add_node:
- - 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 ) **)**
- Add a node to a function of the VisualScript.
- ----
- .. _class_VisualScript_method_add_variable:
- - void **add_variable** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` default_value=null, :ref:`bool<class_bool>` export=false **)**
- Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
- ----
- .. _class_VisualScript_method_custom_signal_add_argument:
- - void **custom_signal_add_argument** **(** :ref:`String<class_String>` name, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` argname, :ref:`int<class_int>` index=-1 **)**
- Add an argument to a custom signal added with :ref:`add_custom_signal<class_VisualScript_method_add_custom_signal>`.
- ----
- .. _class_VisualScript_method_custom_signal_get_argument_count:
- - :ref:`int<class_int>` **custom_signal_get_argument_count** **(** :ref:`String<class_String>` name **)** |const|
- Get the count of a custom signal's arguments.
- ----
- .. _class_VisualScript_method_custom_signal_get_argument_name:
- - :ref:`String<class_String>` **custom_signal_get_argument_name** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx **)** |const|
- Get the name of a custom signal's argument.
- ----
- .. _class_VisualScript_method_custom_signal_get_argument_type:
- - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **custom_signal_get_argument_type** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx **)** |const|
- Get the type of a custom signal's argument.
- ----
- .. _class_VisualScript_method_custom_signal_remove_argument:
- - void **custom_signal_remove_argument** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx **)**
- Remove a specific custom signal's argument.
- ----
- .. _class_VisualScript_method_custom_signal_set_argument_name:
- - void **custom_signal_set_argument_name** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx, :ref:`String<class_String>` argname **)**
- Rename a custom signal's argument.
- ----
- .. _class_VisualScript_method_custom_signal_set_argument_type:
- - void **custom_signal_set_argument_type** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type **)**
- Change the type of a custom signal's argument.
- ----
- .. _class_VisualScript_method_custom_signal_swap_argument:
- - void **custom_signal_swap_argument** **(** :ref:`String<class_String>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)**
- Swap two of the arguments of a custom signal.
- ----
- .. _class_VisualScript_method_data_connect:
- - 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 **)**
- Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``.
- ----
- .. _class_VisualScript_method_data_disconnect:
- - 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 **)**
- Disconnect two data ports previously connected with :ref:`data_connect<class_VisualScript_method_data_connect>`.
- ----
- .. _class_VisualScript_method_get_function_node_id:
- - :ref:`int<class_int>` **get_function_node_id** **(** :ref:`String<class_String>` name **)** |const|
- Returns the id of a function's entry point node.
- ----
- .. _class_VisualScript_method_get_function_scroll:
- - :ref:`Vector2<class_Vector2>` **get_function_scroll** **(** :ref:`String<class_String>` name **)** |const|
- Returns the position of the center of the screen for a given function.
- ----
- .. _class_VisualScript_method_get_node:
- - :ref:`VisualScriptNode<class_VisualScriptNode>` **get_node** **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |const|
- Returns a node given its id and its function.
- ----
- .. _class_VisualScript_method_get_node_position:
- - :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |const|
- Returns a node's position in pixels.
- ----
- .. _class_VisualScript_method_get_variable_default_value:
- - :ref:`Variant<class_Variant>` **get_variable_default_value** **(** :ref:`String<class_String>` name **)** |const|
- Returns the default (initial) value of a variable.
- ----
- .. _class_VisualScript_method_get_variable_export:
- - :ref:`bool<class_bool>` **get_variable_export** **(** :ref:`String<class_String>` name **)** |const|
- Returns whether a variable is exported.
- ----
- .. _class_VisualScript_method_get_variable_info:
- - :ref:`Dictionary<class_Dictionary>` **get_variable_info** **(** :ref:`String<class_String>` name **)** |const|
- Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage.
- ----
- .. _class_VisualScript_method_has_custom_signal:
- - :ref:`bool<class_bool>` **has_custom_signal** **(** :ref:`String<class_String>` name **)** |const|
- Returns whether a signal exists with the specified name.
- ----
- .. _class_VisualScript_method_has_data_connection:
- - :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|
- Returns whether the specified data ports are connected.
- ----
- .. _class_VisualScript_method_has_function:
- - :ref:`bool<class_bool>` **has_function** **(** :ref:`String<class_String>` name **)** |const|
- Returns whether a function exists with the specified name.
- ----
- .. _class_VisualScript_method_has_node:
- - :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)** |const|
- Returns whether a node exists with the given id.
- ----
- .. _class_VisualScript_method_has_sequence_connection:
- - :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|
- Returns whether the specified sequence ports are connected.
- ----
- .. _class_VisualScript_method_has_variable:
- - :ref:`bool<class_bool>` **has_variable** **(** :ref:`String<class_String>` name **)** |const|
- Returns whether a variable exists with the specified name.
- ----
- .. _class_VisualScript_method_remove_custom_signal:
- - void **remove_custom_signal** **(** :ref:`String<class_String>` name **)**
- Remove a custom signal with the given name.
- ----
- .. _class_VisualScript_method_remove_function:
- - void **remove_function** **(** :ref:`String<class_String>` name **)**
- Remove a specific function and its nodes from the script.
- ----
- .. _class_VisualScript_method_remove_node:
- - void **remove_node** **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id **)**
- Remove a specific node.
- ----
- .. _class_VisualScript_method_remove_variable:
- - void **remove_variable** **(** :ref:`String<class_String>` name **)**
- Remove a variable with the given name.
- ----
- .. _class_VisualScript_method_rename_custom_signal:
- - void **rename_custom_signal** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
- Change the name of a custom signal.
- ----
- .. _class_VisualScript_method_rename_function:
- - void **rename_function** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
- Change the name of a function.
- ----
- .. _class_VisualScript_method_rename_variable:
- - void **rename_variable** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
- Change the name of a variable.
- ----
- .. _class_VisualScript_method_sequence_connect:
- - 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 **)**
- Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``.
- Unlike :ref:`data_connect<class_VisualScript_method_data_connect>`, there isn't a ``to_port``, since the target node can have only one sequence port.
- ----
- .. _class_VisualScript_method_sequence_disconnect:
- - 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 **)**
- Disconnect two sequence ports previously connected with :ref:`sequence_connect<class_VisualScript_method_sequence_connect>`.
- ----
- .. _class_VisualScript_method_set_function_scroll:
- - void **set_function_scroll** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` ofs **)**
- Position the center of the screen for a function.
- ----
- .. _class_VisualScript_method_set_instance_base_type:
- - void **set_instance_base_type** **(** :ref:`String<class_String>` type **)**
- Set the base type of the script.
- ----
- .. _class_VisualScript_method_set_node_position:
- - void **set_node_position** **(** :ref:`String<class_String>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)**
- Position a node on the screen.
- ----
- .. _class_VisualScript_method_set_variable_default_value:
- - void **set_variable_default_value** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**
- Change the default (initial) value of a variable.
- ----
- .. _class_VisualScript_method_set_variable_export:
- - void **set_variable_export** **(** :ref:`String<class_String>` name, :ref:`bool<class_bool>` enable **)**
- Change whether a variable is exported.
- ----
- .. _class_VisualScript_method_set_variable_info:
- - void **set_variable_info** **(** :ref:`String<class_String>` name, :ref:`Dictionary<class_Dictionary>` value **)**
- Set a variable's info, using the same format as :ref:`get_variable_info<class_VisualScript_method_get_variable_info>`.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|