class_visualscriptclassconstant.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScriptClassConstant.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScriptClassConstant:
  5. VisualScriptClassConstant
  6. =========================
  7. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Gets a constant from a given class.
  12. Properties
  13. ----------
  14. +-----------------------------+----------------------------------------------------------------------+
  15. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` |
  16. +-----------------------------+----------------------------------------------------------------------+
  17. | :ref:`String<class_String>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` |
  18. +-----------------------------+----------------------------------------------------------------------+
  19. Description
  20. -----------
  21. 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.
  22. **Input Ports:**
  23. none
  24. **Output Ports:**
  25. - Data (variant): ``value``
  26. Property Descriptions
  27. ---------------------
  28. .. _class_VisualScriptClassConstant_property_base_type:
  29. - :ref:`String<class_String>` **base_type**
  30. +----------+----------------------+
  31. | *Setter* | set_base_type(value) |
  32. +----------+----------------------+
  33. | *Getter* | get_base_type() |
  34. +----------+----------------------+
  35. The constant's parent class.
  36. .. _class_VisualScriptClassConstant_property_constant:
  37. - :ref:`String<class_String>` **constant**
  38. +----------+---------------------------+
  39. | *Setter* | set_class_constant(value) |
  40. +----------+---------------------------+
  41. | *Getter* | get_class_constant() |
  42. +----------+---------------------------+
  43. The constant to return. See the given class for its available constants.