class_visualscriptbasictypeconstant.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. A Visual Script node representing a constant from the base types.
  10. Description
  11. -----------
  12. A Visual Script node representing a constant from base types, such as :ref:`Vector3.AXIS_X<class_Vector3_constant_AXIS_X>`.
  13. Properties
  14. ----------
  15. +-----------------------------------------------------+----------------------------------------------------------------------------+-------+
  16. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptBasicTypeConstant_property_basic_type>` | ``0`` |
  17. +-----------------------------------------------------+----------------------------------------------------------------------------+-------+
  18. | :ref:`StringName<class_StringName>` | :ref:`constant<class_VisualScriptBasicTypeConstant_property_constant>` | |
  19. +-----------------------------------------------------+----------------------------------------------------------------------------+-------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_VisualScriptBasicTypeConstant_property_basic_type:
  23. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  24. +-----------+-----------------------+
  25. | *Default* | ``0`` |
  26. +-----------+-----------------------+
  27. | *Setter* | set_basic_type(value) |
  28. +-----------+-----------------------+
  29. | *Getter* | get_basic_type() |
  30. +-----------+-----------------------+
  31. The type to get the constant from.
  32. ----
  33. .. _class_VisualScriptBasicTypeConstant_property_constant:
  34. - :ref:`StringName<class_StringName>` **constant**
  35. +----------+--------------------------------+
  36. | *Setter* | set_basic_type_constant(value) |
  37. +----------+--------------------------------+
  38. | *Getter* | get_basic_type_constant() |
  39. +----------+--------------------------------+
  40. The name of the constant to return.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  45. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  46. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`