class_visualscriptbasictypeconstant.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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 VisualScriptBasicTypeConstant.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptBasicTypeConstant:
  6. VisualScriptBasicTypeConstant
  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. A Visual Script node representing a constant from the base types.
  13. Properties
  14. ----------
  15. +-----------------------------------------------------+----------------------------------------------------------------------------+
  16. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptBasicTypeConstant_property_basic_type>` |
  17. +-----------------------------------------------------+----------------------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`constant<class_VisualScriptBasicTypeConstant_property_constant>` |
  19. +-----------------------------------------------------+----------------------------------------------------------------------------+
  20. Description
  21. -----------
  22. A Visual Script node representing a constant from base types, such as :ref:`Vector3.AXIS_X<class_Vector3_constant_AXIS_X>`.
  23. Property Descriptions
  24. ---------------------
  25. .. _class_VisualScriptBasicTypeConstant_property_basic_type:
  26. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  27. +----------+-----------------------+
  28. | *Setter* | set_basic_type(value) |
  29. +----------+-----------------------+
  30. | *Getter* | get_basic_type() |
  31. +----------+-----------------------+
  32. The type to get the constant from.
  33. ----
  34. .. _class_VisualScriptBasicTypeConstant_property_constant:
  35. - :ref:`String<class_String>` **constant**
  36. +----------+--------------------------------+
  37. | *Setter* | set_basic_type_constant(value) |
  38. +----------+--------------------------------+
  39. | *Getter* | get_basic_type_constant() |
  40. +----------+--------------------------------+
  41. The name of the constant to return.