class_visualshadernodegroupbase.rst 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeGroupBase.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeGroupBase:
  6. VisualShaderNodeGroupBase
  7. =========================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`
  10. **Category:** Core
  11. Brief Description
  12. -----------------
  13. Methods
  14. -------
  15. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | 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 **)** |
  17. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | 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 **)** |
  19. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`clear_input_ports<class_VisualShaderNodeGroupBase_method_clear_input_ports>` **(** **)** |
  21. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`clear_output_ports<class_VisualShaderNodeGroupBase_method_clear_output_ports>` **(** **)** |
  23. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`Control<class_Control>` | :ref:`get_control<class_VisualShaderNodeGroupBase_method_get_control>` **(** :ref:`int<class_int>` index **)** |
  25. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`int<class_int>` | :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>` **(** **)** const |
  27. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`int<class_int>` | :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>` **(** **)** const |
  29. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`int<class_int>` | :ref:`get_input_port_count<class_VisualShaderNodeGroupBase_method_get_input_port_count>` **(** **)** const |
  31. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`String<class_String>` | :ref:`get_inputs<class_VisualShaderNodeGroupBase_method_get_inputs>` **(** **)** const |
  33. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`int<class_int>` | :ref:`get_output_port_count<class_VisualShaderNodeGroupBase_method_get_output_port_count>` **(** **)** const |
  35. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`String<class_String>` | :ref:`get_outputs<class_VisualShaderNodeGroupBase_method_get_outputs>` **(** **)** const |
  37. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_VisualShaderNodeGroupBase_method_get_size>` **(** **)** const |
  39. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`bool<class_bool>` | :ref:`has_input_port<class_VisualShaderNodeGroupBase_method_has_input_port>` **(** :ref:`int<class_int>` id **)** const |
  41. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`bool<class_bool>` | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>` **(** :ref:`int<class_int>` id **)** const |
  43. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`bool<class_bool>` | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>` **(** :ref:`String<class_String>` name **)** const |
  45. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | void | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>` **(** :ref:`int<class_int>` id **)** |
  47. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>` **(** :ref:`int<class_int>` id **)** |
  49. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_control<class_VisualShaderNodeGroupBase_method_set_control>` **(** :ref:`Control<class_Control>` control, :ref:`int<class_int>` index **)** |
  51. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`set_input_port_name<class_VisualShaderNodeGroupBase_method_set_input_port_name>` **(** :ref:`int<class_int>` arg0, :ref:`String<class_String>` arg1 **)** |
  53. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`set_input_port_type<class_VisualShaderNodeGroupBase_method_set_input_port_type>` **(** :ref:`int<class_int>` arg0, :ref:`int<class_int>` arg1 **)** |
  55. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`set_inputs<class_VisualShaderNodeGroupBase_method_set_inputs>` **(** :ref:`String<class_String>` inputs **)** |
  57. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | void | :ref:`set_output_port_name<class_VisualShaderNodeGroupBase_method_set_output_port_name>` **(** :ref:`int<class_int>` arg0, :ref:`String<class_String>` arg1 **)** |
  59. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | void | :ref:`set_output_port_type<class_VisualShaderNodeGroupBase_method_set_output_port_type>` **(** :ref:`int<class_int>` arg0, :ref:`int<class_int>` arg1 **)** |
  61. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | void | :ref:`set_outputs<class_VisualShaderNodeGroupBase_method_set_outputs>` **(** :ref:`String<class_String>` outputs **)** |
  63. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | void | :ref:`set_size<class_VisualShaderNodeGroupBase_method_set_size>` **(** :ref:`Vector2<class_Vector2>` size **)** |
  65. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. Method Descriptions
  67. -------------------
  68. .. _class_VisualShaderNodeGroupBase_method_add_input_port:
  69. - void **add_input_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
  70. .. _class_VisualShaderNodeGroupBase_method_add_output_port:
  71. - void **add_output_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
  72. .. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
  73. - void **clear_input_ports** **(** **)**
  74. .. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
  75. - void **clear_output_ports** **(** **)**
  76. .. _class_VisualShaderNodeGroupBase_method_get_control:
  77. - :ref:`Control<class_Control>` **get_control** **(** :ref:`int<class_int>` index **)**
  78. .. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id:
  79. - :ref:`int<class_int>` **get_free_input_port_id** **(** **)** const
  80. .. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
  81. - :ref:`int<class_int>` **get_free_output_port_id** **(** **)** const
  82. .. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
  83. - :ref:`int<class_int>` **get_input_port_count** **(** **)** const
  84. .. _class_VisualShaderNodeGroupBase_method_get_inputs:
  85. - :ref:`String<class_String>` **get_inputs** **(** **)** const
  86. .. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
  87. - :ref:`int<class_int>` **get_output_port_count** **(** **)** const
  88. .. _class_VisualShaderNodeGroupBase_method_get_outputs:
  89. - :ref:`String<class_String>` **get_outputs** **(** **)** const
  90. .. _class_VisualShaderNodeGroupBase_method_get_size:
  91. - :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const
  92. .. _class_VisualShaderNodeGroupBase_method_has_input_port:
  93. - :ref:`bool<class_bool>` **has_input_port** **(** :ref:`int<class_int>` id **)** const
  94. .. _class_VisualShaderNodeGroupBase_method_has_output_port:
  95. - :ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** const
  96. .. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
  97. - :ref:`bool<class_bool>` **is_valid_port_name** **(** :ref:`String<class_String>` name **)** const
  98. .. _class_VisualShaderNodeGroupBase_method_remove_input_port:
  99. - void **remove_input_port** **(** :ref:`int<class_int>` id **)**
  100. .. _class_VisualShaderNodeGroupBase_method_remove_output_port:
  101. - void **remove_output_port** **(** :ref:`int<class_int>` id **)**
  102. .. _class_VisualShaderNodeGroupBase_method_set_control:
  103. - void **set_control** **(** :ref:`Control<class_Control>` control, :ref:`int<class_int>` index **)**
  104. .. _class_VisualShaderNodeGroupBase_method_set_input_port_name:
  105. - void **set_input_port_name** **(** :ref:`int<class_int>` arg0, :ref:`String<class_String>` arg1 **)**
  106. .. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
  107. - void **set_input_port_type** **(** :ref:`int<class_int>` arg0, :ref:`int<class_int>` arg1 **)**
  108. .. _class_VisualShaderNodeGroupBase_method_set_inputs:
  109. - void **set_inputs** **(** :ref:`String<class_String>` inputs **)**
  110. .. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
  111. - void **set_output_port_name** **(** :ref:`int<class_int>` arg0, :ref:`String<class_String>` arg1 **)**
  112. .. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
  113. - void **set_output_port_type** **(** :ref:`int<class_int>` arg0, :ref:`int<class_int>` arg1 **)**
  114. .. _class_VisualShaderNodeGroupBase_method_set_outputs:
  115. - void **set_outputs** **(** :ref:`String<class_String>` outputs **)**
  116. .. _class_VisualShaderNodeGroupBase_method_set_size:
  117. - void **set_size** **(** :ref:`Vector2<class_Vector2>` size **)**