class_visualscripttypecast.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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/VisualScriptTypeCast.xml.
  6. .. _class_VisualScriptTypeCast:
  7. VisualScriptTypeCast
  8. ====================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A Visual Script node that casts the given value to another type.
  11. Description
  12. -----------
  13. ``VisualScriptTypeCast`` will perform a type conversion to an :ref:`Object<class_Object>`-derived type.
  14. Properties
  15. ----------
  16. +-------------------------------------+---------------------------------------------------------------------+---------------+
  17. | :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptTypeCast_property_base_script>` | ``""`` |
  18. +-------------------------------------+---------------------------------------------------------------------+---------------+
  19. | :ref:`StringName<class_StringName>` | :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` | ``&"Object"`` |
  20. +-------------------------------------+---------------------------------------------------------------------+---------------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_VisualScriptTypeCast_property_base_script:
  24. - :ref:`String<class_String>` **base_script**
  25. +-----------+------------------------+
  26. | *Default* | ``""`` |
  27. +-----------+------------------------+
  28. | *Setter* | set_base_script(value) |
  29. +-----------+------------------------+
  30. | *Getter* | get_base_script() |
  31. +-----------+------------------------+
  32. The target script class to be converted to. If none, only the :ref:`base_type<class_VisualScriptTypeCast_property_base_type>` will be used.
  33. ----
  34. .. _class_VisualScriptTypeCast_property_base_type:
  35. - :ref:`StringName<class_StringName>` **base_type**
  36. +-----------+----------------------+
  37. | *Default* | ``&"Object"`` |
  38. +-----------+----------------------+
  39. | *Setter* | set_base_type(value) |
  40. +-----------+----------------------+
  41. | *Getter* | get_base_type() |
  42. +-----------+----------------------+
  43. The target type to be converted to.
  44. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  45. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  46. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  47. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  48. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  49. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`