class_visualscriptclassconstant.rst 2.3 KB

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