Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_visualscriptcustomnode.rst

class_visualscriptcustomnode.rst 19 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptCustomNode.xml.
    7. 

  7. 

  8. .. _class_VisualScriptCustomNode:
    9. 

  9. 

  10. VisualScriptCustomNode
    11. 

  11. ======================
    12. 

  12. 

  13. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A scripted Visual Script node.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

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

  21. 

  22. Methods
    23. 

  23. -------
    24. 

  24. 

  25. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

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

  27. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

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

  29. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

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

  31. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`         | :ref:`_get_input_value_port_hint<class_VisualScriptCustomNode_method__get_input_value_port_hint>` **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|                                                                    |
    33. 

  33. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`String<class_String>`   | :ref:`_get_input_value_port_hint_string<class_VisualScriptCustomNode_method__get_input_value_port_hint_string>` **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|                                                      |
    35. 

  35. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`String<class_String>`   | :ref:`_get_input_value_port_name<class_VisualScriptCustomNode_method__get_input_value_port_name>` **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|                                                                    |
    37. 

  37. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`int<class_int>`         | :ref:`_get_input_value_port_type<class_VisualScriptCustomNode_method__get_input_value_port_type>` **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|                                                                    |
    39. 

  39. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

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

  41. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`String<class_String>`   | :ref:`_get_output_sequence_port_text<class_VisualScriptCustomNode_method__get_output_sequence_port_text>` **(** :ref:`int<class_int>` seq_idx **)** |virtual| |const|                                                              |
    43. 

  43. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

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

  45. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`int<class_int>`         | :ref:`_get_output_value_port_hint<class_VisualScriptCustomNode_method__get_output_value_port_hint>` **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|                                                                 |
    47. 

  47. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`String<class_String>`   | :ref:`_get_output_value_port_hint_string<class_VisualScriptCustomNode_method__get_output_value_port_hint_string>` **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|                                                   |
    49. 

  49. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`String<class_String>`   | :ref:`_get_output_value_port_name<class_VisualScriptCustomNode_method__get_output_value_port_name>` **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|                                                                 |
    51. 

  51. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`int<class_int>`         | :ref:`_get_output_value_port_type<class_VisualScriptCustomNode_method__get_output_value_port_type>` **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|                                                                 |
    53. 

  53. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

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

  55. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

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

  57. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

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

  59. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :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| |const| |
    61. 

  61. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. 

  63. Enumerations
    64. 

  64. ------------
    65. 

  65. 

  66. .. _enum_VisualScriptCustomNode_StartMode:
    67. 

  67. 

  68. .. _class_VisualScriptCustomNode_constant_START_MODE_BEGIN_SEQUENCE:
    69. 

  69. 

  70. .. _class_VisualScriptCustomNode_constant_START_MODE_CONTINUE_SEQUENCE:
    71. 

  71. 

  72. .. _class_VisualScriptCustomNode_constant_START_MODE_RESUME_YIELD:
    73. 

  73. 

  74. enum **StartMode**:
    75. 

  75. 

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

  77. 

  78. - **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>`.
    79. 

  79. 

  80. - **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>`.
    81. 

  81. 

  82. Constants
    83. 

  83. ---------
    84. 

  84. 

  85. .. _class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT:
    86. 

  86. 

  87. .. _class_VisualScriptCustomNode_constant_STEP_GO_BACK_BIT:
    88. 

  88. 

  89. .. _class_VisualScriptCustomNode_constant_STEP_NO_ADVANCE_BIT:
    90. 

  90. 

  91. .. _class_VisualScriptCustomNode_constant_STEP_EXIT_FUNCTION_BIT:
    92. 

  92. 

  93. .. _class_VisualScriptCustomNode_constant_STEP_YIELD_BIT:
    94. 

  94. 

  95. - **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.
    96. 

  96. 

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

  98. 

  99. - **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.
    100. 

  100. 

  101. - **STEP_NO_ADVANCE_BIT** = **67108864**
    102. 

  102. 

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

  104. 

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

  106. 

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

  108. 

  109. Method Descriptions
    110. 

  110. -------------------
    111. 

  111. 

  112. .. _class_VisualScriptCustomNode_method__get_caption:
    113. 

  113. 

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

  115. 

  116. Returns the node's title.
    117. 

  117. 

  118. ----
    119. 

  119. 

  120. .. _class_VisualScriptCustomNode_method__get_category:
    121. 

  121. 

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

  123. 

  124. Returns the node's category.
    125. 

  125. 

  126. ----
    127. 

  127. 

  128. .. _class_VisualScriptCustomNode_method__get_input_value_port_count:
    129. 

  129. 

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

  131. 

  132. Returns the count of input value ports.
    133. 

  133. 

  134. ----
    135. 

  135. 

  136. .. _class_VisualScriptCustomNode_method__get_input_value_port_hint:
    137. 

  137. 

  138. - :ref:`int<class_int>` **_get_input_value_port_hint** **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|
    139. 

  139. 

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

  141. 

  142. ----
    143. 

  143. 

  144. .. _class_VisualScriptCustomNode_method__get_input_value_port_hint_string:
    145. 

  145. 

  146. - :ref:`String<class_String>` **_get_input_value_port_hint_string** **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|
    147. 

  147. 

  148. Returns the specified input port's hint string.
    149. 

  149. 

  150. ----
    151. 

  151. 

  152. .. _class_VisualScriptCustomNode_method__get_input_value_port_name:
    153. 

  153. 

  154. - :ref:`String<class_String>` **_get_input_value_port_name** **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|
    155. 

  155. 

  156. Returns the specified input port's name.
    157. 

  157. 

  158. ----
    159. 

  159. 

  160. .. _class_VisualScriptCustomNode_method__get_input_value_port_type:
    161. 

  161. 

  162. - :ref:`int<class_int>` **_get_input_value_port_type** **(** :ref:`int<class_int>` input_idx **)** |virtual| |const|
    163. 

  163. 

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

  165. 

  166. ----
    167. 

  167. 

  168. .. _class_VisualScriptCustomNode_method__get_output_sequence_port_count:
    169. 

  169. 

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

  171. 

  172. Returns the amount of output **sequence** ports.
    173. 

  173. 

  174. ----
    175. 

  175. 

  176. .. _class_VisualScriptCustomNode_method__get_output_sequence_port_text:
    177. 

  177. 

  178. - :ref:`String<class_String>` **_get_output_sequence_port_text** **(** :ref:`int<class_int>` seq_idx **)** |virtual| |const|
    179. 

  179. 

  180. Returns the specified **sequence** output's name.
    181. 

  181. 

  182. ----
    183. 

  183. 

  184. .. _class_VisualScriptCustomNode_method__get_output_value_port_count:
    185. 

  185. 

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

  187. 

  188. Returns the amount of output value ports.
    189. 

  189. 

  190. ----
    191. 

  191. 

  192. .. _class_VisualScriptCustomNode_method__get_output_value_port_hint:
    193. 

  193. 

  194. - :ref:`int<class_int>` **_get_output_value_port_hint** **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|
    195. 

  195. 

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

  197. 

  198. ----
    199. 

  199. 

  200. .. _class_VisualScriptCustomNode_method__get_output_value_port_hint_string:
    201. 

  201. 

  202. - :ref:`String<class_String>` **_get_output_value_port_hint_string** **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|
    203. 

  203. 

  204. Returns the specified output port's hint string.
    205. 

  205. 

  206. ----
    207. 

  207. 

  208. .. _class_VisualScriptCustomNode_method__get_output_value_port_name:
    209. 

  209. 

  210. - :ref:`String<class_String>` **_get_output_value_port_name** **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|
    211. 

  211. 

  212. Returns the specified output port's name.
    213. 

  213. 

  214. ----
    215. 

  215. 

  216. .. _class_VisualScriptCustomNode_method__get_output_value_port_type:
    217. 

  217. 

  218. - :ref:`int<class_int>` **_get_output_value_port_type** **(** :ref:`int<class_int>` output_idx **)** |virtual| |const|
    219. 

  219. 

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

  221. 

  222. ----
    223. 

  223. 

  224. .. _class_VisualScriptCustomNode_method__get_text:
    225. 

  225. 

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

  227. 

  228. Returns 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).
    229. 

  229. 

  230. ----
    231. 

  231. 

  232. .. _class_VisualScriptCustomNode_method__get_working_memory_size:
    233. 

  233. 

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

  235. 

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

  237. 

  238. ----
    239. 

  239. 

  240. .. _class_VisualScriptCustomNode_method__has_input_sequence_port:
    241. 

  241. 

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

  243. 

  244. Returns whether the custom node has an input **sequence** port.
    245. 

  245. 

  246. ----
    247. 

  247. 

  248. .. _class_VisualScriptCustomNode_method__step:
    249. 

  249. 

  250. - :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| |const|
    251. 

  251. 

  252. 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.
    253. 

  253. 

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

  255. 

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

  257. 

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

  259. 

  260. \ ``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>`.
    261. 

  261. 

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

  263. 

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

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

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

  267. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    268. 

  268. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    269. 

  269. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    270.