class_visualscriptpropertyget.rst 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  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 VisualScriptPropertyGet.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptPropertyGet:
  6. VisualScriptPropertyGet
  7. =======================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  12. | :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptPropertyGet_property_base_script>` | |
  13. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  14. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptPropertyGet_property_base_type>` | ``"Object"`` |
  15. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  16. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptPropertyGet_property_basic_type>` | |
  17. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  18. | :ref:`String<class_String>` | :ref:`index<class_VisualScriptPropertyGet_property_index>` | |
  19. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  20. | :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptPropertyGet_property_node_path>` | |
  21. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  22. | :ref:`String<class_String>` | :ref:`property<class_VisualScriptPropertyGet_property_property>` | ``""`` |
  23. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  24. | :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` | :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` | ``0`` |
  25. +--------------------------------------------------------+------------------------------------------------------------------------+--------------+
  26. Enumerations
  27. ------------
  28. .. _enum_VisualScriptPropertyGet_CallMode:
  29. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_SELF:
  30. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_NODE_PATH:
  31. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_INSTANCE:
  32. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_BASIC_TYPE:
  33. enum **CallMode**:
  34. - **CALL_MODE_SELF** = **0**
  35. - **CALL_MODE_NODE_PATH** = **1**
  36. - **CALL_MODE_INSTANCE** = **2**
  37. - **CALL_MODE_BASIC_TYPE** = **3**
  38. Property Descriptions
  39. ---------------------
  40. .. _class_VisualScriptPropertyGet_property_base_script:
  41. - :ref:`String<class_String>` **base_script**
  42. +----------+------------------------+
  43. | *Setter* | set_base_script(value) |
  44. +----------+------------------------+
  45. | *Getter* | get_base_script() |
  46. +----------+------------------------+
  47. ----
  48. .. _class_VisualScriptPropertyGet_property_base_type:
  49. - :ref:`String<class_String>` **base_type**
  50. +-----------+----------------------+
  51. | *Default* | ``"Object"`` |
  52. +-----------+----------------------+
  53. | *Setter* | set_base_type(value) |
  54. +-----------+----------------------+
  55. | *Getter* | get_base_type() |
  56. +-----------+----------------------+
  57. ----
  58. .. _class_VisualScriptPropertyGet_property_basic_type:
  59. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  60. +----------+-----------------------+
  61. | *Setter* | set_basic_type(value) |
  62. +----------+-----------------------+
  63. | *Getter* | get_basic_type() |
  64. +----------+-----------------------+
  65. ----
  66. .. _class_VisualScriptPropertyGet_property_index:
  67. - :ref:`String<class_String>` **index**
  68. +----------+------------------+
  69. | *Setter* | set_index(value) |
  70. +----------+------------------+
  71. | *Getter* | get_index() |
  72. +----------+------------------+
  73. ----
  74. .. _class_VisualScriptPropertyGet_property_node_path:
  75. - :ref:`NodePath<class_NodePath>` **node_path**
  76. +----------+----------------------+
  77. | *Setter* | set_base_path(value) |
  78. +----------+----------------------+
  79. | *Getter* | get_base_path() |
  80. +----------+----------------------+
  81. ----
  82. .. _class_VisualScriptPropertyGet_property_property:
  83. - :ref:`String<class_String>` **property**
  84. +-----------+---------------------+
  85. | *Default* | ``""`` |
  86. +-----------+---------------------+
  87. | *Setter* | set_property(value) |
  88. +-----------+---------------------+
  89. | *Getter* | get_property() |
  90. +-----------+---------------------+
  91. ----
  92. .. _class_VisualScriptPropertyGet_property_set_mode:
  93. - :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` **set_mode**
  94. +-----------+----------------------+
  95. | *Default* | ``0`` |
  96. +-----------+----------------------+
  97. | *Setter* | set_call_mode(value) |
  98. +-----------+----------------------+
  99. | *Getter* | get_call_mode() |
  100. +-----------+----------------------+
  101. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  102. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  103. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`