Browse Source

Sync classref with current source

Rémi Verschelde 5 years ago
parent
commit
9093bf0483

+ 1 - 1
classes/class_graphnode.rst

@@ -16,7 +16,7 @@ A GraphNode is a container with potentially several input and output slots allow
 Description
 Description
 -----------
 -----------
 
 
-A GraphNode is a container. Each GraphNode can have several input and output slots, sometimes refered to as ports, allowing connections between GraphNodes. To add a slot to GraphNode, add any :ref:`Control<class_Control>`-derived child node to it.
+A GraphNode is a container. Each GraphNode can have several input and output slots, sometimes referred to as ports, allowing connections between GraphNodes. To add a slot to GraphNode, add any :ref:`Control<class_Control>`-derived child node to it.
 
 
 After adding at least one child to GraphNode new sections will be automatically created in the Inspector called 'Slot'. When 'Slot' is expanded you will see list with index number for each slot. You can click on each of them to expand further.
 After adding at least one child to GraphNode new sections will be automatically created in the Inspector called 'Slot'. When 'Slot' is expanded you will see list with index number for each slot. You can click on each of them to expand further.
 
 

+ 2 - 0
classes/class_line2d.rst

@@ -18,6 +18,8 @@ Description
 
 
 A line through several points in 2D space.
 A line through several points in 2D space.
 
 
+**Note:** By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb<class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_buffer_size_kb>` and :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb<class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb>`.
+
 Properties
 Properties
 ----------
 ----------
 
 

+ 2 - 0
classes/class_polygon2d.rst

@@ -18,6 +18,8 @@ Description
 
 
 A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture.
 A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture.
 
 
+**Note:** By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb<class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_buffer_size_kb>` and :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb<class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb>`.
+
 Properties
 Properties
 ----------
 ----------
 
 

+ 1 - 1
classes/class_spatialmaterial.rst

@@ -2212,7 +2212,7 @@ Method Descriptions
 
 
 - :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_SpatialMaterial_Feature>` feature **)** const
 - :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_SpatialMaterial_Feature>` feature **)** const
 
 
-Returns ``true``, if the specifed :ref:`Feature<enum_SpatialMaterial_Feature>` is enabled.
+Returns ``true``, if the specified :ref:`Feature<enum_SpatialMaterial_Feature>` is enabled.
 
 
 ----
 ----
 
 

+ 4 - 0
classes/class_tileset.rst

@@ -192,6 +192,8 @@ enum **BitmaskMode**:
 
 
 .. _class_TileSet_constant_BIND_LEFT:
 .. _class_TileSet_constant_BIND_LEFT:
 
 
+.. _class_TileSet_constant_BIND_CENTER:
+
 .. _class_TileSet_constant_BIND_RIGHT:
 .. _class_TileSet_constant_BIND_RIGHT:
 
 
 .. _class_TileSet_constant_BIND_BOTTOMLEFT:
 .. _class_TileSet_constant_BIND_BOTTOMLEFT:
@@ -210,6 +212,8 @@ enum **AutotileBindings**:
 
 
 - **BIND_LEFT** = **8**
 - **BIND_LEFT** = **8**
 
 
+- **BIND_CENTER** = **16**
+
 - **BIND_RIGHT** = **32**
 - **BIND_RIGHT** = **32**
 
 
 - **BIND_BOTTOMLEFT** = **64**
 - **BIND_BOTTOMLEFT** = **64**

+ 1 - 1
classes/class_viewport.rst

@@ -556,7 +556,7 @@ If ``true``, the result after 3D rendering will not have a linear to sRGB color
 | *Getter*  | get_msaa()      |
 | *Getter*  | get_msaa()      |
 +-----------+-----------------+
 +-----------+-----------------+
 
 
-The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targetting very high-end systems.
+The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems.
 
 
 ----
 ----
 
 

+ 5 - 0
classes/class_visualshadernode.rst

@@ -15,6 +15,11 @@ VisualShaderNode
 
 
 
 
 
 
+Tutorials
+---------
+
+- :doc:`../tutorials/shading/visual_shaders`
+
 Properties
 Properties
 ----------
 ----------
 
 

+ 16 - 5
classes/class_visualshadernodecubemap.rst

@@ -11,7 +11,12 @@ VisualShaderNodeCubeMap
 
 
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+A :ref:`CubeMap<class_CubeMap>` sampling node to be used within the visual shader graph.
 
 
+Description
+-----------
+
+Translated to ``texture(cubemap, vec3)`` in the shader language. Returns a color vector and alpha channel as scalar.
 
 
 Properties
 Properties
 ----------
 ----------
@@ -35,9 +40,9 @@ Enumerations
 
 
 enum **Source**:
 enum **Source**:
 
 
-- **SOURCE_TEXTURE** = **0**
+- **SOURCE_TEXTURE** = **0** --- Use the :ref:`CubeMap<class_CubeMap>` set via :ref:`cube_map<class_VisualShaderNodeCubeMap_property_cube_map>`. If this is set to :ref:`source<class_VisualShaderNodeCubeMap_property_source>`, the ``samplerCube`` port is ignored.
 
 
-- **SOURCE_PORT** = **1**
+- **SOURCE_PORT** = **1** --- Use the :ref:`CubeMap<class_CubeMap>` sampler reference passed via the ``samplerCube`` port. If this is set to :ref:`source<class_VisualShaderNodeCubeMap_property_source>`, the :ref:`cube_map<class_VisualShaderNodeCubeMap_property_cube_map>` texture is ignored.
 
 
 ----
 ----
 
 
@@ -51,11 +56,11 @@ enum **Source**:
 
 
 enum **TextureType**:
 enum **TextureType**:
 
 
-- **TYPE_DATA** = **0**
+- **TYPE_DATA** = **0** --- No hints are added to the uniform declaration.
 
 
-- **TYPE_COLOR** = **1**
+- **TYPE_COLOR** = **1** --- Adds ``hint_albedo`` as hint to the uniform declaration for proper sRGB to linear conversion.
 
 
-- **TYPE_NORMALMAP** = **2**
+- **TYPE_NORMALMAP** = **2** --- Adds ``hint_normal`` as hint to the uniform declaration, which internally converts the texture for proper usage as normal map.
 
 
 Property Descriptions
 Property Descriptions
 ---------------------
 ---------------------
@@ -70,6 +75,8 @@ Property Descriptions
 | *Getter* | get_cube_map()      |
 | *Getter* | get_cube_map()      |
 +----------+---------------------+
 +----------+---------------------+
 
 
+The :ref:`CubeMap<class_CubeMap>` texture to sample when using :ref:`SOURCE_TEXTURE<class_VisualShaderNodeCubeMap_constant_SOURCE_TEXTURE>` as :ref:`source<class_VisualShaderNodeCubeMap_property_source>`.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeCubeMap_property_source:
 .. _class_VisualShaderNodeCubeMap_property_source:
@@ -84,6 +91,8 @@ Property Descriptions
 | *Getter*  | get_source()      |
 | *Getter*  | get_source()      |
 +-----------+-------------------+
 +-----------+-------------------+
 
 
+Defines which source should be used for the sampling. See :ref:`Source<enum_VisualShaderNodeCubeMap_Source>` for options.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeCubeMap_property_texture_type:
 .. _class_VisualShaderNodeCubeMap_property_texture_type:
@@ -98,3 +107,5 @@ Property Descriptions
 | *Getter*  | get_texture_type()      |
 | *Getter*  | get_texture_type()      |
 +-----------+-------------------------+
 +-----------+-------------------------+
 
 
+Defines the type of data provided by the source texture. See :ref:`TextureType<enum_VisualShaderNodeCubeMap_TextureType>` for options.
+

+ 5 - 0
classes/class_visualshadernodecubemapuniform.rst

@@ -11,5 +11,10 @@ VisualShaderNodeCubeMapUniform
 
 
 **Inherits:** :ref:`VisualShaderNodeTextureUniform<class_VisualShaderNodeTextureUniform>` **<** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNodeTextureUniform<class_VisualShaderNodeTextureUniform>` **<** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+A :ref:`CubeMap<class_CubeMap>` uniform node to be used within the visual shader graph.
 
 
+Description
+-----------
+
+Translated to ``uniform samplerCube`` in the shader language. The output value can be used as port for :ref:`VisualShaderNodeCubeMap<class_VisualShaderNodeCubeMap>`.
 
 

+ 5 - 0
classes/class_visualshadernodedeterminant.rst

@@ -11,5 +11,10 @@ VisualShaderNodeDeterminant
 
 
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+Calculates the determinant of a :ref:`Transform<class_Transform>` within the visual shader graph.
 
 
+Description
+-----------
+
+Translates to ``deteminant(x)`` in the shader language.
 
 

+ 5 - 0
classes/class_visualshadernodedotproduct.rst

@@ -11,5 +11,10 @@ VisualShaderNodeDotProduct
 
 
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+Calculates a dot product of two vectors within the visual shader graph.
 
 
+Description
+-----------
+
+Translates to ``dot(a, b)`` in the shader language.
 
 

+ 11 - 18
classes/class_visualshadernodeexpression.rst

@@ -13,23 +13,21 @@ VisualShaderNodeExpression
 
 
 **Inherited By:** :ref:`VisualShaderNodeGlobalExpression<class_VisualShaderNodeGlobalExpression>`
 **Inherited By:** :ref:`VisualShaderNodeGlobalExpression<class_VisualShaderNodeGlobalExpression>`
 
 
+A custom visual shader graph expression written in Godot Shading Language.
 
 
+Description
+-----------
 
 
-Properties
-----------
+Custom Godot Shading Language expression, with a custom amount of input and output ports.
 
 
-+-----------------------------+-------------------------------------------------------------------------+-----------------+
-| :ref:`bool<class_bool>`     | editable                                                                | **O:** ``true`` |
-+-----------------------------+-------------------------------------------------------------------------+-----------------+
-| :ref:`String<class_String>` | :ref:`expression<class_VisualShaderNodeExpression_property_expression>` | ``""``          |
-+-----------------------------+-------------------------------------------------------------------------+-----------------+
+The provided code is directly injected into the graph's matching shader function (``vertex``, ``fragment``, or ``light``), so it cannot be used to to declare functions, varyings, uniforms, or global constants. See :ref:`VisualShaderNodeGlobalExpression<class_VisualShaderNodeGlobalExpression>` for such global definitions.
 
 
-Methods
--------
+Properties
+----------
 
 
-+------+-------------------------------------------------------------------------+
-| void | :ref:`build<class_VisualShaderNodeExpression_method_build>` **(** **)** |
-+------+-------------------------------------------------------------------------+
++-----------------------------+-------------------------------------------------------------------------+--------+
+| :ref:`String<class_String>` | :ref:`expression<class_VisualShaderNodeExpression_property_expression>` | ``""`` |
++-----------------------------+-------------------------------------------------------------------------+--------+
 
 
 Property Descriptions
 Property Descriptions
 ---------------------
 ---------------------
@@ -46,10 +44,5 @@ Property Descriptions
 | *Getter*  | get_expression()      |
 | *Getter*  | get_expression()      |
 +-----------+-----------------------+
 +-----------+-----------------------+
 
 
-Method Descriptions
--------------------
-
-.. _class_VisualShaderNodeExpression_method_build:
-
-- void **build** **(** **)**
+An expression in Godot Shading Language, which will be injected at the start of the graph's matching shader function (``vertex``, ``fragment``, or ``light``), and thus cannot be used to declare functions, varyings, uniforms, or global constants.
 
 

+ 5 - 0
classes/class_visualshadernodefaceforward.rst

@@ -11,5 +11,10 @@ VisualShaderNodeFaceForward
 
 
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+Returns the vector that points in the same direction as a reference vector within the visual shader graph.
 
 
+Description
+-----------
+
+Translates to ``faceforward(N, I, Nref)`` in the shader language. The function has three vector parameters: ``N``, the vector to orient, ``I``, the incident vector, and ``Nref``, the reference vector. If the dot product of ``I`` and ``Nref`` is smaller than zero the return value is ``N``. Otherwise ``-N`` is returned.
 
 

+ 5 - 0
classes/class_visualshadernodefresnel.rst

@@ -11,5 +11,10 @@ VisualShaderNodeFresnel
 
 
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+A Fresnel effect to be used within the visual shader graph.
 
 
+Description
+-----------
+
+Returns falloff based on the dot product of surface normal and view direction of camera (pass associated inputs to it).
 
 

+ 4 - 6
classes/class_visualshadernodeglobalexpression.rst

@@ -11,12 +11,10 @@ VisualShaderNodeGlobalExpression
 
 
 **Inherits:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>` **<** :ref:`VisualShaderNodeGroupBase<class_VisualShaderNodeGroupBase>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>` **<** :ref:`VisualShaderNodeGroupBase<class_VisualShaderNodeGroupBase>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+A custom global visual shader graph expression written in Godot Shading Language.
 
 
+Description
+-----------
 
 
-Properties
-----------
-
-+-------------------------+----------+------------------+
-| :ref:`bool<class_bool>` | editable | **O:** ``false`` |
-+-------------------------+----------+------------------+
+Custom Godot Shader Language expression, which is placed on top of the generated shader. You can place various function definitions inside to call later in :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`\ s (which are injected in the main shader functions). You can also declare varyings, uniforms and global constants.
 
 

+ 96 - 79
classes/class_visualshadernodegroupbase.rst

@@ -13,85 +13,84 @@ VisualShaderNodeGroupBase
 
 
 **Inherited By:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`
 **Inherited By:** :ref:`VisualShaderNodeExpression<class_VisualShaderNodeExpression>`
 
 
+Base class for a family of nodes with variable amount of input and output ports within the visual shader graph.
 
 
+Description
+-----------
+
+Currently, has no direct usage, use the derived classes instead.
 
 
 Properties
 Properties
 ----------
 ----------
 
 
-+-------------------------+--------------------------------------------------------------------+-----------+
-| :ref:`bool<class_bool>` | :ref:`editable<class_VisualShaderNodeGroupBase_property_editable>` | ``false`` |
-+-------------------------+--------------------------------------------------------------------+-----------+
++-------------------------------+------------------------------------------------------------+---------------------+
+| :ref:`Vector2<class_Vector2>` | :ref:`size<class_VisualShaderNodeGroupBase_property_size>` | ``Vector2( 0, 0 )`` |
++-------------------------------+------------------------------------------------------------+---------------------+
 
 
 Methods
 Methods
 -------
 -------
 
 
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 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 **)**   |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 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 **)** |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`clear_input_ports<class_VisualShaderNodeGroupBase_method_clear_input_ports>` **(** **)**                                                                                    |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`clear_output_ports<class_VisualShaderNodeGroupBase_method_clear_output_ports>` **(** **)**                                                                                  |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Control<class_Control>` | :ref:`get_control<class_VisualShaderNodeGroupBase_method_get_control>` **(** :ref:`int<class_int>` index **)**                                                                    |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`         | :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>` **(** **)** const                                                                    |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`         | :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>` **(** **)** const                                                                  |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`         | :ref:`get_input_port_count<class_VisualShaderNodeGroupBase_method_get_input_port_count>` **(** **)** const                                                                        |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`String<class_String>`   | :ref:`get_inputs<class_VisualShaderNodeGroupBase_method_get_inputs>` **(** **)** const                                                                                            |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`         | :ref:`get_output_port_count<class_VisualShaderNodeGroupBase_method_get_output_port_count>` **(** **)** const                                                                      |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`String<class_String>`   | :ref:`get_outputs<class_VisualShaderNodeGroupBase_method_get_outputs>` **(** **)** const                                                                                          |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_VisualShaderNodeGroupBase_method_get_size>` **(** **)** const                                                                                                |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`bool<class_bool>`       | :ref:`has_input_port<class_VisualShaderNodeGroupBase_method_has_input_port>` **(** :ref:`int<class_int>` id **)** const                                                           |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`bool<class_bool>`       | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>` **(** :ref:`int<class_int>` id **)** const                                                         |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`bool<class_bool>`       | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>` **(** :ref:`String<class_String>` name **)** const                                           |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>` **(** :ref:`int<class_int>` id **)**                                                           |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>` **(** :ref:`int<class_int>` id **)**                                                         |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_control<class_VisualShaderNodeGroupBase_method_set_control>` **(** :ref:`Control<class_Control>` control, :ref:`int<class_int>` index **)**                             |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_input_port_name<class_VisualShaderNodeGroupBase_method_set_input_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                     |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_input_port_type<class_VisualShaderNodeGroupBase_method_set_input_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                           |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_inputs<class_VisualShaderNodeGroupBase_method_set_inputs>` **(** :ref:`String<class_String>` inputs **)**                                                               |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_output_port_name<class_VisualShaderNodeGroupBase_method_set_output_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                   |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_output_port_type<class_VisualShaderNodeGroupBase_method_set_output_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                         |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_outputs<class_VisualShaderNodeGroupBase_method_set_outputs>` **(** :ref:`String<class_String>` outputs **)**                                                            |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                          | :ref:`set_size<class_VisualShaderNodeGroupBase_method_set_size>` **(** :ref:`Vector2<class_Vector2>` size **)**                                                                   |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 **)**   |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 **)** |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`clear_input_ports<class_VisualShaderNodeGroupBase_method_clear_input_ports>` **(** **)**                                                                                    |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`clear_output_ports<class_VisualShaderNodeGroupBase_method_clear_output_ports>` **(** **)**                                                                                  |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`       | :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>` **(** **)** const                                                                    |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`       | :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>` **(** **)** const                                                                  |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`       | :ref:`get_input_port_count<class_VisualShaderNodeGroupBase_method_get_input_port_count>` **(** **)** const                                                                        |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`String<class_String>` | :ref:`get_inputs<class_VisualShaderNodeGroupBase_method_get_inputs>` **(** **)** const                                                                                            |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`       | :ref:`get_output_port_count<class_VisualShaderNodeGroupBase_method_get_output_port_count>` **(** **)** const                                                                      |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`String<class_String>` | :ref:`get_outputs<class_VisualShaderNodeGroupBase_method_get_outputs>` **(** **)** const                                                                                          |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`bool<class_bool>`     | :ref:`has_input_port<class_VisualShaderNodeGroupBase_method_has_input_port>` **(** :ref:`int<class_int>` id **)** const                                                           |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`bool<class_bool>`     | :ref:`has_output_port<class_VisualShaderNodeGroupBase_method_has_output_port>` **(** :ref:`int<class_int>` id **)** const                                                         |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`bool<class_bool>`     | :ref:`is_valid_port_name<class_VisualShaderNodeGroupBase_method_is_valid_port_name>` **(** :ref:`String<class_String>` name **)** const                                           |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`remove_input_port<class_VisualShaderNodeGroupBase_method_remove_input_port>` **(** :ref:`int<class_int>` id **)**                                                           |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`remove_output_port<class_VisualShaderNodeGroupBase_method_remove_output_port>` **(** :ref:`int<class_int>` id **)**                                                         |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_input_port_name<class_VisualShaderNodeGroupBase_method_set_input_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                     |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_input_port_type<class_VisualShaderNodeGroupBase_method_set_input_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                           |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_inputs<class_VisualShaderNodeGroupBase_method_set_inputs>` **(** :ref:`String<class_String>` inputs **)**                                                               |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_output_port_name<class_VisualShaderNodeGroupBase_method_set_output_port_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                   |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_output_port_type<class_VisualShaderNodeGroupBase_method_set_output_port_type>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**                         |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_outputs<class_VisualShaderNodeGroupBase_method_set_outputs>` **(** :ref:`String<class_String>` outputs **)**                                                            |
++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 
 Property Descriptions
 Property Descriptions
 ---------------------
 ---------------------
 
 
-.. _class_VisualShaderNodeGroupBase_property_editable:
+.. _class_VisualShaderNodeGroupBase_property_size:
 
 
-- :ref:`bool<class_bool>` **editable**
+- :ref:`Vector2<class_Vector2>` **size**
 
 
 +-----------+---------------------+
 +-----------+---------------------+
-| *Default* | ``false``           |
+| *Default* | ``Vector2( 0, 0 )`` |
 +-----------+---------------------+
 +-----------+---------------------+
-| *Setter*  | set_editable(value) |
+| *Setter*  | set_size(value)     |
 +-----------+---------------------+
 +-----------+---------------------+
-| *Getter*  | is_editable()       |
+| *Getter*  | get_size()          |
 +-----------+---------------------+
 +-----------+---------------------+
 
 
+The size of the node in the visual shader graph.
+
 Method Descriptions
 Method Descriptions
 -------------------
 -------------------
 
 
@@ -99,29 +98,31 @@ Method Descriptions
 
 
 - void **add_input_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
 - void **add_input_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
 
 
+Adds an input port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_add_output_port:
 .. _class_VisualShaderNodeGroupBase_method_add_output_port:
 
 
 - void **add_output_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
 - void **add_output_port** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type, :ref:`String<class_String>` name **)**
 
 
+Adds an output port with the specified ``type`` (see :ref:`PortType<enum_VisualShaderNode_PortType>`) and ``name``.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
 .. _class_VisualShaderNodeGroupBase_method_clear_input_ports:
 
 
 - void **clear_input_ports** **(** **)**
 - void **clear_input_ports** **(** **)**
 
 
+Removes all previously specified input ports.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
 .. _class_VisualShaderNodeGroupBase_method_clear_output_ports:
 
 
 - void **clear_output_ports** **(** **)**
 - void **clear_output_ports** **(** **)**
 
 
-----
-
-.. _class_VisualShaderNodeGroupBase_method_get_control:
-
-- :ref:`Control<class_Control>` **get_control** **(** :ref:`int<class_int>` index **)**
+Removes all previously specified output ports.
 
 
 ----
 ----
 
 
@@ -129,41 +130,47 @@ Method Descriptions
 
 
 - :ref:`int<class_int>` **get_free_input_port_id** **(** **)** const
 - :ref:`int<class_int>` **get_free_input_port_id** **(** **)** const
 
 
+Returns a free input port ID which can be used in :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
 .. _class_VisualShaderNodeGroupBase_method_get_free_output_port_id:
 
 
 - :ref:`int<class_int>` **get_free_output_port_id** **(** **)** const
 - :ref:`int<class_int>` **get_free_output_port_id** **(** **)** const
 
 
+Returns a free output port ID which can be used in :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
 .. _class_VisualShaderNodeGroupBase_method_get_input_port_count:
 
 
 - :ref:`int<class_int>` **get_input_port_count** **(** **)** const
 - :ref:`int<class_int>` **get_input_port_count** **(** **)** const
 
 
+Returns the number of input ports in use. Alternative for :ref:`get_free_input_port_id<class_VisualShaderNodeGroupBase_method_get_free_input_port_id>`.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_get_inputs:
 .. _class_VisualShaderNodeGroupBase_method_get_inputs:
 
 
 - :ref:`String<class_String>` **get_inputs** **(** **)** const
 - :ref:`String<class_String>` **get_inputs** **(** **)** const
 
 
+Returns a :ref:`String<class_String>` description of the input ports as as colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port<class_VisualShaderNodeGroupBase_method_add_input_port>`).
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
 .. _class_VisualShaderNodeGroupBase_method_get_output_port_count:
 
 
 - :ref:`int<class_int>` **get_output_port_count** **(** **)** const
 - :ref:`int<class_int>` **get_output_port_count** **(** **)** const
 
 
+Returns the number of output ports in use. Alternative for :ref:`get_free_output_port_id<class_VisualShaderNodeGroupBase_method_get_free_output_port_id>`.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_get_outputs:
 .. _class_VisualShaderNodeGroupBase_method_get_outputs:
 
 
 - :ref:`String<class_String>` **get_outputs** **(** **)** const
 - :ref:`String<class_String>` **get_outputs** **(** **)** const
 
 
-----
-
-.. _class_VisualShaderNodeGroupBase_method_get_size:
-
-- :ref:`Vector2<class_Vector2>` **get_size** **(** **)** const
+Returns a :ref:`String<class_String>` description of the output ports as as colon-separated list using the format ``id,type,name;`` (see :ref:`add_output_port<class_VisualShaderNodeGroupBase_method_add_output_port>`).
 
 
 ----
 ----
 
 
@@ -171,35 +178,39 @@ Method Descriptions
 
 
 - :ref:`bool<class_bool>` **has_input_port** **(** :ref:`int<class_int>` id **)** const
 - :ref:`bool<class_bool>` **has_input_port** **(** :ref:`int<class_int>` id **)** const
 
 
+Returns ``true`` if the specified input port exists.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_has_output_port:
 .. _class_VisualShaderNodeGroupBase_method_has_output_port:
 
 
 - :ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** const
 - :ref:`bool<class_bool>` **has_output_port** **(** :ref:`int<class_int>` id **)** const
 
 
+Returns ``true`` if the specified output port exists.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
 .. _class_VisualShaderNodeGroupBase_method_is_valid_port_name:
 
 
 - :ref:`bool<class_bool>` **is_valid_port_name** **(** :ref:`String<class_String>` name **)** const
 - :ref:`bool<class_bool>` **is_valid_port_name** **(** :ref:`String<class_String>` name **)** const
 
 
+Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_remove_input_port:
 .. _class_VisualShaderNodeGroupBase_method_remove_input_port:
 
 
 - void **remove_input_port** **(** :ref:`int<class_int>` id **)**
 - void **remove_input_port** **(** :ref:`int<class_int>` id **)**
 
 
+Removes the specified input port.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_remove_output_port:
 .. _class_VisualShaderNodeGroupBase_method_remove_output_port:
 
 
 - void **remove_output_port** **(** :ref:`int<class_int>` id **)**
 - void **remove_output_port** **(** :ref:`int<class_int>` id **)**
 
 
-----
-
-.. _class_VisualShaderNodeGroupBase_method_set_control:
-
-- void **set_control** **(** :ref:`Control<class_Control>` control, :ref:`int<class_int>` index **)**
+Removes the specified output port.
 
 
 ----
 ----
 
 
@@ -207,39 +218,45 @@ Method Descriptions
 
 
 - void **set_input_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
 - void **set_input_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
 
 
+Renames the specified input port.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
 .. _class_VisualShaderNodeGroupBase_method_set_input_port_type:
 
 
 - void **set_input_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**
 - void **set_input_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**
 
 
+Sets the specified input port's type (see :ref:`PortType<enum_VisualShaderNode_PortType>`).
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_set_inputs:
 .. _class_VisualShaderNodeGroupBase_method_set_inputs:
 
 
 - void **set_inputs** **(** :ref:`String<class_String>` inputs **)**
 - void **set_inputs** **(** :ref:`String<class_String>` inputs **)**
 
 
+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>`).
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
 .. _class_VisualShaderNodeGroupBase_method_set_output_port_name:
 
 
 - void **set_output_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
 - void **set_output_port_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**
 
 
+Renames the specified output port.
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
 .. _class_VisualShaderNodeGroupBase_method_set_output_port_type:
 
 
 - void **set_output_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**
 - void **set_output_port_type** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` type **)**
 
 
+Sets the specified output port's type (see :ref:`PortType<enum_VisualShaderNode_PortType>`).
+
 ----
 ----
 
 
 .. _class_VisualShaderNodeGroupBase_method_set_outputs:
 .. _class_VisualShaderNodeGroupBase_method_set_outputs:
 
 
 - void **set_outputs** **(** :ref:`String<class_String>` outputs **)**
 - void **set_outputs** **(** :ref:`String<class_String>` outputs **)**
 
 
-----
-
-.. _class_VisualShaderNodeGroupBase_method_set_size:
-
-- void **set_size** **(** :ref:`Vector2<class_Vector2>` size **)**
+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>`).
 
 

+ 12 - 0
classes/class_websocketpeer.rst

@@ -34,6 +34,8 @@ Methods
 +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
 +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`                        | :ref:`is_connected_to_host<class_WebSocketPeer_method_is_connected_to_host>` **(** **)** const                                    |
 | :ref:`bool<class_bool>`                        | :ref:`is_connected_to_host<class_WebSocketPeer_method_is_connected_to_host>` **(** **)** const                                    |
 +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
 +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+| void                                           | :ref:`set_no_delay<class_WebSocketPeer_method_set_no_delay>` **(** :ref:`bool<class_bool>` enabled **)**                          |
++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
 | void                                           | :ref:`set_write_mode<class_WebSocketPeer_method_set_write_mode>` **(** :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` mode **)**  |
 | void                                           | :ref:`set_write_mode<class_WebSocketPeer_method_set_write_mode>` **(** :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` mode **)**  |
 +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
 +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`                        | :ref:`was_string_packet<class_WebSocketPeer_method_was_string_packet>` **(** **)** const                                          |
 | :ref:`bool<class_bool>`                        | :ref:`was_string_packet<class_WebSocketPeer_method_was_string_packet>` **(** **)** const                                          |
@@ -105,6 +107,16 @@ Returns ``true`` if this peer is currently connected.
 
 
 ----
 ----
 
 
+.. _class_WebSocketPeer_method_set_no_delay:
+
+- void **set_no_delay** **(** :ref:`bool<class_bool>` enabled **)**
+
+Disable Nagle's algorithm on the underling TCP socket (default). See :ref:`StreamPeerTCP.set_no_delay<class_StreamPeerTCP_method_set_no_delay>` for more information.
+
+**Note:** Not available in the HTML5 export.
+
+----
+
 .. _class_WebSocketPeer_method_set_write_mode:
 .. _class_WebSocketPeer_method_set_write_mode:
 
 
 - void **set_write_mode** **(** :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` mode **)**
 - void **set_write_mode** **(** :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` mode **)**