class_visualscripttypecast.rst 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptTypeCast.xml.
  6. .. _class_VisualScriptTypeCast:
  7. VisualScriptTypeCast
  8. ====================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. A Visual Script node that casts the given value to another type.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **VisualScriptTypeCast** will perform a type conversion to an :ref:`Object<class_Object>`-derived type.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-----------------------------+---------------------------------------------------------------------+--------------+
  21. | :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptTypeCast_property_base_script>` | ``""`` |
  22. +-----------------------------+---------------------------------------------------------------------+--------------+
  23. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` | ``"Object"`` |
  24. +-----------------------------+---------------------------------------------------------------------+--------------+
  25. .. rst-class:: classref-section-separator
  26. ----
  27. .. rst-class:: classref-descriptions-group
  28. Property Descriptions
  29. ---------------------
  30. .. _class_VisualScriptTypeCast_property_base_script:
  31. .. rst-class:: classref-property
  32. :ref:`String<class_String>` **base_script** = ``""``
  33. .. rst-class:: classref-property-setget
  34. - void **set_base_script** **(** :ref:`String<class_String>` value **)**
  35. - :ref:`String<class_String>` **get_base_script** **(** **)**
  36. The target script class to be converted to. If none, only the :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` will be used.
  37. .. rst-class:: classref-item-separator
  38. ----
  39. .. _class_VisualScriptTypeCast_property_base_type:
  40. .. rst-class:: classref-property
  41. :ref:`String<class_String>` **base_type** = ``"Object"``
  42. .. rst-class:: classref-property-setget
  43. - void **set_base_type** **(** :ref:`String<class_String>` value **)**
  44. - :ref:`String<class_String>` **get_base_type** **(** **)**
  45. The target type to be converted to.
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  49. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`