class_visualscriptfunctioncall.rst 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  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. Member Functions
  12. ----------------
  13. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_VisualScriptFunctionCall_get_base_path>` **(** **)** const |
  15. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`String<class_string>` | :ref:`get_base_script<class_VisualScriptFunctionCall_get_base_script>` **(** **)** const |
  17. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_string>` | :ref:`get_base_type<class_VisualScriptFunctionCall_get_base_type>` **(** **)** const |
  19. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`get_basic_type<class_VisualScriptFunctionCall_get_basic_type>` **(** **)** const |
  21. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`get_call_mode<class_VisualScriptFunctionCall_get_call_mode>` **(** **)** const |
  23. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`String<class_string>` | :ref:`get_function<class_VisualScriptFunctionCall_get_function>` **(** **)** const |
  25. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`int<class_int>` | :ref:`get_rpc_call_mode<class_VisualScriptFunctionCall_get_rpc_call_mode>` **(** **)** const |
  27. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`String<class_string>` | :ref:`get_singleton<class_VisualScriptFunctionCall_get_singleton>` **(** **)** const |
  29. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`int<class_int>` | :ref:`get_use_default_args<class_VisualScriptFunctionCall_get_use_default_args>` **(** **)** const |
  31. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`get_validate<class_VisualScriptFunctionCall_get_validate>` **(** **)** const |
  33. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`set_base_path<class_VisualScriptFunctionCall_set_base_path>` **(** :ref:`NodePath<class_nodepath>` base_path **)** |
  35. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`set_base_script<class_VisualScriptFunctionCall_set_base_script>` **(** :ref:`String<class_string>` base_script **)** |
  37. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`set_base_type<class_VisualScriptFunctionCall_set_base_type>` **(** :ref:`String<class_string>` base_type **)** |
  39. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_basic_type<class_VisualScriptFunctionCall_set_basic_type>` **(** :ref:`int<class_int>` basic_type **)** |
  41. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_call_mode<class_VisualScriptFunctionCall_set_call_mode>` **(** :ref:`int<class_int>` mode **)** |
  43. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_function<class_VisualScriptFunctionCall_set_function>` **(** :ref:`String<class_string>` function **)** |
  45. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  46. | void | :ref:`set_rpc_call_mode<class_VisualScriptFunctionCall_set_rpc_call_mode>` **(** :ref:`int<class_int>` mode **)** |
  47. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`set_singleton<class_VisualScriptFunctionCall_set_singleton>` **(** :ref:`String<class_string>` singleton **)** |
  49. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_use_default_args<class_VisualScriptFunctionCall_set_use_default_args>` **(** :ref:`int<class_int>` amount **)** |
  51. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`set_validate<class_VisualScriptFunctionCall_set_validate>` **(** :ref:`bool<class_bool>` enable **)** |
  53. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  54. Member Variables
  55. ----------------
  56. - :ref:`Dictionary<class_dictionary>` **argument_cache**
  57. - :ref:`String<class_string>` **base_script**
  58. - :ref:`String<class_string>` **base_type**
  59. - :ref:`int<class_int>` **basic_type**
  60. - :ref:`int<class_int>` **call_mode**
  61. - :ref:`String<class_string>` **function**
  62. - :ref:`NodePath<class_nodepath>` **node_path**
  63. - :ref:`int<class_int>` **rpc_call_mode**
  64. - :ref:`String<class_string>` **singleton**
  65. - :ref:`int<class_int>` **use_default_args**
  66. - :ref:`bool<class_bool>` **validate**
  67. Numeric Constants
  68. -----------------
  69. - **CALL_MODE_SELF** = **0**
  70. - **CALL_MODE_NODE_PATH** = **1**
  71. - **CALL_MODE_INSTANCE** = **2**
  72. - **CALL_MODE_BASIC_TYPE** = **3**
  73. - **CALL_MODE_SINGLETON** = **4**
  74. - **RPC_DISABLED** = **0**
  75. - **RPC_RELIABLE** = **1**
  76. - **RPC_UNRELIABLE** = **2**
  77. - **RPC_RELIABLE_TO_ID** = **3**
  78. - **RPC_UNRELIABLE_TO_ID** = **4**
  79. Member Function Description
  80. ---------------------------
  81. .. _class_VisualScriptFunctionCall_get_base_path:
  82. - :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
  83. .. _class_VisualScriptFunctionCall_get_base_script:
  84. - :ref:`String<class_string>` **get_base_script** **(** **)** const
  85. .. _class_VisualScriptFunctionCall_get_base_type:
  86. - :ref:`String<class_string>` **get_base_type** **(** **)** const
  87. .. _class_VisualScriptFunctionCall_get_basic_type:
  88. - :ref:`int<class_int>` **get_basic_type** **(** **)** const
  89. .. _class_VisualScriptFunctionCall_get_call_mode:
  90. - :ref:`int<class_int>` **get_call_mode** **(** **)** const
  91. .. _class_VisualScriptFunctionCall_get_function:
  92. - :ref:`String<class_string>` **get_function** **(** **)** const
  93. .. _class_VisualScriptFunctionCall_get_rpc_call_mode:
  94. - :ref:`int<class_int>` **get_rpc_call_mode** **(** **)** const
  95. .. _class_VisualScriptFunctionCall_get_singleton:
  96. - :ref:`String<class_string>` **get_singleton** **(** **)** const
  97. .. _class_VisualScriptFunctionCall_get_use_default_args:
  98. - :ref:`int<class_int>` **get_use_default_args** **(** **)** const
  99. .. _class_VisualScriptFunctionCall_get_validate:
  100. - :ref:`bool<class_bool>` **get_validate** **(** **)** const
  101. .. _class_VisualScriptFunctionCall_set_base_path:
  102. - void **set_base_path** **(** :ref:`NodePath<class_nodepath>` base_path **)**
  103. .. _class_VisualScriptFunctionCall_set_base_script:
  104. - void **set_base_script** **(** :ref:`String<class_string>` base_script **)**
  105. .. _class_VisualScriptFunctionCall_set_base_type:
  106. - void **set_base_type** **(** :ref:`String<class_string>` base_type **)**
  107. .. _class_VisualScriptFunctionCall_set_basic_type:
  108. - void **set_basic_type** **(** :ref:`int<class_int>` basic_type **)**
  109. .. _class_VisualScriptFunctionCall_set_call_mode:
  110. - void **set_call_mode** **(** :ref:`int<class_int>` mode **)**
  111. .. _class_VisualScriptFunctionCall_set_function:
  112. - void **set_function** **(** :ref:`String<class_string>` function **)**
  113. .. _class_VisualScriptFunctionCall_set_rpc_call_mode:
  114. - void **set_rpc_call_mode** **(** :ref:`int<class_int>` mode **)**
  115. .. _class_VisualScriptFunctionCall_set_singleton:
  116. - void **set_singleton** **(** :ref:`String<class_string>` singleton **)**
  117. .. _class_VisualScriptFunctionCall_set_use_default_args:
  118. - void **set_use_default_args** **(** :ref:`int<class_int>` amount **)**
  119. .. _class_VisualScriptFunctionCall_set_validate:
  120. - void **set_validate** **(** :ref:`bool<class_bool>` enable **)**