class_visualscriptclassconstant.rst 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.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. Gets a constant from a given class.
  10. Description
  11. -----------
  12. 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.
  13. **Input Ports:**
  14. none
  15. **Output Ports:**
  16. - Data (variant): ``value``
  17. Properties
  18. ----------
  19. +-----------------------------+----------------------------------------------------------------------+--------------+
  20. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptClassConstant_property_base_type>` | ``"Object"`` |
  21. +-----------------------------+----------------------------------------------------------------------+--------------+
  22. | :ref:`String<class_String>` | :ref:`constant<class_VisualScriptClassConstant_property_constant>` | ``""`` |
  23. +-----------------------------+----------------------------------------------------------------------+--------------+
  24. Property Descriptions
  25. ---------------------
  26. .. _class_VisualScriptClassConstant_property_base_type:
  27. - :ref:`String<class_String>` **base_type**
  28. +-----------+----------------------+
  29. | *Default* | ``"Object"`` |
  30. +-----------+----------------------+
  31. | *Setter* | set_base_type(value) |
  32. +-----------+----------------------+
  33. | *Getter* | get_base_type() |
  34. +-----------+----------------------+
  35. The constant's parent class.
  36. ----
  37. .. _class_VisualScriptClassConstant_property_constant:
  38. - :ref:`String<class_String>` **constant**
  39. +-----------+---------------------------+
  40. | *Default* | ``""`` |
  41. +-----------+---------------------------+
  42. | *Setter* | set_class_constant(value) |
  43. +-----------+---------------------------+
  44. | *Getter* | get_class_constant() |
  45. +-----------+---------------------------+
  46. The constant to return. See the given class for its available constants.
  47. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  48. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  49. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`