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: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_visualshadernodegroupbase.rst

class_visualshadernodegroupbase.rst 16 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244 
  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 VisualShaderNodeGroupBase.xml source instead.
    5. 

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

  6. 

  7. .. _class_VisualShaderNodeGroupBase:
    8. 

  8. 

  9. VisualShaderNodeGroupBase
    10. 

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

  11. 

  12. **Inherits:** :ref:`VisualShaderNodeResizableBase<class_VisualShaderNodeResizableBase>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`
    15. 

  15. 

  16. Base class for a family of nodes with variable amount of input and output ports within the visual shader graph.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. Currently, has no direct usage, use the derived classes instead.
    22. 

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

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

  27. | void                        | :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**   |
    28. 

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

  29. | void                        | :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)** |
    30. 

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

  31. | void                        | :ref:`clear_input_ports<class_VisualShaderNodeGroupBase_method_clear_input_ports>` **(** **)**                                                                                    |
    32. 

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

  33. | void                        | :ref:`clear_output_ports<class_VisualShaderNodeGroupBase_method_clear_output_ports>` **(** **)**                                                                                  |
    34. 

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

  35. | :ref:`int<class_int>`       | :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>` **(** **)** |const|                                                                  |
    36. 

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

  37. | :ref:`int<class_int>`       | :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>` **(** **)** |const|                                                                |
    38. 

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

  39. | :ref:`int<class_int>`       | :ref:`get_input_port_count<class_VisualShaderNodeGroupBase_method_get_input_port_count>` **(** **)** |const|                                                                      |
    40. 

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

  41. | :ref:`String<class_String>` | :ref:`get_inputs<class_VisualShaderNodeGroupBase_method_get_inputs>` **(** **)** |const|                                                                                          |
    42. 

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

  43. | :ref:`int<class_int>`       | :ref:`get_output_port_count<class_VisualShaderNodeGroupBase_method_get_output_port_count>` **(** **)** |const|                                                                    |
    44. 

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

  45. | :ref:`String<class_String>` | :ref:`get_outputs<class_VisualShaderNodeGroupBase_method_get_outputs>` **(** **)** |const|                                                                                        |
    46. 

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

  47. | :ref:`bool<class_bool>`     | :ref:`has_input_port<class_VisualShaderNodeGroupBase_method_has_input_port>` **(** :ref:`int<class_int>` id **)** |const|                                                         |
    48. 

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

  49. | :ref:`bool<class_bool>`     | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>` **(** :ref:`int<class_int>` id **)** |const|                                                       |
    50. 

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

  51. | :ref:`bool<class_bool>`     | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>` **(** :ref:`String<class_String>` name **)** |const|                                         |
    52. 

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

  53. | void                        | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>` **(** :ref:`int<class_int>` id **)**                                                           |
    54. 

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

  55. | void                        | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>` **(** :ref:`int<class_int>` id **)**                                                         |
    56. 

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

  57. | void                        | :ref:`set_input_port_name<class_VisualShaderNodeGroupBase_method_set_input_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                     |
    58. 

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

  59. | void                        | :ref:`set_input_port_type<class_VisualShaderNodeGroupBase_method_set_input_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                           |
    60. 

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

  61. | void                        | :ref:`set_inputs<class_VisualShaderNodeGroupBase_method_set_inputs>` **(** :ref:`String<class_String>` inputs **)**                                                               |
    62. 

  62. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63. | void                        | :ref:`set_output_port_name<class_VisualShaderNodeGroupBase_method_set_output_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                   |
    64. 

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

  65. | void                        | :ref:`set_output_port_type<class_VisualShaderNodeGroupBase_method_set_output_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                         |
    66. 

  66. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67. | void                        | :ref:`set_outputs<class_VisualShaderNodeGroupBase_method_set_outputs>` **(** :ref:`String<class_String>` outputs **)**                                                            |
    68. 

  68. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69. 

  70. Method Descriptions
    71. 

  71. -------------------
    72. 

  72. 

  73. .. _class_VisualShaderNodeGroupBase_method_add_input_port:
    74. 

  74. 

  75. - void **add_input_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
    76. 

  76. 

  77. Adds an input port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.
    78. 

  78. 

  79. ----
    80. 

  80. 

  81. .. _class_VisualShaderNodeGroupBase_method_add_output_port:
    82. 

  82. 

  83. - void **add_output_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
    84. 

  84. 

  85. Adds an output port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.
    86. 

  86. 

  87. ----
    88. 

  88. 

  89. .. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
    90. 

  90. 

  91. - void **clear_input_ports** **(** **)**
    92. 

  92. 

  93. Removes all previously specified input ports.
    94. 

  94. 

  95. ----
    96. 

  96. 

  97. .. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
    98. 

  98. 

  99. - void **clear_output_ports** **(** **)**
    100. 

  100. 

  101. Removes all previously specified output ports.
    102. 

  102. 

  103. ----
    104. 

  104. 

  105. .. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:
    106. 

  106. 

  107. - :ref:`int<class_int>` **get_free_input_port_id** **(** **)** |const|
    108. 

  108. 

  109. Returns a free input port ID which can be used in :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`.
    110. 

  110. 

  111. ----
    112. 

  112. 

  113. .. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
    114. 

  114. 

  115. - :ref:`int<class_int>` **get_free_output_port_id** **(** **)** |const|
    116. 

  116. 

  117. Returns a free output port ID which can be used in :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`.
    118. 

  118. 

  119. ----
    120. 

  120. 

  121. .. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
    122. 

  122. 

  123. - :ref:`int<class_int>` **get_input_port_count** **(** **)** |const|
    124. 

  124. 

  125. Returns the number of input ports in use. Alternative for :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>`.
    126. 

  126. 

  127. ----
    128. 

  128. 

  129. .. _class_VisualShaderNodeGroupBase_method_get_inputs:
    130. 

  130. 

  131. - :ref:`String<class_String>` **get_inputs** **(** **)** |const|
    132. 

  132. 

  133. Returns a :ref:`String<class_String>` description of the input ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`).
    134. 

  134. 

  135. ----
    136. 

  136. 

  137. .. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
    138. 

  138. 

  139. - :ref:`int<class_int>` **get_output_port_count** **(** **)** |const|
    140. 

  140. 

  141. Returns the number of output ports in use. Alternative for :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>`.
    142. 

  142. 

  143. ----
    144. 

  144. 

  145. .. _class_VisualShaderNodeGroupBase_method_get_outputs:
    146. 

  146. 

  147. - :ref:`String<class_String>` **get_outputs** **(** **)** |const|
    148. 

  148. 

  149. Returns a :ref:`String<class_String>` description of the output ports as a colon-separated list using the format ``id,type,name;`` (see :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`).
    150. 

  150. 

  151. ----
    152. 

  152. 

  153. .. _class_VisualShaderNodeGroupBase_method_has_input_port:
    154. 

  154. 

  155. - :ref:`bool<class_bool>` **has_input_port** **(** :ref:`int<class_int>` id **)** |const|
    156. 

  156. 

  157. Returns ``true`` if the specified input port exists.
    158. 

  158. 

  159. ----
    160. 

  160. 

  161. .. _class_VisualShaderNodeGroupBase_method_has_output_port:
    162. 

  162. 

  163. - :ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** |const|
    164. 

  164. 

  165. Returns ``true`` if the specified output port exists.
    166. 

  166. 

  167. ----
    168. 

  168. 

  169. .. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
    170. 

  170. 

  171. - :ref:`bool<class_bool>` **is_valid_port_name** **(** :ref:`String<class_String>` name **)** |const|
    172. 

  172. 

  173. Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader.
    174. 

  174. 

  175. ----
    176. 

  176. 

  177. .. _class_VisualShaderNodeGroupBase_method_remove_input_port:
    178. 

  178. 

  179. - void **remove_input_port** **(** :ref:`int<class_int>` id **)**
    180. 

  180. 

  181. Removes the specified input port.
    182. 

  182. 

  183. ----
    184. 

  184. 

  185. .. _class_VisualShaderNodeGroupBase_method_remove_output_port:
    186. 

  186. 

  187. - void **remove_output_port** **(** :ref:`int<class_int>` id **)**
    188. 

  188. 

  189. Removes the specified output port.
    190. 

  190. 

  191. ----
    192. 

  192. 

  193. .. _class_VisualShaderNodeGroupBase_method_set_input_port_name:
    194. 

  194. 

  195. - void **set_input_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
    196. 

  196. 

  197. Renames the specified input port.
    198. 

  198. 

  199. ----
    200. 

  200. 

  201. .. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
    202. 

  202. 

  203. - void **set_input_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**
    204. 

  204. 

  205. Sets the specified input port's type (see :ref:`PortType<enum_VisualShaderNode_PortType>`).
    206. 

  206. 

  207. ----
    208. 

  208. 

  209. .. _class_VisualShaderNodeGroupBase_method_set_inputs:
    210. 

  210. 

  211. - void **set_inputs** **(** :ref:`String<class_String>` inputs **)**
    212. 

  212. 

  213. Defines all input ports using a :ref:`String<class_String>` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`).
    214. 

  214. 

  215. ----
    216. 

  216. 

  217. .. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
    218. 

  218. 

  219. - void **set_output_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
    220. 

  220. 

  221. Renames the specified output port.
    222. 

  222. 

  223. ----
    224. 

  224. 

  225. .. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
    226. 

  226. 

  227. - void **set_output_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**
    228. 

  228. 

  229. Sets the specified output port's type (see :ref:`PortType<enum_VisualShaderNode_PortType>`).
    230. 

  230. 

  231. ----
    232. 

  232. 

  233. .. _class_VisualShaderNodeGroupBase_method_set_outputs:
    234. 

  234. 

  235. - void **set_outputs** **(** :ref:`String<class_String>` outputs **)**
    236. 

  236. 

  237. Defines all output ports using a :ref:`String<class_String>` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`).
    238. 

  238. 

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

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

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

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

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

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