class_visualscriptbasictypeconstant.rst 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml.
  6. .. _class_VisualScriptBasicTypeConstant:
  7. VisualScriptBasicTypeConstant
  8. =============================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A Visual Script node representing a constant from the base types.
  11. Description
  12. -----------
  13. A Visual Script node representing a constant from base types, such as :ref:`Vector3.AXIS_X<class_Vector3_constant_AXIS_X>`.
  14. Properties
  15. ----------
  16. +-----------------------------------------------------+----------------------------------------------------------------------------+-------+
  17. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptBasicTypeConstant_property_basic_type>` | ``0`` |
  18. +-----------------------------------------------------+----------------------------------------------------------------------------+-------+
  19. | :ref:`StringName<class_StringName>` | :ref:`constant<class_VisualScriptBasicTypeConstant_property_constant>` | |
  20. +-----------------------------------------------------+----------------------------------------------------------------------------+-------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_VisualScriptBasicTypeConstant_property_basic_type:
  24. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  25. +-----------+-----------------------+
  26. | *Default* | ``0`` |
  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:`StringName<class_StringName>` **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.
  42. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  43. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  44. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  45. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  46. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  47. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`