class_visualscriptpropertyset.rst 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  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 VisualScriptPropertySet.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptPropertySet:
  6. VisualScriptPropertySet
  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:`AssignOp<enum_VisualScriptPropertySet_AssignOp>` | :ref:`assign_op<class_VisualScriptPropertySet_property_assign_op>` |
  16. +--------------------------------------------------------+------------------------------------------------------------------------+
  17. | :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptPropertySet_property_base_script>` |
  18. +--------------------------------------------------------+------------------------------------------------------------------------+
  19. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptPropertySet_property_base_type>` |
  20. +--------------------------------------------------------+------------------------------------------------------------------------+
  21. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptPropertySet_property_basic_type>` |
  22. +--------------------------------------------------------+------------------------------------------------------------------------+
  23. | :ref:`String<class_String>` | :ref:`index<class_VisualScriptPropertySet_property_index>` |
  24. +--------------------------------------------------------+------------------------------------------------------------------------+
  25. | :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptPropertySet_property_node_path>` |
  26. +--------------------------------------------------------+------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | :ref:`property<class_VisualScriptPropertySet_property_property>` |
  28. +--------------------------------------------------------+------------------------------------------------------------------------+
  29. | :ref:`CallMode<enum_VisualScriptPropertySet_CallMode>` | :ref:`set_mode<class_VisualScriptPropertySet_property_set_mode>` |
  30. +--------------------------------------------------------+------------------------------------------------------------------------+
  31. Enumerations
  32. ------------
  33. .. _enum_VisualScriptPropertySet_CallMode:
  34. .. _class_VisualScriptPropertySet_constant_CALL_MODE_SELF:
  35. .. _class_VisualScriptPropertySet_constant_CALL_MODE_NODE_PATH:
  36. .. _class_VisualScriptPropertySet_constant_CALL_MODE_INSTANCE:
  37. .. _class_VisualScriptPropertySet_constant_CALL_MODE_BASIC_TYPE:
  38. enum **CallMode**:
  39. - **CALL_MODE_SELF** = **0**
  40. - **CALL_MODE_NODE_PATH** = **1**
  41. - **CALL_MODE_INSTANCE** = **2**
  42. - **CALL_MODE_BASIC_TYPE** = **3**
  43. ----
  44. .. _enum_VisualScriptPropertySet_AssignOp:
  45. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_NONE:
  46. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_ADD:
  47. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SUB:
  48. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_MUL:
  49. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_DIV:
  50. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_MOD:
  51. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SHIFT_LEFT:
  52. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SHIFT_RIGHT:
  53. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_AND:
  54. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_OR:
  55. .. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_XOR:
  56. enum **AssignOp**:
  57. - **ASSIGN_OP_NONE** = **0**
  58. - **ASSIGN_OP_ADD** = **1**
  59. - **ASSIGN_OP_SUB** = **2**
  60. - **ASSIGN_OP_MUL** = **3**
  61. - **ASSIGN_OP_DIV** = **4**
  62. - **ASSIGN_OP_MOD** = **5**
  63. - **ASSIGN_OP_SHIFT_LEFT** = **6**
  64. - **ASSIGN_OP_SHIFT_RIGHT** = **7**
  65. - **ASSIGN_OP_BIT_AND** = **8**
  66. - **ASSIGN_OP_BIT_OR** = **9**
  67. - **ASSIGN_OP_BIT_XOR** = **10**
  68. Property Descriptions
  69. ---------------------
  70. .. _class_VisualScriptPropertySet_property_assign_op:
  71. - :ref:`AssignOp<enum_VisualScriptPropertySet_AssignOp>` **assign_op**
  72. +----------+----------------------+
  73. | *Setter* | set_assign_op(value) |
  74. +----------+----------------------+
  75. | *Getter* | get_assign_op() |
  76. +----------+----------------------+
  77. ----
  78. .. _class_VisualScriptPropertySet_property_base_script:
  79. - :ref:`String<class_String>` **base_script**
  80. +----------+------------------------+
  81. | *Setter* | set_base_script(value) |
  82. +----------+------------------------+
  83. | *Getter* | get_base_script() |
  84. +----------+------------------------+
  85. ----
  86. .. _class_VisualScriptPropertySet_property_base_type:
  87. - :ref:`String<class_String>` **base_type**
  88. +----------+----------------------+
  89. | *Setter* | set_base_type(value) |
  90. +----------+----------------------+
  91. | *Getter* | get_base_type() |
  92. +----------+----------------------+
  93. ----
  94. .. _class_VisualScriptPropertySet_property_basic_type:
  95. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  96. +----------+-----------------------+
  97. | *Setter* | set_basic_type(value) |
  98. +----------+-----------------------+
  99. | *Getter* | get_basic_type() |
  100. +----------+-----------------------+
  101. ----
  102. .. _class_VisualScriptPropertySet_property_index:
  103. - :ref:`String<class_String>` **index**
  104. +----------+------------------+
  105. | *Setter* | set_index(value) |
  106. +----------+------------------+
  107. | *Getter* | get_index() |
  108. +----------+------------------+
  109. ----
  110. .. _class_VisualScriptPropertySet_property_node_path:
  111. - :ref:`NodePath<class_NodePath>` **node_path**
  112. +----------+----------------------+
  113. | *Setter* | set_base_path(value) |
  114. +----------+----------------------+
  115. | *Getter* | get_base_path() |
  116. +----------+----------------------+
  117. ----
  118. .. _class_VisualScriptPropertySet_property_property:
  119. - :ref:`String<class_String>` **property**
  120. +----------+---------------------+
  121. | *Setter* | set_property(value) |
  122. +----------+---------------------+
  123. | *Getter* | get_property() |
  124. +----------+---------------------+
  125. ----
  126. .. _class_VisualScriptPropertySet_property_set_mode:
  127. - :ref:`CallMode<enum_VisualScriptPropertySet_CallMode>` **set_mode**
  128. +----------+----------------------+
  129. | *Setter* | set_call_mode(value) |
  130. +----------+----------------------+
  131. | *Getter* | get_call_mode() |
  132. +----------+----------------------+