Files
godot-docs/classes/class_visualscriptyieldsignal.rst
2020-09-15 15:09:00 +02:00

106 lines
3.9 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptYieldSignal.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptYieldSignal:
VisualScriptYieldSignal
=======================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Properties
----------
+--------------------------------------------------------+--------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptYieldSignal_property_base_type>` | ``"Object"`` |
+--------------------------------------------------------+--------------------------------------------------------------------+--------------+
| :ref:`CallMode<enum_VisualScriptYieldSignal_CallMode>` | :ref:`call_mode<class_VisualScriptYieldSignal_property_call_mode>` | ``0`` |
+--------------------------------------------------------+--------------------------------------------------------------------+--------------+
| :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptYieldSignal_property_node_path>` | |
+--------------------------------------------------------+--------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`signal<class_VisualScriptYieldSignal_property_signal>` | ``""`` |
+--------------------------------------------------------+--------------------------------------------------------------------+--------------+
Enumerations
------------
.. _enum_VisualScriptYieldSignal_CallMode:
.. _class_VisualScriptYieldSignal_constant_CALL_MODE_SELF:
.. _class_VisualScriptYieldSignal_constant_CALL_MODE_NODE_PATH:
.. _class_VisualScriptYieldSignal_constant_CALL_MODE_INSTANCE:
enum **CallMode**:
- **CALL_MODE_SELF** = **0**
- **CALL_MODE_NODE_PATH** = **1**
- **CALL_MODE_INSTANCE** = **2**
Property Descriptions
---------------------
.. _class_VisualScriptYieldSignal_property_base_type:
- :ref:`String<class_String>` **base_type**
+-----------+----------------------+
| *Default* | ``"Object"`` |
+-----------+----------------------+
| *Setter* | set_base_type(value) |
+-----------+----------------------+
| *Getter* | get_base_type() |
+-----------+----------------------+
----
.. _class_VisualScriptYieldSignal_property_call_mode:
- :ref:`CallMode<enum_VisualScriptYieldSignal_CallMode>` **call_mode**
+-----------+----------------------+
| *Default* | ``0`` |
+-----------+----------------------+
| *Setter* | set_call_mode(value) |
+-----------+----------------------+
| *Getter* | get_call_mode() |
+-----------+----------------------+
----
.. _class_VisualScriptYieldSignal_property_node_path:
- :ref:`NodePath<class_NodePath>` **node_path**
+----------+----------------------+
| *Setter* | set_base_path(value) |
+----------+----------------------+
| *Getter* | get_base_path() |
+----------+----------------------+
----
.. _class_VisualScriptYieldSignal_property_signal:
- :ref:`String<class_String>` **signal**
+-----------+-------------------+
| *Default* | ``""`` |
+-----------+-------------------+
| *Setter* | set_signal(value) |
+-----------+-------------------+
| *Getter* | get_signal() |
+-----------+-------------------+
.. |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.)`