class_visualscriptpropertyget.rst 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  15. | :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptPropertyGet_property_base_script>` | |
  16. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  17. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptPropertyGet_property_base_type>` | "Object" |
  18. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  19. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptPropertyGet_property_basic_type>` | |
  20. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  21. | :ref:`String<class_String>` | :ref:`index<class_VisualScriptPropertyGet_property_index>` | |
  22. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  23. | :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptPropertyGet_property_node_path>` | |
  24. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  25. | :ref:`String<class_String>` | :ref:`property<class_VisualScriptPropertyGet_property_property>` | "" |
  26. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  27. | :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` | :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` | 0 |
  28. +--------------------------------------------------------+------------------------------------------------------------------------+----------+
  29. Enumerations
  30. ------------
  31. .. _enum_VisualScriptPropertyGet_CallMode:
  32. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_SELF:
  33. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_NODE_PATH:
  34. .. _class_VisualScriptPropertyGet_constant_CALL_MODE_INSTANCE:
  35. enum **CallMode**:
  36. - **CALL_MODE_SELF** = **0**
  37. - **CALL_MODE_NODE_PATH** = **1**
  38. - **CALL_MODE_INSTANCE** = **2**
  39. Property Descriptions
  40. ---------------------
  41. .. _class_VisualScriptPropertyGet_property_base_script:
  42. - :ref:`String<class_String>` **base_script**
  43. +----------+------------------------+
  44. | *Setter* | set_base_script(value) |
  45. +----------+------------------------+
  46. | *Getter* | get_base_script() |
  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. .. _class_VisualScriptPropertyGet_property_basic_type:
  58. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  59. +----------+-----------------------+
  60. | *Setter* | set_basic_type(value) |
  61. +----------+-----------------------+
  62. | *Getter* | get_basic_type() |
  63. +----------+-----------------------+
  64. .. _class_VisualScriptPropertyGet_property_index:
  65. - :ref:`String<class_String>` **index**
  66. +----------+------------------+
  67. | *Setter* | set_index(value) |
  68. +----------+------------------+
  69. | *Getter* | get_index() |
  70. +----------+------------------+
  71. .. _class_VisualScriptPropertyGet_property_node_path:
  72. - :ref:`NodePath<class_NodePath>` **node_path**
  73. +----------+----------------------+
  74. | *Setter* | set_base_path(value) |
  75. +----------+----------------------+
  76. | *Getter* | get_base_path() |
  77. +----------+----------------------+
  78. .. _class_VisualScriptPropertyGet_property_property:
  79. - :ref:`String<class_String>` **property**
  80. +-----------+---------------------+
  81. | *Default* | "" |
  82. +-----------+---------------------+
  83. | *Setter* | set_property(value) |
  84. +-----------+---------------------+
  85. | *Getter* | get_property() |
  86. +-----------+---------------------+
  87. .. _class_VisualScriptPropertyGet_property_set_mode:
  88. - :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` **set_mode**
  89. +-----------+----------------------+
  90. | *Default* | 0 |
  91. +-----------+----------------------+
  92. | *Setter* | set_call_mode(value) |
  93. +-----------+----------------------+
  94. | *Getter* | get_call_mode() |
  95. +-----------+----------------------+