.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_VisualScript: VisualScript ============ **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_function` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=null **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=null **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=null **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_pos` **(** :ref:`String` func, :ref:`int` id **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_function` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_variable` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_node_pos` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** Member Variables ---------------- - :ref:`Dictionary` **data** Member Function Description --------------------------- .. _class_VisualScript_add_custom_signal: - void **add_custom_signal** **(** :ref:`String` name **)** .. _class_VisualScript_add_function: - void **add_function** **(** :ref:`String` name **)** .. _class_VisualScript_add_node: - void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=null **)** .. _class_VisualScript_add_variable: - void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=null **)** .. _class_VisualScript_custom_signal_add_argument: - void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=null **)** .. _class_VisualScript_custom_signal_get_argument_count: - :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const .. _class_VisualScript_custom_signal_get_argument_name: - :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const .. _class_VisualScript_custom_signal_get_argument_type: - :ref:`int` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const .. _class_VisualScript_custom_signal_remove_argument: - void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** .. _class_VisualScript_custom_signal_set_argument_name: - void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** .. _class_VisualScript_custom_signal_set_argument_type: - void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** .. _class_VisualScript_custom_signal_swap_argument: - void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** .. _class_VisualScript_data_connect: - void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. _class_VisualScript_data_disconnect: - void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. _class_VisualScript_get_function_node_id: - :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const .. _class_VisualScript_get_function_scroll: - :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const .. _class_VisualScript_get_node: - :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const .. _class_VisualScript_get_node_pos: - :ref:`Vector2` **get_node_pos** **(** :ref:`String` func, :ref:`int` id **)** const .. _class_VisualScript_get_variable_default_value: - :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const .. _class_VisualScript_get_variable_export: - :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const .. _class_VisualScript_get_variable_info: - :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const .. _class_VisualScript_has_custom_signal: - :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const .. _class_VisualScript_has_data_connection: - :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const .. _class_VisualScript_has_function: - :ref:`bool` **has_function** **(** :ref:`String` name **)** const .. _class_VisualScript_has_node: - :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const .. _class_VisualScript_has_sequence_connection: - :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const .. _class_VisualScript_has_variable: - :ref:`bool` **has_variable** **(** :ref:`String` name **)** const .. _class_VisualScript_remove_custom_signal: - void **remove_custom_signal** **(** :ref:`String` name **)** .. _class_VisualScript_remove_function: - void **remove_function** **(** :ref:`String` name **)** .. _class_VisualScript_remove_node: - void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** .. _class_VisualScript_remove_variable: - void **remove_variable** **(** :ref:`String` name **)** .. _class_VisualScript_rename_custom_signal: - void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** .. _class_VisualScript_rename_function: - void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** .. _class_VisualScript_rename_variable: - void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** .. _class_VisualScript_sequence_connect: - void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** .. _class_VisualScript_sequence_disconnect: - void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** .. _class_VisualScript_set_function_scroll: - void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** .. _class_VisualScript_set_instance_base_type: - void **set_instance_base_type** **(** :ref:`String` type **)** .. _class_VisualScript_set_node_pos: - void **set_node_pos** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** .. _class_VisualScript_set_variable_default_value: - void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** .. _class_VisualScript_set_variable_export: - void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** .. _class_VisualScript_set_variable_info: - void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)**