Files
godot-docs/classes/class_visualscripttypecast.rst
2021-11-19 10:05:42 +01:00

66 lines
2.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptTypeCast.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptTypeCast:
VisualScriptTypeCast
====================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
A Visual Script node that casts the given value to another type.
Description
-----------
``VisualScriptTypeCast`` will perform a type conversion to an :ref:`Object<class_Object>`-derived type.
Properties
----------
+-----------------------------+---------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptTypeCast_property_base_script>` | ``""`` |
+-----------------------------+---------------------------------------------------------------------+--------------+
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` | ``"Object"`` |
+-----------------------------+---------------------------------------------------------------------+--------------+
Property Descriptions
---------------------
.. _class_VisualScriptTypeCast_property_base_script:
- :ref:`String<class_String>` **base_script**
+-----------+------------------------+
| *Default* | ``""`` |
+-----------+------------------------+
| *Setter* | set_base_script(value) |
+-----------+------------------------+
| *Getter* | get_base_script() |
+-----------+------------------------+
The target script class to be converted to. If none, only the :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` will be used.
----
.. _class_VisualScriptTypeCast_property_base_type:
- :ref:`String<class_String>` **base_type**
+-----------+----------------------+
| *Default* | ``"Object"`` |
+-----------+----------------------+
| *Setter* | set_base_type(value) |
+-----------+----------------------+
| *Getter* | get_base_type() |
+-----------+----------------------+
The target type to be converted to.
.. |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.)`