Files
godot-docs/classes/class_visualscriptclassconstant.rst
2017-10-21 14:03:27 +02:00

77 lines
3.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.
Member Functions
----------------
+------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_base_type<class_VisualScriptClassConstant_get_base_type>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_class_constant<class_VisualScriptClassConstant_get_class_constant>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_base_type<class_VisualScriptClassConstant_set_base_type>` **(** :ref:`String<class_string>` name **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_class_constant<class_VisualScriptClassConstant_set_class_constant>` **(** :ref:`String<class_string>` name **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_VisualScriptClassConstant_base_type:
- :ref:`String<class_string>` **base_type** - The constant's parent class.
.. _class_VisualScriptClassConstant_constant:
- :ref:`String<class_string>` **constant** - The constant to return. See the given class for its available constants.
Description
-----------
This node returns a constant from a given class, such as @GlobalScope.TYPE_INT. See the given class' documentation for available constants.
**Input Ports:**
none
**Output Ports:**
- Data (variant): ``value``
Member Function Description
---------------------------
.. _class_VisualScriptClassConstant_get_base_type:
- :ref:`String<class_string>` **get_base_type** **(** **)**
.. _class_VisualScriptClassConstant_get_class_constant:
- :ref:`String<class_string>` **get_class_constant** **(** **)**
.. _class_VisualScriptClassConstant_set_base_type:
- void **set_base_type** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScriptClassConstant_set_class_constant:
- void **set_class_constant** **(** :ref:`String<class_string>` name **)**