godot-docs/classes/class_visualscriptfunctioncall.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptFunctionCall.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisualScriptFunctionCall:

VisualScriptFunctionCall
========================

**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

A Visual Script node for calling a function.

Description
-----------

``VisualScriptFunctionCall`` is created when you add or drag and drop a function onto the Visual Script graph. It allows to tweak parameters of the call, e.g. what object the function is called on.

Properties
----------

+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`String<class_String>`                                   | :ref:`base_script<class_VisualScriptFunctionCall_property_base_script>`           |              |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`String<class_String>`                                   | :ref:`base_type<class_VisualScriptFunctionCall_property_base_type>`               | ``"Object"`` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>`           | :ref:`basic_type<class_VisualScriptFunctionCall_property_basic_type>`             |              |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`CallMode<enum_VisualScriptFunctionCall_CallMode>`       | :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>`               | ``0``        |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`String<class_String>`                                   | :ref:`function<class_VisualScriptFunctionCall_property_function>`                 | ``""``       |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`NodePath<class_NodePath>`                               | :ref:`node_path<class_VisualScriptFunctionCall_property_node_path>`               |              |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`RPCCallMode<enum_VisualScriptFunctionCall_RPCCallMode>` | :ref:`rpc_call_mode<class_VisualScriptFunctionCall_property_rpc_call_mode>`       | ``0``        |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`String<class_String>`                                   | :ref:`singleton<class_VisualScriptFunctionCall_property_singleton>`               |              |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`int<class_int>`                                         | :ref:`use_default_args<class_VisualScriptFunctionCall_property_use_default_args>` |              |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+
| :ref:`bool<class_bool>`                                       | :ref:`validate<class_VisualScriptFunctionCall_property_validate>`                 | ``true``     |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+

Enumerations
------------

.. _enum_VisualScriptFunctionCall_CallMode:

.. _class_VisualScriptFunctionCall_constant_CALL_MODE_SELF:

.. _class_VisualScriptFunctionCall_constant_CALL_MODE_NODE_PATH:

.. _class_VisualScriptFunctionCall_constant_CALL_MODE_INSTANCE:

.. _class_VisualScriptFunctionCall_constant_CALL_MODE_BASIC_TYPE:

.. _class_VisualScriptFunctionCall_constant_CALL_MODE_SINGLETON:

enum **CallMode**:

- **CALL_MODE_SELF** = **0** --- The method will be called on this :ref:`Object<class_Object>`.

- **CALL_MODE_NODE_PATH** = **1** --- The method will be called on the given :ref:`Node<class_Node>` in the scene tree.

- **CALL_MODE_INSTANCE** = **2** --- The method will be called on an instanced node with the given type and script.

- **CALL_MODE_BASIC_TYPE** = **3** --- The method will be called on a GDScript basic type (e.g. :ref:`Vector2<class_Vector2>`).

- **CALL_MODE_SINGLETON** = **4** --- The method will be called on a singleton.

----

.. _enum_VisualScriptFunctionCall_RPCCallMode:

.. _class_VisualScriptFunctionCall_constant_RPC_DISABLED:

.. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE:

.. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE:

.. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE_TO_ID:

.. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE_TO_ID:

enum **RPCCallMode**:

- **RPC_DISABLED** = **0** --- The method will be called locally.

- **RPC_RELIABLE** = **1** --- The method will be called remotely.

- **RPC_UNRELIABLE** = **2** --- The method will be called remotely using an unreliable protocol.

- **RPC_RELIABLE_TO_ID** = **3** --- The method will be called remotely for the given peer.

- **RPC_UNRELIABLE_TO_ID** = **4** --- The method will be called remotely for the given peer, using an unreliable protocol.

Property Descriptions
---------------------

.. _class_VisualScriptFunctionCall_property_base_script:

- :ref:`String<class_String>` **base_script**

+----------+------------------------+
| *Setter* | set_base_script(value) |
+----------+------------------------+
| *Getter* | get_base_script()      |
+----------+------------------------+

The script to be used when :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>` is set to :ref:`CALL_MODE_INSTANCE<class_VisualScriptFunctionCall_constant_CALL_MODE_INSTANCE>`.

----

.. _class_VisualScriptFunctionCall_property_base_type:

- :ref:`String<class_String>` **base_type**

+-----------+----------------------+
| *Default* | ``"Object"``         |
+-----------+----------------------+
| *Setter*  | set_base_type(value) |
+-----------+----------------------+
| *Getter*  | get_base_type()      |
+-----------+----------------------+

The base type to be used when :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>` is set to :ref:`CALL_MODE_INSTANCE<class_VisualScriptFunctionCall_constant_CALL_MODE_INSTANCE>`.

----

.. _class_VisualScriptFunctionCall_property_basic_type:

- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**

+----------+-----------------------+
| *Setter* | set_basic_type(value) |
+----------+-----------------------+
| *Getter* | get_basic_type()      |
+----------+-----------------------+

The type to be used when :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>` is set to :ref:`CALL_MODE_BASIC_TYPE<class_VisualScriptFunctionCall_constant_CALL_MODE_BASIC_TYPE>`.

----

.. _class_VisualScriptFunctionCall_property_call_mode:

- :ref:`CallMode<enum_VisualScriptFunctionCall_CallMode>` **call_mode**

+-----------+----------------------+
| *Default* | ``0``                |
+-----------+----------------------+
| *Setter*  | set_call_mode(value) |
+-----------+----------------------+
| *Getter*  | get_call_mode()      |
+-----------+----------------------+

``call_mode`` determines the target object on which the method will be called. See :ref:`CallMode<enum_VisualScriptFunctionCall_CallMode>` for options.

----

.. _class_VisualScriptFunctionCall_property_function:

- :ref:`String<class_String>` **function**

+-----------+---------------------+
| *Default* | ``""``              |
+-----------+---------------------+
| *Setter*  | set_function(value) |
+-----------+---------------------+
| *Getter*  | get_function()      |
+-----------+---------------------+

The name of the function to be called.

----

.. _class_VisualScriptFunctionCall_property_node_path:

- :ref:`NodePath<class_NodePath>` **node_path**

+----------+----------------------+
| *Setter* | set_base_path(value) |
+----------+----------------------+
| *Getter* | get_base_path()      |
+----------+----------------------+

The node path to use when :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>` is set to :ref:`CALL_MODE_NODE_PATH<class_VisualScriptFunctionCall_constant_CALL_MODE_NODE_PATH>`.

----

.. _class_VisualScriptFunctionCall_property_rpc_call_mode:

- :ref:`RPCCallMode<enum_VisualScriptFunctionCall_RPCCallMode>` **rpc_call_mode**

+-----------+--------------------------+
| *Default* | ``0``                    |
+-----------+--------------------------+
| *Setter*  | set_rpc_call_mode(value) |
+-----------+--------------------------+
| *Getter*  | get_rpc_call_mode()      |
+-----------+--------------------------+

The mode for RPC calls. See :ref:`Node.rpc<class_Node_method_rpc>` for more details and :ref:`RPCCallMode<enum_VisualScriptFunctionCall_RPCCallMode>` for available options.

----

.. _class_VisualScriptFunctionCall_property_singleton:

- :ref:`String<class_String>` **singleton**

+----------+----------------------+
| *Setter* | set_singleton(value) |
+----------+----------------------+
| *Getter* | get_singleton()      |
+----------+----------------------+

The singleton to call the method on. Used when :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>` is set to :ref:`CALL_MODE_SINGLETON<class_VisualScriptFunctionCall_constant_CALL_MODE_SINGLETON>`.

----

.. _class_VisualScriptFunctionCall_property_use_default_args:

- :ref:`int<class_int>` **use_default_args**

+----------+-----------------------------+
| *Setter* | set_use_default_args(value) |
+----------+-----------------------------+
| *Getter* | get_use_default_args()      |
+----------+-----------------------------+

Number of default arguments that will be used when calling the function. Can't be higher than the number of available default arguments in the method's declaration.

----

.. _class_VisualScriptFunctionCall_property_validate:

- :ref:`bool<class_bool>` **validate**

+-----------+---------------------+
| *Default* | ``true``            |
+-----------+---------------------+
| *Setter*  | set_validate(value) |
+-----------+---------------------+
| *Getter*  | get_validate()      |
+-----------+---------------------+

If ``false``, call errors (e.g. wrong number of arguments) will be ignored.

.. |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.)`