:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml. .. _class_VisualScriptFunctionCall: VisualScriptFunctionCall ======================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` A Visual Script node for calling a function. .. rst-class:: classref-introduction-group 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. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`String` | :ref:`base_script` | | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`String` | :ref:`base_type` | ``"Object"`` | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`Variant.Type` | :ref:`basic_type` | | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`CallMode` | :ref:`call_mode` | ``0`` | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`String` | :ref:`function` | ``""`` | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`NodePath` | :ref:`node_path` | | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`RPCCallMode` | :ref:`rpc_call_mode` | ``0`` | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`String` | :ref:`singleton` | | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`int` | :ref:`use_default_args` | | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ | :ref:`bool` | :ref:`validate` | ``true`` | +---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualScriptFunctionCall_CallMode: .. rst-class:: classref-enumeration enum **CallMode**: .. _class_VisualScriptFunctionCall_constant_CALL_MODE_SELF: .. rst-class:: classref-enumeration-constant :ref:`CallMode` **CALL_MODE_SELF** = ``0`` The method will be called on this :ref:`Object`. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_NODE_PATH: .. rst-class:: classref-enumeration-constant :ref:`CallMode` **CALL_MODE_NODE_PATH** = ``1`` The method will be called on the given :ref:`Node` in the scene tree. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_INSTANCE: .. rst-class:: classref-enumeration-constant :ref:`CallMode` **CALL_MODE_INSTANCE** = ``2`` The method will be called on an instanced node with the given type and script. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_BASIC_TYPE: .. rst-class:: classref-enumeration-constant :ref:`CallMode` **CALL_MODE_BASIC_TYPE** = ``3`` The method will be called on a GDScript basic type (e.g. :ref:`Vector2`). .. _class_VisualScriptFunctionCall_constant_CALL_MODE_SINGLETON: .. rst-class:: classref-enumeration-constant :ref:`CallMode` **CALL_MODE_SINGLETON** = ``4`` The method will be called on a singleton. .. rst-class:: classref-item-separator ---- .. _enum_VisualScriptFunctionCall_RPCCallMode: .. rst-class:: classref-enumeration enum **RPCCallMode**: .. _class_VisualScriptFunctionCall_constant_RPC_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`RPCCallMode` **RPC_DISABLED** = ``0`` The method will be called locally. .. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE: .. rst-class:: classref-enumeration-constant :ref:`RPCCallMode` **RPC_RELIABLE** = ``1`` The method will be called remotely. .. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE: .. rst-class:: classref-enumeration-constant :ref:`RPCCallMode` **RPC_UNRELIABLE** = ``2`` The method will be called remotely using an unreliable protocol. .. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE_TO_ID: .. rst-class:: classref-enumeration-constant :ref:`RPCCallMode` **RPC_RELIABLE_TO_ID** = ``3`` The method will be called remotely for the given peer. .. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE_TO_ID: .. rst-class:: classref-enumeration-constant :ref:`RPCCallMode` **RPC_UNRELIABLE_TO_ID** = ``4`` The method will be called remotely for the given peer, using an unreliable protocol. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualScriptFunctionCall_property_base_script: .. rst-class:: classref-property :ref:`String` **base_script** .. rst-class:: classref-property-setget - void **set_base_script** **(** :ref:`String` value **)** - :ref:`String` **get_base_script** **(** **)** The script to be used when :ref:`call_mode` is set to :ref:`CALL_MODE_INSTANCE`. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_base_type: .. rst-class:: classref-property :ref:`String` **base_type** = ``"Object"`` .. rst-class:: classref-property-setget - void **set_base_type** **(** :ref:`String` value **)** - :ref:`String` **get_base_type** **(** **)** The base type to be used when :ref:`call_mode` is set to :ref:`CALL_MODE_INSTANCE`. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_basic_type: .. rst-class:: classref-property :ref:`Variant.Type` **basic_type** .. rst-class:: classref-property-setget - void **set_basic_type** **(** :ref:`Variant.Type` value **)** - :ref:`Variant.Type` **get_basic_type** **(** **)** The type to be used when :ref:`call_mode` is set to :ref:`CALL_MODE_BASIC_TYPE`. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_call_mode: .. rst-class:: classref-property :ref:`CallMode` **call_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_call_mode** **(** :ref:`CallMode` value **)** - :ref:`CallMode` **get_call_mode** **(** **)** ``call_mode`` determines the target object on which the method will be called. See :ref:`CallMode` for options. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_function: .. rst-class:: classref-property :ref:`String` **function** = ``""`` .. rst-class:: classref-property-setget - void **set_function** **(** :ref:`String` value **)** - :ref:`String` **get_function** **(** **)** The name of the function to be called. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_node_path: .. rst-class:: classref-property :ref:`NodePath` **node_path** .. rst-class:: classref-property-setget - void **set_base_path** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_base_path** **(** **)** The node path to use when :ref:`call_mode` is set to :ref:`CALL_MODE_NODE_PATH`. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_rpc_call_mode: .. rst-class:: classref-property :ref:`RPCCallMode` **rpc_call_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_rpc_call_mode** **(** :ref:`RPCCallMode` value **)** - :ref:`RPCCallMode` **get_rpc_call_mode** **(** **)** The mode for RPC calls. See :ref:`Node.rpc` for more details and :ref:`RPCCallMode` for available options. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_singleton: .. rst-class:: classref-property :ref:`String` **singleton** .. rst-class:: classref-property-setget - void **set_singleton** **(** :ref:`String` value **)** - :ref:`String` **get_singleton** **(** **)** The singleton to call the method on. Used when :ref:`call_mode` is set to :ref:`CALL_MODE_SINGLETON`. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_use_default_args: .. rst-class:: classref-property :ref:`int` **use_default_args** .. rst-class:: classref-property-setget - void **set_use_default_args** **(** :ref:`int` value **)** - :ref:`int` **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. .. rst-class:: classref-item-separator ---- .. _class_VisualScriptFunctionCall_property_validate: .. rst-class:: classref-property :ref:`bool` **validate** = ``true`` .. rst-class:: classref-property-setget - void **set_validate** **(** :ref:`bool` value **)** - :ref:`bool` **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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`