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_visualshadernodegroupbase.rst

class_visualshadernodegroupbase.rst 16 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245 
  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/doc/classes/VisualShaderNodeGroupBase.xml.
    7. 

  7. 

  8. .. _class_VisualShaderNodeGroupBase:
    9. 

  9. 

  10. VisualShaderNodeGroupBase
    11. 

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

  12. 

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

  14. 

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

  16. 

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

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

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

  23. 

  24. Methods
    25. 

  25. -------
    26. 

  26. 

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

  28. | 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 **)**   |
    29. 

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

  30. | 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 **)** |
    31. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  65. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

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

  67. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

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

  69. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. 

  71. Method Descriptions
    72. 

  72. -------------------
    73. 

  73. 

  74. .. _class_VisualShaderNodeGroupBase_method_add_input_port:
    75. 

  75. 

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

  77. 

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

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_VisualShaderNodeGroupBase_method_add_output_port:
    83. 

  83. 

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

  85. 

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

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
    91. 

  91. 

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

  93. 

  94. Removes all previously specified input ports.
    95. 

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
    99. 

  99. 

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

  101. 

  102. Removes all previously specified output ports.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:
    107. 

  107. 

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

  109. 

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

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
    115. 

  115. 

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

  117. 

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

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
    123. 

  123. 

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

  125. 

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

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_VisualShaderNodeGroupBase_method_get_inputs:
    131. 

  131. 

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

  133. 

  134. 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>`).
    135. 

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
    139. 

  139. 

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

  141. 

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

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_VisualShaderNodeGroupBase_method_get_outputs:
    147. 

  147. 

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

  149. 

  150. 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>`).
    151. 

  151. 

  152. ----
    153. 

  153. 

  154. .. _class_VisualShaderNodeGroupBase_method_has_input_port:
    155. 

  155. 

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

  157. 

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

  159. 

  160. ----
    161. 

  161. 

  162. .. _class_VisualShaderNodeGroupBase_method_has_output_port:
    163. 

  163. 

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

  165. 

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

  167. 

  168. ----
    169. 

  169. 

  170. .. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
    171. 

  171. 

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

  173. 

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

  175. 

  176. ----
    177. 

  177. 

  178. .. _class_VisualShaderNodeGroupBase_method_remove_input_port:
    179. 

  179. 

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

  181. 

  182. Removes the specified input port.
    183. 

  183. 

  184. ----
    185. 

  185. 

  186. .. _class_VisualShaderNodeGroupBase_method_remove_output_port:
    187. 

  187. 

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

  189. 

  190. Removes the specified output port.
    191. 

  191. 

  192. ----
    193. 

  193. 

  194. .. _class_VisualShaderNodeGroupBase_method_set_input_port_name:
    195. 

  195. 

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

  197. 

  198. Renames the specified input port.
    199. 

  199. 

  200. ----
    201. 

  201. 

  202. .. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
    203. 

  203. 

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

  205. 

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

  207. 

  208. ----
    209. 

  209. 

  210. .. _class_VisualShaderNodeGroupBase_method_set_inputs:
    211. 

  211. 

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

  213. 

  214. 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>`).
    215. 

  215. 

  216. ----
    217. 

  217. 

  218. .. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
    219. 

  219. 

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

  221. 

  222. Renames the specified output port.
    223. 

  223. 

  224. ----
    225. 

  225. 

  226. .. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
    227. 

  227. 

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

  229. 

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

  231. 

  232. ----
    233. 

  233. 

  234. .. _class_VisualShaderNodeGroupBase_method_set_outputs:
    235. 

  235. 

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

  237. 

  238. 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>`).
    239. 

  239. 

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

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

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

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

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

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