class_visualscriptfunctioncall.rst 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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 VisualScriptFunctionCall.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptFunctionCall:
  6. VisualScriptFunctionCall
  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_VisualScriptFunctionCall_property_base_script>` | |
  16. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  17. | :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptFunctionCall_property_base_type>` | "Object" |
  18. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  19. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptFunctionCall_property_basic_type>` | |
  20. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  21. | :ref:`CallMode<enum_VisualScriptFunctionCall_CallMode>` | :ref:`call_mode<class_VisualScriptFunctionCall_property_call_mode>` | 0 |
  22. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  23. | :ref:`String<class_String>` | :ref:`function<class_VisualScriptFunctionCall_property_function>` | "" |
  24. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  25. | :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptFunctionCall_property_node_path>` | |
  26. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  27. | :ref:`RPCCallMode<enum_VisualScriptFunctionCall_RPCCallMode>` | :ref:`rpc_call_mode<class_VisualScriptFunctionCall_property_rpc_call_mode>` | 0 |
  28. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  29. | :ref:`String<class_String>` | :ref:`singleton<class_VisualScriptFunctionCall_property_singleton>` | |
  30. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  31. | :ref:`int<class_int>` | :ref:`use_default_args<class_VisualScriptFunctionCall_property_use_default_args>` | |
  32. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  33. | :ref:`bool<class_bool>` | :ref:`validate<class_VisualScriptFunctionCall_property_validate>` | true |
  34. +---------------------------------------------------------------+-----------------------------------------------------------------------------------+----------+
  35. Enumerations
  36. ------------
  37. .. _enum_VisualScriptFunctionCall_CallMode:
  38. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_SELF:
  39. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_NODE_PATH:
  40. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_INSTANCE:
  41. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_BASIC_TYPE:
  42. .. _class_VisualScriptFunctionCall_constant_CALL_MODE_SINGLETON:
  43. enum **CallMode**:
  44. - **CALL_MODE_SELF** = **0**
  45. - **CALL_MODE_NODE_PATH** = **1**
  46. - **CALL_MODE_INSTANCE** = **2**
  47. - **CALL_MODE_BASIC_TYPE** = **3**
  48. - **CALL_MODE_SINGLETON** = **4**
  49. .. _enum_VisualScriptFunctionCall_RPCCallMode:
  50. .. _class_VisualScriptFunctionCall_constant_RPC_DISABLED:
  51. .. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE:
  52. .. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE:
  53. .. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE_TO_ID:
  54. .. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE_TO_ID:
  55. enum **RPCCallMode**:
  56. - **RPC_DISABLED** = **0**
  57. - **RPC_RELIABLE** = **1**
  58. - **RPC_UNRELIABLE** = **2**
  59. - **RPC_RELIABLE_TO_ID** = **3**
  60. - **RPC_UNRELIABLE_TO_ID** = **4**
  61. Property Descriptions
  62. ---------------------
  63. .. _class_VisualScriptFunctionCall_property_base_script:
  64. - :ref:`String<class_String>` **base_script**
  65. +----------+------------------------+
  66. | *Setter* | set_base_script(value) |
  67. +----------+------------------------+
  68. | *Getter* | get_base_script() |
  69. +----------+------------------------+
  70. .. _class_VisualScriptFunctionCall_property_base_type:
  71. - :ref:`String<class_String>` **base_type**
  72. +-----------+----------------------+
  73. | *Default* | "Object" |
  74. +-----------+----------------------+
  75. | *Setter* | set_base_type(value) |
  76. +-----------+----------------------+
  77. | *Getter* | get_base_type() |
  78. +-----------+----------------------+
  79. .. _class_VisualScriptFunctionCall_property_basic_type:
  80. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
  81. +----------+-----------------------+
  82. | *Setter* | set_basic_type(value) |
  83. +----------+-----------------------+
  84. | *Getter* | get_basic_type() |
  85. +----------+-----------------------+
  86. .. _class_VisualScriptFunctionCall_property_call_mode:
  87. - :ref:`CallMode<enum_VisualScriptFunctionCall_CallMode>` **call_mode**
  88. +-----------+----------------------+
  89. | *Default* | 0 |
  90. +-----------+----------------------+
  91. | *Setter* | set_call_mode(value) |
  92. +-----------+----------------------+
  93. | *Getter* | get_call_mode() |
  94. +-----------+----------------------+
  95. .. _class_VisualScriptFunctionCall_property_function:
  96. - :ref:`String<class_String>` **function**
  97. +-----------+---------------------+
  98. | *Default* | "" |
  99. +-----------+---------------------+
  100. | *Setter* | set_function(value) |
  101. +-----------+---------------------+
  102. | *Getter* | get_function() |
  103. +-----------+---------------------+
  104. .. _class_VisualScriptFunctionCall_property_node_path:
  105. - :ref:`NodePath<class_NodePath>` **node_path**
  106. +----------+----------------------+
  107. | *Setter* | set_base_path(value) |
  108. +----------+----------------------+
  109. | *Getter* | get_base_path() |
  110. +----------+----------------------+
  111. .. _class_VisualScriptFunctionCall_property_rpc_call_mode:
  112. - :ref:`RPCCallMode<enum_VisualScriptFunctionCall_RPCCallMode>` **rpc_call_mode**
  113. +-----------+--------------------------+
  114. | *Default* | 0 |
  115. +-----------+--------------------------+
  116. | *Setter* | set_rpc_call_mode(value) |
  117. +-----------+--------------------------+
  118. | *Getter* | get_rpc_call_mode() |
  119. +-----------+--------------------------+
  120. .. _class_VisualScriptFunctionCall_property_singleton:
  121. - :ref:`String<class_String>` **singleton**
  122. +----------+----------------------+
  123. | *Setter* | set_singleton(value) |
  124. +----------+----------------------+
  125. | *Getter* | get_singleton() |
  126. +----------+----------------------+
  127. .. _class_VisualScriptFunctionCall_property_use_default_args:
  128. - :ref:`int<class_int>` **use_default_args**
  129. +----------+-----------------------------+
  130. | *Setter* | set_use_default_args(value) |
  131. +----------+-----------------------------+
  132. | *Getter* | get_use_default_args() |
  133. +----------+-----------------------------+
  134. .. _class_VisualScriptFunctionCall_property_validate:
  135. - :ref:`bool<class_bool>` **validate**
  136. +-----------+---------------------+
  137. | *Default* | true |
  138. +-----------+---------------------+
  139. | *Setter* | set_validate(value) |
  140. +-----------+---------------------+
  141. | *Getter* | get_validate() |
  142. +-----------+---------------------+