Files
godot-docs/classes/class_visualscriptfunctioncall.rst
2019-01-07 10:14:12 +01:00

198 lines
7.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.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>`
**Category:** Core
Brief Description
-----------------
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>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+
| :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>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+
| :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>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+
| :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>` |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------+
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**
- **CALL_MODE_NODE_PATH** = **1**
- **CALL_MODE_INSTANCE** = **2**
- **CALL_MODE_BASIC_TYPE** = **3**
- **CALL_MODE_SINGLETON** = **4**
.. _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**
- **RPC_RELIABLE** = **1**
- **RPC_UNRELIABLE** = **2**
- **RPC_RELIABLE_TO_ID** = **3**
- **RPC_UNRELIABLE_TO_ID** = **4**
Property Descriptions
---------------------
.. _class_VisualScriptFunctionCall_property_base_script:
- :ref:`String<class_String>` **base_script**
+----------+------------------------+
| *Setter* | set_base_script(value) |
+----------+------------------------+
| *Getter* | get_base_script() |
+----------+------------------------+
.. _class_VisualScriptFunctionCall_property_base_type:
- :ref:`String<class_String>` **base_type**
+----------+----------------------+
| *Setter* | set_base_type(value) |
+----------+----------------------+
| *Getter* | get_base_type() |
+----------+----------------------+
.. _class_VisualScriptFunctionCall_property_basic_type:
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
+----------+-----------------------+
| *Setter* | set_basic_type(value) |
+----------+-----------------------+
| *Getter* | get_basic_type() |
+----------+-----------------------+
.. _class_VisualScriptFunctionCall_property_call_mode:
- :ref:`CallMode<enum_VisualScriptFunctionCall_CallMode>` **call_mode**
+----------+----------------------+
| *Setter* | set_call_mode(value) |
+----------+----------------------+
| *Getter* | get_call_mode() |
+----------+----------------------+
.. _class_VisualScriptFunctionCall_property_function:
- :ref:`String<class_String>` **function**
+----------+---------------------+
| *Setter* | set_function(value) |
+----------+---------------------+
| *Getter* | get_function() |
+----------+---------------------+
.. _class_VisualScriptFunctionCall_property_node_path:
- :ref:`NodePath<class_NodePath>` **node_path**
+----------+----------------------+
| *Setter* | set_base_path(value) |
+----------+----------------------+
| *Getter* | get_base_path() |
+----------+----------------------+
.. _class_VisualScriptFunctionCall_property_rpc_call_mode:
- :ref:`RPCCallMode<enum_VisualScriptFunctionCall_RPCCallMode>` **rpc_call_mode**
+----------+--------------------------+
| *Setter* | set_rpc_call_mode(value) |
+----------+--------------------------+
| *Getter* | get_rpc_call_mode() |
+----------+--------------------------+
.. _class_VisualScriptFunctionCall_property_singleton:
- :ref:`String<class_String>` **singleton**
+----------+----------------------+
| *Setter* | set_singleton(value) |
+----------+----------------------+
| *Getter* | get_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() |
+----------+-----------------------------+
.. _class_VisualScriptFunctionCall_property_validate:
- :ref:`bool<class_bool>` **validate**
+----------+---------------------+
| *Setter* | set_validate(value) |
+----------+---------------------+
| *Getter* | get_validate() |
+----------+---------------------+