godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd7d443fb2a2c36ce53852ed86ebf56513ca78cd
godot-docs/classes/class_visualscript.rst
Rémi Verschelde c282b77a58 classref: Sync with current master branch
2017-04-07 22:11:07 +02:00

289 lines
32 KiB
ReStructuredText
Raw Blame History

.. 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<class_script>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_signal<class_VisualScript_add_custom_signal>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_function<class_VisualScript_add_function>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_VisualScript_add_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Object<class_object>` node, :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`custom_signal_get_argument_count<class_VisualScript_custom_signal_get_argument_count>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`custom_signal_remove_argument<class_VisualScript_custom_signal_remove_argument>` **(** :ref:`String<class_string>` argidx, :ref:`int<class_int>` arg1 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_function_node_id<class_VisualScript_get_function_node_id>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_function_scroll<class_VisualScript_get_function_scroll>` **(** :ref:`String<class_string>` arg0 **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_node<class_VisualScript_get_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_node_pos<class_VisualScript_get_node_pos>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_variable_default_value<class_VisualScript_get_variable_default_value>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_variable_export<class_VisualScript_get_variable_export>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_variable_info<class_VisualScript_get_variable_info>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_custom_signal<class_VisualScript_has_custom_signal>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_function<class_VisualScript_has_function>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_node<class_VisualScript_has_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_variable<class_VisualScript_has_variable>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_signal<class_VisualScript_remove_custom_signal>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_function<class_VisualScript_remove_function>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_VisualScript_remove_node>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_variable<class_VisualScript_remove_variable>` **(** :ref:`String<class_string>` name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_custom_signal<class_VisualScript_rename_custom_signal>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_function<class_VisualScript_rename_function>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_variable<class_VisualScript_rename_variable>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_function_scroll<class_VisualScript_set_function_scroll>` **(** :ref:`String<class_string>` ofs, :ref:`Vector2<class_vector2>` arg1 **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_instance_base_type<class_VisualScript_set_instance_base_type>` **(** :ref:`String<class_string>` type **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_node_pos<class_VisualScript_set_node_pos>` **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` pos **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_variable_default_value<class_VisualScript_set_variable_default_value>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_variable_export<class_VisualScript_set_variable_export>` **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_variable_info<class_VisualScript_set_variable_info>` **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)** |
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **node_ports_changed** **(** :ref:`String<class_string>` function, :ref:`int<class_int>` id **)**
Member Variables
----------------
- :ref:`Dictionary<class_dictionary>` **data**
Member Function Description
---------------------------
.. _class_VisualScript_add_custom_signal:
- void **add_custom_signal** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScript_add_function:
- void **add_function** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScript_add_node:
- void **add_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Object<class_object>` node, :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)**
.. _class_VisualScript_add_variable:
- void **add_variable** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` default_value=NULL, :ref:`bool<class_bool>` export=false **)**
.. _class_VisualScript_custom_signal_add_argument:
- 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 **)**
.. _class_VisualScript_custom_signal_get_argument_count:
- :ref:`int<class_int>` **custom_signal_get_argument_count** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_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
.. _class_VisualScript_custom_signal_get_argument_type:
- :ref:`int<class_int>` **custom_signal_get_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx **)** const
.. _class_VisualScript_custom_signal_remove_argument:
- void **custom_signal_remove_argument** **(** :ref:`String<class_string>` argidx, :ref:`int<class_int>` arg1 **)**
.. _class_VisualScript_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 **)**
.. _class_VisualScript_custom_signal_set_argument_type:
- void **custom_signal_set_argument_type** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` type **)**
.. _class_VisualScript_custom_signal_swap_argument:
- void **custom_signal_swap_argument** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` argidx, :ref:`int<class_int>` withidx **)**
.. _class_VisualScript_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 **)**
.. _class_VisualScript_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 **)**
.. _class_VisualScript_get_function_node_id:
- :ref:`int<class_int>` **get_function_node_id** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_get_function_scroll:
- :ref:`Vector2<class_vector2>` **get_function_scroll** **(** :ref:`String<class_string>` arg0 **)** const
.. _class_VisualScript_get_node:
- :ref:`Object<class_object>` **get_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
.. _class_VisualScript_get_node_pos:
- :ref:`Vector2<class_vector2>` **get_node_pos** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
.. _class_VisualScript_get_variable_default_value:
- void **get_variable_default_value** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_get_variable_export:
- :ref:`bool<class_bool>` **get_variable_export** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_get_variable_info:
- :ref:`Dictionary<class_dictionary>` **get_variable_info** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_has_custom_signal:
- :ref:`bool<class_bool>` **has_custom_signal** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_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
.. _class_VisualScript_has_function:
- :ref:`bool<class_bool>` **has_function** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_has_node:
- :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)** const
.. _class_VisualScript_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
.. _class_VisualScript_has_variable:
- :ref:`bool<class_bool>` **has_variable** **(** :ref:`String<class_string>` name **)** const
.. _class_VisualScript_remove_custom_signal:
- void **remove_custom_signal** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScript_remove_function:
- void **remove_function** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScript_remove_node:
- void **remove_node** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id **)**
.. _class_VisualScript_remove_variable:
- void **remove_variable** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScript_rename_custom_signal:
- void **rename_custom_signal** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
.. _class_VisualScript_rename_function:
- void **rename_function** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
.. _class_VisualScript_rename_variable:
- void **rename_variable** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` new_name **)**
.. _class_VisualScript_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 **)**
.. _class_VisualScript_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 **)**
.. _class_VisualScript_set_function_scroll:
- void **set_function_scroll** **(** :ref:`String<class_string>` ofs, :ref:`Vector2<class_vector2>` arg1 **)**
.. _class_VisualScript_set_instance_base_type:
- void **set_instance_base_type** **(** :ref:`String<class_string>` type **)**
.. _class_VisualScript_set_node_pos:
- void **set_node_pos** **(** :ref:`String<class_string>` func, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` pos **)**
.. _class_VisualScript_set_variable_default_value:
- void **set_variable_default_value** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)**
.. _class_VisualScript_set_variable_export:
- void **set_variable_export** **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)**
.. _class_VisualScript_set_variable_info:
- void **set_variable_info** **(** :ref:`String<class_string>` name, :ref:`Dictionary<class_dictionary>` value **)**
Reference in New Issue View Git Blame Copy Permalink