홈 탐색 도움말
로그인
godotengine
/
godot-docs
의 미러 https://github.com/godotengine/godot-docs
Watch 1
Star 1
포크 0
파일
트리: 7a86ac6a30
브랜치 태그
godot-docs
/
classes
/
class_visualscriptcustomnode.rst

class_visualscriptcustomnode.rst 18 KB
히스토리 Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the VisualScriptCustomNode.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_VisualScriptCustomNode:
    8. 

  8. 

  9. VisualScriptCustomNode
    10. 

  10. ======================
    11. 

  11. 

  12. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. A scripted Visual Script node.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. A custom Visual Script node which can be scripted in powerful ways.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`String<class_String>`   | :ref:`_get_caption<class_VisualScriptCustomNode_method__get_caption>` **(** **)** |virtual|                                                                                                                                |
    26. 

  26. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`String<class_String>`   | :ref:`_get_category<class_VisualScriptCustomNode_method__get_category>` **(** **)** |virtual|                                                                                                                              |
    28. 

  28. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`int<class_int>`         | :ref:`_get_input_value_port_count<class_VisualScriptCustomNode_method__get_input_value_port_count>` **(** **)** |virtual|                                                                                                  |
    30. 

  30. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`int<class_int>`         | :ref:`_get_input_value_port_hint<class_VisualScriptCustomNode_method__get_input_value_port_hint>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                          |
    32. 

  32. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`String<class_String>`   | :ref:`_get_input_value_port_hint_string<class_VisualScriptCustomNode_method__get_input_value_port_hint_string>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                            |
    34. 

  34. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`String<class_String>`   | :ref:`_get_input_value_port_name<class_VisualScriptCustomNode_method__get_input_value_port_name>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                          |
    36. 

  36. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`int<class_int>`         | :ref:`_get_input_value_port_type<class_VisualScriptCustomNode_method__get_input_value_port_type>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                          |
    38. 

  38. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`int<class_int>`         | :ref:`_get_output_sequence_port_count<class_VisualScriptCustomNode_method__get_output_sequence_port_count>` **(** **)** |virtual|                                                                                          |
    40. 

  40. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`String<class_String>`   | :ref:`_get_output_sequence_port_text<class_VisualScriptCustomNode_method__get_output_sequence_port_text>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                  |
    42. 

  42. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`int<class_int>`         | :ref:`_get_output_value_port_count<class_VisualScriptCustomNode_method__get_output_value_port_count>` **(** **)** |virtual|                                                                                                |
    44. 

  44. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`int<class_int>`         | :ref:`_get_output_value_port_hint<class_VisualScriptCustomNode_method__get_output_value_port_hint>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                        |
    46. 

  46. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`String<class_String>`   | :ref:`_get_output_value_port_hint_string<class_VisualScriptCustomNode_method__get_output_value_port_hint_string>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                          |
    48. 

  48. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`String<class_String>`   | :ref:`_get_output_value_port_name<class_VisualScriptCustomNode_method__get_output_value_port_name>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                        |
    50. 

  50. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`int<class_int>`         | :ref:`_get_output_value_port_type<class_VisualScriptCustomNode_method__get_output_value_port_type>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                        |
    52. 

  52. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`String<class_String>`   | :ref:`_get_text<class_VisualScriptCustomNode_method__get_text>` **(** **)** |virtual|                                                                                                                                      |
    54. 

  54. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`int<class_int>`         | :ref:`_get_working_memory_size<class_VisualScriptCustomNode_method__get_working_memory_size>` **(** **)** |virtual|                                                                                                        |
    56. 

  56. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | :ref:`bool<class_bool>`       | :ref:`_has_input_sequence_port<class_VisualScriptCustomNode_method__has_input_sequence_port>` **(** **)** |virtual|                                                                                                        |
    58. 

  58. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | :ref:`Variant<class_Variant>` | :ref:`_step<class_VisualScriptCustomNode_method__step>` **(** :ref:`Array<class_Array>` inputs, :ref:`Array<class_Array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_Array>` working_mem **)** |virtual| |
    60. 

  60. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. 

  62. Enumerations
    63. 

  63. ------------
    64. 

  64. 

  65. .. _enum_VisualScriptCustomNode_StartMode:
    66. 

  66. 

  67. .. _class_VisualScriptCustomNode_constant_START_MODE_BEGIN_SEQUENCE:
    68. 

  68. 

  69. .. _class_VisualScriptCustomNode_constant_START_MODE_CONTINUE_SEQUENCE:
    70. 

  70. 

  71. .. _class_VisualScriptCustomNode_constant_START_MODE_RESUME_YIELD:
    72. 

  72. 

  73. enum **StartMode**:
    74. 

  74. 

  75. - **START_MODE_BEGIN_SEQUENCE** = **0** --- The start mode used the first time when :ref:`_step<class_VisualScriptCustomNode_method__step>` is called.
    76. 

  76. 

  77. - **START_MODE_CONTINUE_SEQUENCE** = **1** --- The start mode used when :ref:`_step<class_VisualScriptCustomNode_method__step>` is called after coming back from a :ref:`STEP_PUSH_STACK_BIT<class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT>`.
    78. 

  78. 

  79. - **START_MODE_RESUME_YIELD** = **2** --- The start mode used when :ref:`_step<class_VisualScriptCustomNode_method__step>` is called after resuming from :ref:`STEP_YIELD_BIT<class_VisualScriptCustomNode_constant_STEP_YIELD_BIT>`.
    80. 

  80. 

  81. Constants
    82. 

  82. ---------
    83. 

  83. 

  84. .. _class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT:
    85. 

  85. 

  86. .. _class_VisualScriptCustomNode_constant_STEP_GO_BACK_BIT:
    87. 

  87. 

  88. .. _class_VisualScriptCustomNode_constant_STEP_NO_ADVANCE_BIT:
    89. 

  89. 

  90. .. _class_VisualScriptCustomNode_constant_STEP_EXIT_FUNCTION_BIT:
    91. 

  91. 

  92. .. _class_VisualScriptCustomNode_constant_STEP_YIELD_BIT:
    93. 

  93. 

  94. - **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_method__step>` to tell that control should return to it when there is no other node left to execute.
    95. 

  95. 

  96. This is used by :ref:`VisualScriptCondition<class_VisualScriptCondition>` to redirect the sequence to the "Done" port after the ``true``/``false`` branch has finished execution.
    97. 

  97. 

  98. - **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_method__step>` to tell that control should return back, either hitting a previous :ref:`STEP_PUSH_STACK_BIT<class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT>` or exiting the function.
    99. 

  99. 

  100. - **STEP_NO_ADVANCE_BIT** = **67108864**
    101. 

  101. 

  102. - **STEP_EXIT_FUNCTION_BIT** = **134217728** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_method__step>` to tell that control should stop and exit the function.
    103. 

  103. 

  104. - **STEP_YIELD_BIT** = **268435456** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_method__step>` to tell that the function should be yielded.
    105. 

  105. 

  106. Using this requires you to have at least one working memory slot, which is used for the :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`.
    107. 

  107. 

  108. Method Descriptions
    109. 

  109. -------------------
    110. 

  110. 

  111. .. _class_VisualScriptCustomNode_method__get_caption:
    112. 

  112. 

  113. - :ref:`String<class_String>` **_get_caption** **(** **)** |virtual|
    114. 

  114. 

  115. Return the node's title.
    116. 

  116. 

  117. ----
    118. 

  118. 

  119. .. _class_VisualScriptCustomNode_method__get_category:
    120. 

  120. 

  121. - :ref:`String<class_String>` **_get_category** **(** **)** |virtual|
    122. 

  122. 

  123. Return the node's category.
    124. 

  124. 

  125. ----
    126. 

  126. 

  127. .. _class_VisualScriptCustomNode_method__get_input_value_port_count:
    128. 

  128. 

  129. - :ref:`int<class_int>` **_get_input_value_port_count** **(** **)** |virtual|
    130. 

  130. 

  131. Return the count of input value ports.
    132. 

  132. 

  133. ----
    134. 

  134. 

  135. .. _class_VisualScriptCustomNode_method__get_input_value_port_hint:
    136. 

  136. 

  137. - :ref:`int<class_int>` **_get_input_value_port_hint** **(** :ref:`int<class_int>` idx **)** |virtual|
    138. 

  138. 

  139. Return the specified input port's hint. See the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` hints.
    140. 

  140. 

  141. ----
    142. 

  142. 

  143. .. _class_VisualScriptCustomNode_method__get_input_value_port_hint_string:
    144. 

  144. 

  145. - :ref:`String<class_String>` **_get_input_value_port_hint_string** **(** :ref:`int<class_int>` idx **)** |virtual|
    146. 

  146. 

  147. Return the specified input port's hint string.
    148. 

  148. 

  149. ----
    150. 

  150. 

  151. .. _class_VisualScriptCustomNode_method__get_input_value_port_name:
    152. 

  152. 

  153. - :ref:`String<class_String>` **_get_input_value_port_name** **(** :ref:`int<class_int>` idx **)** |virtual|
    154. 

  154. 

  155. Return the specified input port's name.
    156. 

  156. 

  157. ----
    158. 

  158. 

  159. .. _class_VisualScriptCustomNode_method__get_input_value_port_type:
    160. 

  160. 

  161. - :ref:`int<class_int>` **_get_input_value_port_type** **(** :ref:`int<class_int>` idx **)** |virtual|
    162. 

  162. 

  163. Return the specified input port's type. See the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` values.
    164. 

  164. 

  165. ----
    166. 

  166. 

  167. .. _class_VisualScriptCustomNode_method__get_output_sequence_port_count:
    168. 

  168. 

  169. - :ref:`int<class_int>` **_get_output_sequence_port_count** **(** **)** |virtual|
    170. 

  170. 

  171. Return the amount of output **sequence** ports.
    172. 

  172. 

  173. ----
    174. 

  174. 

  175. .. _class_VisualScriptCustomNode_method__get_output_sequence_port_text:
    176. 

  176. 

  177. - :ref:`String<class_String>` **_get_output_sequence_port_text** **(** :ref:`int<class_int>` idx **)** |virtual|
    178. 

  178. 

  179. Return the specified **sequence** output's name.
    180. 

  180. 

  181. ----
    182. 

  182. 

  183. .. _class_VisualScriptCustomNode_method__get_output_value_port_count:
    184. 

  184. 

  185. - :ref:`int<class_int>` **_get_output_value_port_count** **(** **)** |virtual|
    186. 

  186. 

  187. Return the amount of output value ports.
    188. 

  188. 

  189. ----
    190. 

  190. 

  191. .. _class_VisualScriptCustomNode_method__get_output_value_port_hint:
    192. 

  192. 

  193. - :ref:`int<class_int>` **_get_output_value_port_hint** **(** :ref:`int<class_int>` idx **)** |virtual|
    194. 

  194. 

  195. Return the specified output port's hint. See the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` hints.
    196. 

  196. 

  197. ----
    198. 

  198. 

  199. .. _class_VisualScriptCustomNode_method__get_output_value_port_hint_string:
    200. 

  200. 

  201. - :ref:`String<class_String>` **_get_output_value_port_hint_string** **(** :ref:`int<class_int>` idx **)** |virtual|
    202. 

  202. 

  203. Return the specified output port's hint string.
    204. 

  204. 

  205. ----
    206. 

  206. 

  207. .. _class_VisualScriptCustomNode_method__get_output_value_port_name:
    208. 

  208. 

  209. - :ref:`String<class_String>` **_get_output_value_port_name** **(** :ref:`int<class_int>` idx **)** |virtual|
    210. 

  210. 

  211. Return the specified output port's name.
    212. 

  212. 

  213. ----
    214. 

  214. 

  215. .. _class_VisualScriptCustomNode_method__get_output_value_port_type:
    216. 

  216. 

  217. - :ref:`int<class_int>` **_get_output_value_port_type** **(** :ref:`int<class_int>` idx **)** |virtual|
    218. 

  218. 

  219. Return the specified output port's type. See the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` values.
    220. 

  220. 

  221. ----
    222. 

  222. 

  223. .. _class_VisualScriptCustomNode_method__get_text:
    224. 

  224. 

  225. - :ref:`String<class_String>` **_get_text** **(** **)** |virtual|
    226. 

  226. 

  227. Return the custom node's text, which is shown right next to the input **sequence** port (if there is none, on the place that is usually taken by it).
    228. 

  228. 

  229. ----
    230. 

  230. 

  231. .. _class_VisualScriptCustomNode_method__get_working_memory_size:
    232. 

  232. 

  233. - :ref:`int<class_int>` **_get_working_memory_size** **(** **)** |virtual|
    234. 

  234. 

  235. Return the size of the custom node's working memory. See :ref:`_step<class_VisualScriptCustomNode_method__step>` for more details.
    236. 

  236. 

  237. ----
    238. 

  238. 

  239. .. _class_VisualScriptCustomNode_method__has_input_sequence_port:
    240. 

  240. 

  241. - :ref:`bool<class_bool>` **_has_input_sequence_port** **(** **)** |virtual|
    242. 

  242. 

  243. Return whether the custom node has an input **sequence** port.
    244. 

  244. 

  245. ----
    246. 

  246. 

  247. .. _class_VisualScriptCustomNode_method__step:
    248. 

  248. 

  249. - :ref:`Variant<class_Variant>` **_step** **(** :ref:`Array<class_Array>` inputs, :ref:`Array<class_Array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_Array>` working_mem **)** |virtual|
    250. 

  250. 

  251. Execute the custom node's logic, returning the index of the output sequence port to use or a :ref:`String<class_String>` when there is an error.
    252. 

  252. 

  253. The ``inputs`` array contains the values of the input ports.
    254. 

  254. 

  255. ``outputs`` is an array whose indices should be set to the respective outputs.
    256. 

  256. 

  257. The ``start_mode`` is usually :ref:`START_MODE_BEGIN_SEQUENCE<class_VisualScriptCustomNode_constant_START_MODE_BEGIN_SEQUENCE>`, unless you have used the ``STEP_*`` constants.
    258. 

  258. 

  259. ``working_mem`` is an array which can be used to persist information between runs of the custom node. The size needs to be predefined using :ref:`_get_working_memory_size<class_VisualScriptCustomNode_method__get_working_memory_size>`.
    260. 

  260. 

  261. When returning, you can mask the returned value with one of the ``STEP_*`` constants.
    262. 

  262. 

  263. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    264. 

  264. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    265. 

  265. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    266. 

  266.