2
0

class_visualscriptfunctioncall.rst 7.7 KB

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