Sync classref with current source

classes/class_basebutton.rst

@@ -79,7 +79,7 @@ This signal is emitted every time the button is toggled or pressed (i.e. activat
 
 - **toggled** **(** :ref:`bool<class_bool>` button_pressed **)**
 
-This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument.
+This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *button_pressed* argument.
 
 Enumerations
 ------------

classes/class_particlesmaterial.rst

@@ -222,9 +222,9 @@ enum **EmissionShape**:
 
 - **EMISSION_SHAPE_BOX** = **2** --- Particles will be emitted in the volume of a box.
 
-- **EMISSION_SHAPE_POINTS** = **3**
+- **EMISSION_SHAPE_POINTS** = **3** --- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticlesMaterial_property_emission_color_texture>`.
 
-- **EMISSION_SHAPE_DIRECTED_POINTS** = **4**
+- **EMISSION_SHAPE_DIRECTED_POINTS** = **4** --- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`. Particle velocity and rotation will be set based on :ref:`emission_normal_texture<class_ParticlesMaterial_property_emission_normal_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticlesMaterial_property_emission_color_texture>`.
 
 Description
 -----------
@@ -233,6 +233,8 @@ ParticlesMaterial defines particle properties and behavior. It is used in the ``
 
 Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture<class_CurveTexture>` applied to vary values over the lifetime of the particle.
 
+When a randomness ratio is applied to a property it is used to scale that property by a random amount. The random ratio is used to interpolate between ``1.0`` and a random number less than one, the result is multiplied by the property to obtain the randomized property. For example a random ratio of ``0.4`` would scale the original property between ``0.4-1.0`` of its original value.
+
 Property Descriptions
 ---------------------
 
@@ -246,7 +248,9 @@ Property Descriptions
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Initial rotation applied to each particle.
+Initial rotation applied to each particle, in degrees.
+
+Only applied when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` or :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>` are ``true`` or the :ref:`SpatialMaterial<class_SpatialMaterial>` being used to draw the particle is using ``BillboardMode.BILLBOARD_PARTICLES``.
 
 .. _class_ParticlesMaterial_property_angle_curve:
 
@@ -282,7 +286,9 @@ Rotation randomness ratio. Default value: ``0``.
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Initial angular velocity applied to each particle.
+Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.
+
+Only applied when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` or :ref:`flag_rotate_y<class_ParticlesMaterial_property_flag_rotate_y>` are ``true`` or the :ref:`SpatialMaterial<class_SpatialMaterial>` being used to draw the particle is using ``BillboardMode.BILLBOARD_PARTICLES``.
 
 .. _class_ParticlesMaterial_property_angular_velocity_curve:
 
@@ -390,7 +396,7 @@ Animation speed randomness ratio. Default value: ``0``.
 | *Getter* | get_color()      |
 +----------+------------------+
 
-Each particle's initial color. If the :ref:`Particles2D<class_Particles2D>`'s ``texture`` is defined, it will be multiplied by this color.
+Each particle's initial color. If the :ref:`Particles2D<class_Particles2D>`'s ``texture`` is defined, it will be multiplied by this color. To have particle display color in a :ref:`SpatialMaterial<class_SpatialMaterial>` make sure to set :ref:`SpatialMaterial.vertex_color_use_as_albedo<class_SpatialMaterial_property_vertex_color_use_as_albedo>` to ``true``.
 
 .. _class_ParticlesMaterial_property_color_ramp:
 
@@ -462,6 +468,8 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``.
 | *Getter* | get_emission_color_texture()      |
 +----------+-----------------------------------+
 
+Particle color will be modulated by color determined by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`.
+
 .. _class_ParticlesMaterial_property_emission_normal_texture:
 
 - :ref:`Texture<class_Texture>` **emission_normal_texture**
@@ -472,6 +480,8 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``.
 | *Getter* | get_emission_normal_texture()      |
 +----------+------------------------------------+
 
+Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticlesMaterial_property_emission_point_texture>`. Used only in ``EMISSION_SHAPE_DIRECTED``. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
+
 .. _class_ParticlesMaterial_property_emission_point_count:
 
 - :ref:`int<class_int>` **emission_point_count**
@@ -494,6 +504,8 @@ The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_P
 | *Getter* | get_emission_point_texture()      |
 +----------+-----------------------------------+
 
+Particles will be emitted at positions determined by sampling this texture at a random position. Used with ``EMISSION_SHAPE_POINTS`` and ``EMISSION_SHAPE_DIRECTED_POINTS``. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
+
 .. _class_ParticlesMaterial_property_emission_shape:
 
 - :ref:`EmissionShape<enum_ParticlesMaterial_EmissionShape>` **emission_shape**
@@ -528,6 +540,8 @@ The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``.
 | *Getter* | get_flag()      |
 +----------+-----------------+
 
+Align y-axis of particle with the direction of its velocity.
+
 .. _class_ParticlesMaterial_property_flag_disable_z:
 
 - :ref:`bool<class_bool>` **flag_disable_z**
@@ -550,6 +564,8 @@ If ``true``, particles will not move on the z axis. Default value: ``true`` for
 | *Getter* | get_flag()      |
 +----------+-----------------+
 
+If ``true``, particles rotate around y-axis by :ref:`angle<class_ParticlesMaterial_property_angle>`.
+
 .. _class_ParticlesMaterial_property_flatness:
 
 - :ref:`float<class_float>` **flatness**
@@ -560,6 +576,8 @@ If ``true``, particles will not move on the z axis. Default value: ``true`` for
 | *Getter* | get_flatness()      |
 +----------+---------------------+
 
+Amount of :ref:`spread<class_ParticlesMaterial_property_spread>` in Y/Z plane. A value of ``1`` restricts particles to X/Z plane. Default ``0``.
+
 .. _class_ParticlesMaterial_property_gravity:
 
 - :ref:`Vector3<class_Vector3>` **gravity**
@@ -618,7 +636,7 @@ Hue variation randomness ratio. Default value: ``0``.
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Initial velocity for each particle.
+Initial velocity magnitude for each particle. Direction comes from :ref:`spread<class_ParticlesMaterial_property_spread>`.
 
 .. _class_ParticlesMaterial_property_initial_velocity_random:
 
@@ -642,7 +660,7 @@ Initial velocity randomness ratio. Default value: ``0``.
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Linear acceleration applied to each particle.
+Linear acceleration applied to each particle. Acceleration increases velocity magnitude each frame without affecting direction.
 
 .. _class_ParticlesMaterial_property_linear_accel_curve:
 
@@ -678,7 +696,9 @@ Linear acceleration randomness ratio. Default value: ``0``.
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Orbital velocity applied to each particle.
+Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
+
+Only available when :ref:`flag_disable_z<class_ParticlesMaterial_property_flag_disable_z>` is ``true``.
 
 .. _class_ParticlesMaterial_property_orbit_velocity_curve:
 
@@ -714,7 +734,7 @@ Orbital velocity randomness ratio. Default value: ``0``.
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Radial acceleration applied to each particle.
+Radial acceleration applied to each particle. Makes particle accelerate away from origin.
 
 .. _class_ParticlesMaterial_property_radial_accel_curve:
 
@@ -786,7 +806,7 @@ Scale randomness ratio. Default value: ``0``.
 | *Getter* | get_spread()      |
 +----------+-------------------+
 
-Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``.
+Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. Applied to X/Z plane and Y/Z planes.
 
 .. _class_ParticlesMaterial_property_tangential_accel:
 
@@ -798,7 +818,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
 | *Getter* | get_param()      |
 +----------+------------------+
 
-Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity.
+Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
 
 .. _class_ParticlesMaterial_property_tangential_accel_curve:
 

classes/class_polygon2d.rst

@@ -26,6 +26,8 @@ Properties
 +-------------------------------------------------+------------------------------------------------------------------------------------+
 | :ref:`Color<class_Color>`                       | :ref:`color<class_Polygon2D_property_color>`                                       |
 +-------------------------------------------------+------------------------------------------------------------------------------------+
+| :ref:`int<class_int>`                           | :ref:`internal_vertex_count<class_Polygon2D_property_internal_vertex_count>`       |
++-------------------------------------------------+------------------------------------------------------------------------------------+
 | :ref:`float<class_float>`                       | :ref:`invert_border<class_Polygon2D_property_invert_border>`                       |
 +-------------------------------------------------+------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`                         | :ref:`invert_enable<class_Polygon2D_property_invert_enable>`                       |
@@ -34,9 +36,9 @@ Properties
 +-------------------------------------------------+------------------------------------------------------------------------------------+
 | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_Polygon2D_property_polygon>`                                   |
 +-------------------------------------------------+------------------------------------------------------------------------------------+
-| :ref:`NodePath<class_NodePath>`                 | :ref:`skeleton<class_Polygon2D_property_skeleton>`                                 |
+| :ref:`Array<class_Array>`                       | :ref:`polygons<class_Polygon2D_property_polygons>`                                 |
 +-------------------------------------------------+------------------------------------------------------------------------------------+
-| :ref:`PoolIntArray<class_PoolIntArray>`         | :ref:`splits<class_Polygon2D_property_splits>`                                     |
+| :ref:`NodePath<class_NodePath>`                 | :ref:`skeleton<class_Polygon2D_property_skeleton>`                                 |
 +-------------------------------------------------+------------------------------------------------------------------------------------+
 | :ref:`Texture<class_Texture>`                   | :ref:`texture<class_Polygon2D_property_texture>`                                   |
 +-------------------------------------------------+------------------------------------------------------------------------------------+
@@ -110,6 +112,16 @@ If ``true``, polygon edges will be anti-aliased. Default value: ``false``.
 
 The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``.
 
+.. _class_Polygon2D_property_internal_vertex_count:
+
+- :ref:`int<class_int>` **internal_vertex_count**
+
++----------+----------------------------------+
+| *Setter* | set_internal_vertex_count(value) |
++----------+----------------------------------+
+| *Getter* | get_internal_vertex_count()      |
++----------+----------------------------------+
+
 .. _class_Polygon2D_property_invert_border:
 
 - :ref:`float<class_float>` **invert_border**
@@ -158,6 +170,16 @@ The offset applied to each vertex.
 
 The polygon's list of vertices. The final point will be connected to the first.
 
+.. _class_Polygon2D_property_polygons:
+
+- :ref:`Array<class_Array>` **polygons**
+
++----------+---------------------+
+| *Setter* | set_polygons(value) |
++----------+---------------------+
+| *Getter* | get_polygons()      |
++----------+---------------------+
+
 .. _class_Polygon2D_property_skeleton:
 
 - :ref:`NodePath<class_NodePath>` **skeleton**
@@ -168,16 +190,6 @@ The polygon's list of vertices. The final point will be connected to the first.
 | *Getter* | get_skeleton()      |
 +----------+---------------------+
 
-.. _class_Polygon2D_property_splits:
-
-- :ref:`PoolIntArray<class_PoolIntArray>` **splits**
-
-+----------+-------------------+
-| *Setter* | set_splits(value) |
-+----------+-------------------+
-| *Getter* | get_splits()      |
-+----------+-------------------+
-
 .. _class_Polygon2D_property_texture:
 
 - :ref:`Texture<class_Texture>` **texture**

classes/class_resourceformatloader.rst

@@ -9,7 +9,7 @@ ResourceFormatLoader
 
 **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
-**Inherited By:** :ref:`GDNativeLibraryResourceLoader<class_GDNativeLibraryResourceLoader>`, :ref:`ResourceFormatDDS<class_ResourceFormatDDS>`, :ref:`ResourceFormatImporter<class_ResourceFormatImporter>`, :ref:`ResourceFormatLoaderBMFont<class_ResourceFormatLoaderBMFont>`, :ref:`ResourceFormatLoaderBinary<class_ResourceFormatLoaderBinary>`, :ref:`ResourceFormatLoaderDynamicFont<class_ResourceFormatLoaderDynamicFont>`, :ref:`ResourceFormatLoaderGDScript<class_ResourceFormatLoaderGDScript>`, :ref:`ResourceFormatLoaderImage<class_ResourceFormatLoaderImage>`, :ref:`ResourceFormatLoaderNativeScript<class_ResourceFormatLoaderNativeScript>`, :ref:`ResourceFormatLoaderShader<class_ResourceFormatLoaderShader>`, :ref:`ResourceFormatLoaderStreamTexture<class_ResourceFormatLoaderStreamTexture>`, :ref:`ResourceFormatLoaderText<class_ResourceFormatLoaderText>`, :ref:`ResourceFormatLoaderTextureLayered<class_ResourceFormatLoaderTextureLayered>`, :ref:`ResourceFormatLoaderTheora<class_ResourceFormatLoaderTheora>`, :ref:`ResourceFormatLoaderWebm<class_ResourceFormatLoaderWebm>`, :ref:`ResourceFormatPKM<class_ResourceFormatPKM>`, :ref:`ResourceFormatPVR<class_ResourceFormatPVR>`, :ref:`TranslationLoaderPO<class_TranslationLoaderPO>`
+**Inherited By:** :ref:`GDNativeLibraryResourceLoader<class_GDNativeLibraryResourceLoader>`, :ref:`ResourceFormatDDS<class_ResourceFormatDDS>`, :ref:`ResourceFormatImporter<class_ResourceFormatImporter>`, :ref:`ResourceFormatLoaderBMFont<class_ResourceFormatLoaderBMFont>`, :ref:`ResourceFormatLoaderBinary<class_ResourceFormatLoaderBinary>`, :ref:`ResourceFormatLoaderDynamicFont<class_ResourceFormatLoaderDynamicFont>`, :ref:`ResourceFormatLoaderGDScript<class_ResourceFormatLoaderGDScript>`, :ref:`ResourceFormatLoaderImage<class_ResourceFormatLoaderImage>`, :ref:`ResourceFormatLoaderNativeScript<class_ResourceFormatLoaderNativeScript>`, :ref:`ResourceFormatLoaderShader<class_ResourceFormatLoaderShader>`, :ref:`ResourceFormatLoaderStreamTexture<class_ResourceFormatLoaderStreamTexture>`, :ref:`ResourceFormatLoaderText<class_ResourceFormatLoaderText>`, :ref:`ResourceFormatLoaderTextureLayered<class_ResourceFormatLoaderTextureLayered>`, :ref:`ResourceFormatLoaderTheora<class_ResourceFormatLoaderTheora>`, :ref:`ResourceFormatLoaderVideoStreamGDNative<class_ResourceFormatLoaderVideoStreamGDNative>`, :ref:`ResourceFormatLoaderWebm<class_ResourceFormatLoaderWebm>`, :ref:`ResourceFormatPKM<class_ResourceFormatPKM>`, :ref:`ResourceFormatPVR<class_ResourceFormatPVR>`, :ref:`TranslationLoaderPO<class_TranslationLoaderPO>`
 
 **Category:** Core
 

classes/class_resourceformatloadervideostreamgdnative.rst

@@ -0,0 +1,18 @@
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderVideoStreamGDNative.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_ResourceFormatLoaderVideoStreamGDNative:
+
+ResourceFormatLoaderVideoStreamGDNative
+=======================================
+
+**Inherits:** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
+
+**Category:** Core
+
+Brief Description
+-----------------
+
+
+

classes/class_videostream.rst

@@ -9,7 +9,7 @@ VideoStream
 
 **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
-**Inherited By:** :ref:`VideoStreamTheora<class_VideoStreamTheora>`, :ref:`VideoStreamWebm<class_VideoStreamWebm>`
+**Inherited By:** :ref:`VideoStreamGDNative<class_VideoStreamGDNative>`, :ref:`VideoStreamTheora<class_VideoStreamTheora>`, :ref:`VideoStreamWebm<class_VideoStreamWebm>`
 
 **Category:** Core
 

classes/class_videostreamgdnative.rst

@@ -0,0 +1,38 @@
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the VideoStreamGDNative.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_VideoStreamGDNative:
+
+VideoStreamGDNative
+===================
+
+**Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
+
+**Category:** Core
+
+Brief Description
+-----------------
+
+
+
+Methods
+-------
+
++-----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamGDNative_method_get_file>` **(** **)**                                  |
++-----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                        | :ref:`set_file<class_VideoStreamGDNative_method_set_file>` **(** :ref:`String<class_String>` file **)** |
++-----------------------------+---------------------------------------------------------------------------------------------------------+
+
+Method Descriptions
+-------------------
+
+.. _class_VideoStreamGDNative_method_get_file:
+
+- :ref:`String<class_String>` **get_file** **(** **)**
+
+.. _class_VideoStreamGDNative_method_set_file:
+
+- void **set_file** **(** :ref:`String<class_String>` file **)**
+