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

68 lines
2.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptClassConstant.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptClassConstant:
VisualScriptClassConstant
=========================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Gets a constant from a given class.
Properties
----------
+-----------------------------+----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` |
+-----------------------------+----------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` |
+-----------------------------+----------------------------------------------------------------------+
Description
-----------
This node returns a constant from a given class, such as :ref:`@GlobalScope.TYPE_INT<class_@GlobalScope_constant_TYPE_INT>`. See the given class' documentation for available constants.
**Input Ports:**
none
**Output Ports:**
- Data (variant): ``value``
Property Descriptions
---------------------
.. _class_VisualScriptClassConstant_property_base_type:
- :ref:`String<class_String>` **base_type**
+----------+----------------------+
| *Setter* | set_base_type(value) |
+----------+----------------------+
| *Getter* | get_base_type() |
+----------+----------------------+
The constant's parent class.
.. _class_VisualScriptClassConstant_property_constant:
- :ref:`String<class_String>` **constant**
+----------+---------------------------+
| *Setter* | set_class_constant(value) |
+----------+---------------------------+
| *Getter* | get_class_constant() |
+----------+---------------------------+
The constant to return. See the given class for its available constants.