Browse Source

Sync classref with current source

Rémi Verschelde 5 years ago
parent
commit
9e8981ae4f
38 changed files with 577 additions and 382 deletions
  1. 2 4
      classes/[email protected]
  2. 1 1
      classes/[email protected]
  3. 4 0
      classes/class_canvaslayer.rst
  4. 147 147
      classes/class_color.rst
  5. 6 0
      classes/class_cpuparticles.rst
  6. 6 0
      classes/class_cpuparticles2d.rst
  7. 1 1
      classes/class_editorinspectorplugin.rst
  8. 2 2
      classes/class_editorproperty.rst
  9. 1 1
      classes/class_gdscriptfunctionstate.rst
  10. 2 0
      classes/class_geometry.rst
  11. 4 0
      classes/class_input.rst
  12. 6 2
      classes/class_inputeventkey.rst
  13. 0 177
      classes/class_nil.rst
  14. 10 0
      classes/class_noisetexture.rst
  15. 2 0
      classes/class_os.rst
  16. 16 0
      classes/class_particlesmaterial.rst
  17. 3 3
      classes/class_plane.rst
  18. 5 5
      classes/class_proceduralsky.rst
  19. 246 4
      classes/class_projectsettings.rst
  20. 1 1
      classes/class_quat.rst
  21. 3 3
      classes/class_richtextlabel.rst
  22. 1 1
      classes/class_scenetree.rst
  23. 4 0
      classes/class_scrollcontainer.rst
  24. 2 0
      classes/class_sky.rst
  25. 3 1
      classes/class_spatial.rst
  26. 1 3
      classes/class_staticbody.rst
  27. 3 1
      classes/class_styleboxflat.rst
  28. 4 0
      classes/class_surfacetool.rst
  29. 13 1
      classes/class_texture.rst
  30. 5 0
      classes/class_texturearray.rst
  31. 5 0
      classes/class_texturelayered.rst
  32. 4 2
      classes/class_videoplayer.rst
  33. 5 0
      classes/class_videostream.rst
  34. 11 0
      classes/class_videostreamgdnative.rst
  35. 9 0
      classes/class_videostreamtheora.rst
  36. 9 0
      classes/class_videostreamwebm.rst
  37. 29 21
      classes/class_viewport.rst
  38. 1 1
      classes/class_visualserver.rst

+ 2 - 4
classes/[email protected]

@@ -255,15 +255,13 @@ Returns a color constructed from integer red, green, blue, and alpha channels. E
 
 
 - :ref:`Color<class_Color>` **ColorN** **(** :ref:`String<class_String>` name, :ref:`float<class_float>` alpha=1.0 **)**
 - :ref:`Color<class_Color>` **ColorN** **(** :ref:`String<class_String>` name, :ref:`float<class_float>` alpha=1.0 **)**
 
 
-Returns a color according to the standardised ``name`` with ``alpha`` ranging from 0 to 1.
+Returns a color according to the standardized ``name`` with ``alpha`` ranging from 0 to 1.
 
 
 ::
 ::
 
 
     red = ColorN("red", 1)
     red = ColorN("red", 1)
 
 
-Supported color names:
-
-"aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse", "chocolate", "coral", "cornflower", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan", "darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen", "darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue", "darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray", "dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite", "gold", "goldenrod", "gray", "webgray", "green", "webgreen", "greenyellow", "honeydew", "hotpink", "indianred", "indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon", "lightblue", "lightcoral", "lightcyan", "lightgoldenrod", "lightgray", "lightgreen", "lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray", "lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon", "webmaroon", "mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen", "mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue", "mintcream", "mistyrose", "moccasin", "navajowhite", "navyblue", "oldlace", "olive", "olivedrab", "orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise", "palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple", "webpurple", "rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown", "seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow", "springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen".
+Supported color names are the same as the constants defined in :ref:`Color<class_Color>`.
 
 
 ----
 ----
 
 

+ 1 - 1
classes/[email protected]

@@ -2033,7 +2033,7 @@ enum **MethodFlags**:
 
 
 enum **Variant.Type**:
 enum **Variant.Type**:
 
 
-- **TYPE_NIL** = **0** --- Variable is of type :ref:`Nil<class_Nil>` (only applied for ``null``).
+- **TYPE_NIL** = **0** --- Variable is ``null``.
 
 
 - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
 - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
 
 

+ 4 - 0
classes/class_canvaslayer.rst

@@ -86,6 +86,8 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
 | *Getter*  | is_following_viewport()    |
 | *Getter*  | is_following_viewport()    |
 +-----------+----------------------------+
 +-----------+----------------------------+
 
 
+Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.
+
 ----
 ----
 
 
 .. _class_CanvasLayer_property_follow_viewport_scale:
 .. _class_CanvasLayer_property_follow_viewport_scale:
@@ -100,6 +102,8 @@ The custom :ref:`Viewport<class_Viewport>` node assigned to the ``CanvasLayer``.
 | *Getter*  | get_follow_viewport_scale()      |
 | *Getter*  | get_follow_viewport_scale()      |
 +-----------+----------------------------------+
 +-----------+----------------------------------+
 
 
+Scales the layer when using :ref:`follow_viewport_enable<class_CanvasLayer_property_follow_viewport_enable>`. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
+
 ----
 ----
 
 
 .. _class_CanvasLayer_property_layer:
 .. _class_CanvasLayer_property_layer:

+ 147 - 147
classes/class_color.rst

@@ -16,7 +16,7 @@ Description
 
 
 A color is represented by red, green, and blue ``(r, g, b)`` components. Additionally, ``a`` represents the alpha component, often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may accept values greater than 1.
 A color is represented by red, green, and blue ``(r, g, b)`` components. Additionally, ``a`` represents the alpha component, often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may accept values greater than 1.
 
 
-You can also create a color from standardized color names by using :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
+You can also create a color from standardized color names by using :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>` or directly using the color constants defined here. The standardized color set is based on the `X11 color names <https://en.wikipedia.org/wiki/X11_color_names>`_.
 
 
 Properties
 Properties
 ----------
 ----------
@@ -385,297 +385,297 @@ Constants
 
 
 .. _class_Color_constant_yellowgreen:
 .. _class_Color_constant_yellowgreen:
 
 
-- **gray** = **Color( 0.75, 0.75, 0.75, 1 )**
+- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color.
 
 
-- **aliceblue** = **Color( 0.94, 0.97, 1, 1 )**
+- **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** --- Alice blue color.
 
 
-- **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )**
+- **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )** --- Antique white color.
 
 
-- **aqua** = **Color( 0, 1, 1, 1 )**
+- **aqua** = **Color( 0, 1, 1, 1 )** --- Aqua color.
 
 
-- **aquamarine** = **Color( 0.5, 1, 0.83, 1 )**
+- **aquamarine** = **Color( 0.5, 1, 0.83, 1 )** --- Aquamarine color.
 
 
-- **azure** = **Color( 0.94, 1, 1, 1 )**
+- **azure** = **Color( 0.94, 1, 1, 1 )** --- Azure color.
 
 
-- **beige** = **Color( 0.96, 0.96, 0.86, 1 )**
+- **beige** = **Color( 0.96, 0.96, 0.86, 1 )** --- Beige color.
 
 
-- **bisque** = **Color( 1, 0.89, 0.77, 1 )**
+- **bisque** = **Color( 1, 0.89, 0.77, 1 )** --- Bisque color.
 
 
-- **black** = **Color( 0, 0, 0, 1 )**
+- **black** = **Color( 0, 0, 0, 1 )** --- Black color.
 
 
-- **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )**
+- **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )** --- Blanche almond color.
 
 
-- **blue** = **Color( 0, 0, 1, 1 )**
+- **blue** = **Color( 0, 0, 1, 1 )** --- Blue color.
 
 
-- **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )**
+- **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )** --- Blue violet color.
 
 
-- **brown** = **Color( 0.65, 0.16, 0.16, 1 )**
+- **brown** = **Color( 0.65, 0.16, 0.16, 1 )** --- Brown color.
 
 
-- **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )**
+- **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )** --- Burly wood color.
 
 
-- **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )**
+- **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )** --- Cadet blue color.
 
 
-- **chartreuse** = **Color( 0.5, 1, 0, 1 )**
+- **chartreuse** = **Color( 0.5, 1, 0, 1 )** --- Chartreuse color.
 
 
-- **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )**
+- **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )** --- Chocolate color.
 
 
-- **coral** = **Color( 1, 0.5, 0.31, 1 )**
+- **coral** = **Color( 1, 0.5, 0.31, 1 )** --- Coral color.
 
 
-- **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )**
+- **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )** --- Cornflower color.
 
 
-- **cornsilk** = **Color( 1, 0.97, 0.86, 1 )**
+- **cornsilk** = **Color( 1, 0.97, 0.86, 1 )** --- Corn silk color.
 
 
-- **crimson** = **Color( 0.86, 0.08, 0.24, 1 )**
+- **crimson** = **Color( 0.86, 0.08, 0.24, 1 )** --- Crimson color.
 
 
-- **cyan** = **Color( 0, 1, 1, 1 )**
+- **cyan** = **Color( 0, 1, 1, 1 )** --- Cyan color.
 
 
-- **darkblue** = **Color( 0, 0, 0.55, 1 )**
+- **darkblue** = **Color( 0, 0, 0.55, 1 )** --- Dark blue color.
 
 
-- **darkcyan** = **Color( 0, 0.55, 0.55, 1 )**
+- **darkcyan** = **Color( 0, 0.55, 0.55, 1 )** --- Dark cyan color.
 
 
-- **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )**
+- **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )** --- Dark goldenrod color.
 
 
-- **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )**
+- **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )** --- Dark gray color.
 
 
-- **darkgreen** = **Color( 0, 0.39, 0, 1 )**
+- **darkgreen** = **Color( 0, 0.39, 0, 1 )** --- Dark green color.
 
 
-- **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )**
+- **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )** --- Dark khaki color.
 
 
-- **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )**
+- **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )** --- Dark magenta color.
 
 
-- **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )**
+- **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )** --- Dark olive green color.
 
 
-- **darkorange** = **Color( 1, 0.55, 0, 1 )**
+- **darkorange** = **Color( 1, 0.55, 0, 1 )** --- Dark orange color.
 
 
-- **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )**
+- **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )** --- Dark orchid color.
 
 
-- **darkred** = **Color( 0.55, 0, 0, 1 )**
+- **darkred** = **Color( 0.55, 0, 0, 1 )** --- Dark red color.
 
 
-- **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )**
+- **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )** --- Dark salmon color.
 
 
-- **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )**
+- **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )** --- Dark sea green color.
 
 
-- **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )**
+- **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )** --- Dark slate blue color.
 
 
-- **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )**
+- **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )** --- Dark slate gray color.
 
 
-- **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )**
+- **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )** --- Dark turquoise color.
 
 
-- **darkviolet** = **Color( 0.58, 0, 0.83, 1 )**
+- **darkviolet** = **Color( 0.58, 0, 0.83, 1 )** --- Dark violet color.
 
 
-- **deeppink** = **Color( 1, 0.08, 0.58, 1 )**
+- **deeppink** = **Color( 1, 0.08, 0.58, 1 )** --- Deep pink color.
 
 
-- **deepskyblue** = **Color( 0, 0.75, 1, 1 )**
+- **deepskyblue** = **Color( 0, 0.75, 1, 1 )** --- Deep sky blue color.
 
 
-- **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )**
+- **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )** --- Dim gray color.
 
 
-- **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )**
+- **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )** --- Dodger blue color.
 
 
-- **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )**
+- **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )** --- Firebrick color.
 
 
-- **floralwhite** = **Color( 1, 0.98, 0.94, 1 )**
+- **floralwhite** = **Color( 1, 0.98, 0.94, 1 )** --- Floral white color.
 
 
-- **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )**
+- **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )** --- Forest green color.
 
 
-- **fuchsia** = **Color( 1, 0, 1, 1 )**
+- **fuchsia** = **Color( 1, 0, 1, 1 )** --- Fuchsia color.
 
 
-- **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )**
+- **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )** --- Gainsboro color.
 
 
-- **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )**
+- **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )** --- Ghost white color.
 
 
-- **gold** = **Color( 1, 0.84, 0, 1 )**
+- **gold** = **Color( 1, 0.84, 0, 1 )** --- Gold color.
 
 
-- **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )**
+- **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )** --- Goldenrod color.
 
 
-- **green** = **Color( 0, 1, 0, 1 )**
+- **green** = **Color( 0, 1, 0, 1 )** --- Green color.
 
 
-- **greenyellow** = **Color( 0.68, 1, 0.18, 1 )**
+- **greenyellow** = **Color( 0.68, 1, 0.18, 1 )** --- Green yellow color.
 
 
-- **honeydew** = **Color( 0.94, 1, 0.94, 1 )**
+- **honeydew** = **Color( 0.94, 1, 0.94, 1 )** --- Honeydew color.
 
 
-- **hotpink** = **Color( 1, 0.41, 0.71, 1 )**
+- **hotpink** = **Color( 1, 0.41, 0.71, 1 )** --- Hot pink color.
 
 
-- **indianred** = **Color( 0.8, 0.36, 0.36, 1 )**
+- **indianred** = **Color( 0.8, 0.36, 0.36, 1 )** --- Indian red color.
 
 
-- **indigo** = **Color( 0.29, 0, 0.51, 1 )**
+- **indigo** = **Color( 0.29, 0, 0.51, 1 )** --- Indigo color.
 
 
-- **ivory** = **Color( 1, 1, 0.94, 1 )**
+- **ivory** = **Color( 1, 1, 0.94, 1 )** --- Ivory color.
 
 
-- **khaki** = **Color( 0.94, 0.9, 0.55, 1 )**
+- **khaki** = **Color( 0.94, 0.9, 0.55, 1 )** --- Khaki color.
 
 
-- **lavender** = **Color( 0.9, 0.9, 0.98, 1 )**
+- **lavender** = **Color( 0.9, 0.9, 0.98, 1 )** --- Lavender color.
 
 
-- **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )**
+- **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )** --- Lavender blush color.
 
 
-- **lawngreen** = **Color( 0.49, 0.99, 0, 1 )**
+- **lawngreen** = **Color( 0.49, 0.99, 0, 1 )** --- Lawn green color.
 
 
-- **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )**
+- **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )** --- Lemon chiffon color.
 
 
-- **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )**
+- **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )** --- Light blue color.
 
 
-- **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )**
+- **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )** --- Light coral color.
 
 
-- **lightcyan** = **Color( 0.88, 1, 1, 1 )**
+- **lightcyan** = **Color( 0.88, 1, 1, 1 )** --- Light cyan color.
 
 
-- **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )**
+- **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )** --- Light goldenrod color.
 
 
-- **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )**
+- **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )** --- Light gray color.
 
 
-- **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )**
+- **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )** --- Light green color.
 
 
-- **lightpink** = **Color( 1, 0.71, 0.76, 1 )**
+- **lightpink** = **Color( 1, 0.71, 0.76, 1 )** --- Light pink color.
 
 
-- **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )**
+- **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )** --- Light salmon color.
 
 
-- **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )**
+- **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )** --- Light sea green color.
 
 
-- **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )**
+- **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )** --- Light sky blue color.
 
 
-- **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )**
+- **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )** --- Light slate gray color.
 
 
-- **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )**
+- **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )** --- Light steel blue color.
 
 
-- **lightyellow** = **Color( 1, 1, 0.88, 1 )**
+- **lightyellow** = **Color( 1, 1, 0.88, 1 )** --- Light yellow color.
 
 
-- **lime** = **Color( 0, 1, 0, 1 )**
+- **lime** = **Color( 0, 1, 0, 1 )** --- Lime color.
 
 
-- **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )**
+- **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )** --- Lime green color.
 
 
-- **linen** = **Color( 0.98, 0.94, 0.9, 1 )**
+- **linen** = **Color( 0.98, 0.94, 0.9, 1 )** --- Linen color.
 
 
-- **magenta** = **Color( 1, 0, 1, 1 )**
+- **magenta** = **Color( 1, 0, 1, 1 )** --- Magenta color.
 
 
-- **maroon** = **Color( 0.69, 0.19, 0.38, 1 )**
+- **maroon** = **Color( 0.69, 0.19, 0.38, 1 )** --- Maroon color.
 
 
-- **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )**
+- **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )** --- Medium aquamarine color.
 
 
-- **mediumblue** = **Color( 0, 0, 0.8, 1 )**
+- **mediumblue** = **Color( 0, 0, 0.8, 1 )** --- Medium blue color.
 
 
-- **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )**
+- **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )** --- Medium orchid color.
 
 
-- **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )**
+- **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )** --- Medium purple color.
 
 
-- **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )**
+- **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )** --- Medium sea green color.
 
 
-- **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )**
+- **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )** --- Medium slate blue color.
 
 
-- **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )**
+- **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )** --- Medium spring green color.
 
 
-- **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )**
+- **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )** --- Medium turquoise color.
 
 
-- **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )**
+- **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )** --- Medium violet red color.
 
 
-- **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )**
+- **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )** --- Midnight blue color.
 
 
-- **mintcream** = **Color( 0.96, 1, 0.98, 1 )**
+- **mintcream** = **Color( 0.96, 1, 0.98, 1 )** --- Mint cream color.
 
 
-- **mistyrose** = **Color( 1, 0.89, 0.88, 1 )**
+- **mistyrose** = **Color( 1, 0.89, 0.88, 1 )** --- Misty rose color.
 
 
-- **moccasin** = **Color( 1, 0.89, 0.71, 1 )**
+- **moccasin** = **Color( 1, 0.89, 0.71, 1 )** --- Moccasin color.
 
 
-- **navajowhite** = **Color( 1, 0.87, 0.68, 1 )**
+- **navajowhite** = **Color( 1, 0.87, 0.68, 1 )** --- Navajo white color.
 
 
-- **navyblue** = **Color( 0, 0, 0.5, 1 )**
+- **navyblue** = **Color( 0, 0, 0.5, 1 )** --- Navy blue color.
 
 
-- **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )**
+- **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )** --- Old lace color.
 
 
-- **olive** = **Color( 0.5, 0.5, 0, 1 )**
+- **olive** = **Color( 0.5, 0.5, 0, 1 )** --- Olive color.
 
 
-- **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )**
+- **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )** --- Olive drab color.
 
 
-- **orange** = **Color( 1, 0.65, 0, 1 )**
+- **orange** = **Color( 1, 0.65, 0, 1 )** --- Orange color.
 
 
-- **orangered** = **Color( 1, 0.27, 0, 1 )**
+- **orangered** = **Color( 1, 0.27, 0, 1 )** --- Orange red color.
 
 
-- **orchid** = **Color( 0.85, 0.44, 0.84, 1 )**
+- **orchid** = **Color( 0.85, 0.44, 0.84, 1 )** --- Orchid color.
 
 
-- **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )**
+- **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )** --- Pale goldenrod color.
 
 
-- **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )**
+- **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )** --- Pale green color.
 
 
-- **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )**
+- **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )** --- Pale turquoise color.
 
 
-- **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )**
+- **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )** --- Pale violet red color.
 
 
-- **papayawhip** = **Color( 1, 0.94, 0.84, 1 )**
+- **papayawhip** = **Color( 1, 0.94, 0.84, 1 )** --- Papaya whip color.
 
 
-- **peachpuff** = **Color( 1, 0.85, 0.73, 1 )**
+- **peachpuff** = **Color( 1, 0.85, 0.73, 1 )** --- Peach puff color.
 
 
-- **peru** = **Color( 0.8, 0.52, 0.25, 1 )**
+- **peru** = **Color( 0.8, 0.52, 0.25, 1 )** --- Peru color.
 
 
-- **pink** = **Color( 1, 0.75, 0.8, 1 )**
+- **pink** = **Color( 1, 0.75, 0.8, 1 )** --- Pink color.
 
 
-- **plum** = **Color( 0.87, 0.63, 0.87, 1 )**
+- **plum** = **Color( 0.87, 0.63, 0.87, 1 )** --- Plum color.
 
 
-- **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )**
+- **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )** --- Powder blue color.
 
 
-- **purple** = **Color( 0.63, 0.13, 0.94, 1 )**
+- **purple** = **Color( 0.63, 0.13, 0.94, 1 )** --- Purple color.
 
 
-- **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )**
+- **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )** --- Rebecca purple color.
 
 
-- **red** = **Color( 1, 0, 0, 1 )**
+- **red** = **Color( 1, 0, 0, 1 )** --- Red color.
 
 
-- **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )**
+- **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )** --- Rosy brown color.
 
 
-- **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )**
+- **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )** --- Royal blue color.
 
 
-- **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )**
+- **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )** --- Saddle brown color.
 
 
-- **salmon** = **Color( 0.98, 0.5, 0.45, 1 )**
+- **salmon** = **Color( 0.98, 0.5, 0.45, 1 )** --- Salmon color.
 
 
-- **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )**
+- **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )** --- Sandy brown color.
 
 
-- **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )**
+- **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )** --- Sea green color.
 
 
-- **seashell** = **Color( 1, 0.96, 0.93, 1 )**
+- **seashell** = **Color( 1, 0.96, 0.93, 1 )** --- Seashell color.
 
 
-- **sienna** = **Color( 0.63, 0.32, 0.18, 1 )**
+- **sienna** = **Color( 0.63, 0.32, 0.18, 1 )** --- Sienna color.
 
 
-- **silver** = **Color( 0.75, 0.75, 0.75, 1 )**
+- **silver** = **Color( 0.75, 0.75, 0.75, 1 )** --- Silver color.
 
 
-- **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )**
+- **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )** --- Sky blue color.
 
 
-- **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )**
+- **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )** --- Slate blue color.
 
 
-- **slategray** = **Color( 0.44, 0.5, 0.56, 1 )**
+- **slategray** = **Color( 0.44, 0.5, 0.56, 1 )** --- Slate gray color.
 
 
-- **snow** = **Color( 1, 0.98, 0.98, 1 )**
+- **snow** = **Color( 1, 0.98, 0.98, 1 )** --- Snow color.
 
 
-- **springgreen** = **Color( 0, 1, 0.5, 1 )**
+- **springgreen** = **Color( 0, 1, 0.5, 1 )** --- Spring green color.
 
 
-- **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )**
+- **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )** --- Steel blue color.
 
 
-- **tan** = **Color( 0.82, 0.71, 0.55, 1 )**
+- **tan** = **Color( 0.82, 0.71, 0.55, 1 )** --- Tan color.
 
 
-- **teal** = **Color( 0, 0.5, 0.5, 1 )**
+- **teal** = **Color( 0, 0.5, 0.5, 1 )** --- Teal color.
 
 
-- **thistle** = **Color( 0.85, 0.75, 0.85, 1 )**
+- **thistle** = **Color( 0.85, 0.75, 0.85, 1 )** --- Thistle color.
 
 
-- **tomato** = **Color( 1, 0.39, 0.28, 1 )**
+- **tomato** = **Color( 1, 0.39, 0.28, 1 )** --- Tomato color.
 
 
-- **transparent** = **Color( 1, 1, 1, 0 )**
+- **transparent** = **Color( 1, 1, 1, 0 )** --- Transparent color (white with no alpha).
 
 
-- **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )**
+- **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )** --- Turquoise color.
 
 
-- **violet** = **Color( 0.93, 0.51, 0.93, 1 )**
+- **violet** = **Color( 0.93, 0.51, 0.93, 1 )** --- Violet color.
 
 
-- **webgray** = **Color( 0.5, 0.5, 0.5, 1 )**
+- **webgray** = **Color( 0.5, 0.5, 0.5, 1 )** --- Web gray color.
 
 
-- **webgreen** = **Color( 0, 0.5, 0, 1 )**
+- **webgreen** = **Color( 0, 0.5, 0, 1 )** --- Web green color.
 
 
-- **webmaroon** = **Color( 0.5, 0, 0, 1 )**
+- **webmaroon** = **Color( 0.5, 0, 0, 1 )** --- Web maroon color.
 
 
-- **webpurple** = **Color( 0.5, 0, 0.5, 1 )**
+- **webpurple** = **Color( 0.5, 0, 0.5, 1 )** --- Web purple color.
 
 
-- **wheat** = **Color( 0.96, 0.87, 0.7, 1 )**
+- **wheat** = **Color( 0.96, 0.87, 0.7, 1 )** --- Wheat color.
 
 
-- **white** = **Color( 1, 1, 1, 1 )**
+- **white** = **Color( 1, 1, 1, 1 )** --- White color.
 
 
-- **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )**
+- **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )** --- White smoke color.
 
 
-- **yellow** = **Color( 1, 1, 0, 1 )**
+- **yellow** = **Color( 1, 1, 0, 1 )** --- Yellow color.
 
 
-- **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )**
+- **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )** --- Yellow green color.
 
 
 Property Descriptions
 Property Descriptions
 ---------------------
 ---------------------

+ 6 - 0
classes/class_cpuparticles.rst

@@ -644,6 +644,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
 | *Getter*  | get_emission_colors()      |
 | *Getter*  | get_emission_colors()      |
 +-----------+----------------------------+
 +-----------+----------------------------+
 
 
+Sets the :ref:`Color<class_Color>`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS<class_CPUParticles_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
+
 ----
 ----
 
 
 .. _class_CPUParticles_property_emission_normals:
 .. _class_CPUParticles_property_emission_normals:
@@ -656,6 +658,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
 | *Getter* | get_emission_normals()      |
 | *Getter* | get_emission_normals()      |
 +----------+-----------------------------+
 +----------+-----------------------------+
 
 
+Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
+
 ----
 ----
 
 
 .. _class_CPUParticles_property_emission_points:
 .. _class_CPUParticles_property_emission_points:
@@ -670,6 +674,8 @@ The rectangle's extents if :ref:`emission_shape<class_CPUParticles_property_emis
 | *Getter*  | get_emission_points()      |
 | *Getter*  | get_emission_points()      |
 +-----------+----------------------------+
 +-----------+----------------------------+
 
 
+Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS<class_CPUParticles_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
+
 ----
 ----
 
 
 .. _class_CPUParticles_property_emission_shape:
 .. _class_CPUParticles_property_emission_shape:

+ 6 - 0
classes/class_cpuparticles2d.rst

@@ -625,6 +625,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
 | *Getter* | get_emission_colors()      |
 | *Getter* | get_emission_colors()      |
 +----------+----------------------------+
 +----------+----------------------------+
 
 
+Sets the :ref:`Color<class_Color>`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS<class_CPUParticles2D_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles2D_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
+
 ----
 ----
 
 
 .. _class_CPUParticles2D_property_emission_normals:
 .. _class_CPUParticles2D_property_emission_normals:
@@ -637,6 +639,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
 | *Getter* | get_emission_normals()      |
 | *Getter* | get_emission_normals()      |
 +----------+-----------------------------+
 +----------+-----------------------------+
 
 
+Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles2D_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
+
 ----
 ----
 
 
 .. _class_CPUParticles2D_property_emission_points:
 .. _class_CPUParticles2D_property_emission_points:
@@ -649,6 +653,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_CPUParticles2D_DrawOrder>` values
 | *Getter* | get_emission_points()      |
 | *Getter* | get_emission_points()      |
 +----------+----------------------------+
 +----------+----------------------------+
 
 
+Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS<class_CPUParticles2D_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_CPUParticles2D_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
+
 ----
 ----
 
 
 .. _class_CPUParticles2D_property_emission_rect_extents:
 .. _class_CPUParticles2D_property_emission_rect_extents:

+ 1 - 1
classes/class_editorinspectorplugin.rst

@@ -114,5 +114,5 @@ Called to allow adding controls at the end of the list.
 
 
 - :ref:`bool<class_bool>` **parse_property** **(** :ref:`Object<class_Object>` object, :ref:`int<class_int>` type, :ref:`String<class_String>` path, :ref:`int<class_int>` hint, :ref:`String<class_String>` hint_text, :ref:`int<class_int>` usage **)** virtual
 - :ref:`bool<class_bool>` **parse_property** **(** :ref:`Object<class_Object>` object, :ref:`int<class_int>` type, :ref:`String<class_String>` path, :ref:`int<class_int>` hint, :ref:`String<class_String>` hint_text, :ref:`int<class_int>` usage **)** virtual
 
 
-Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty<class_EditorProperty>`.
+Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty<class_EditorProperty>`. Returning ``true`` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.
 
 

+ 2 - 2
classes/class_editorproperty.rst

@@ -75,7 +75,7 @@ Used by sub-inspectors. Emit it if what was selected was an Object ID.
 
 
 .. _class_EditorProperty_signal_property_changed:
 .. _class_EditorProperty_signal_property_changed:
 
 
-- **property_changed** **(** :ref:`String<class_String>` property, :ref:`Nil<class_Nil>` value **)**
+- **property_changed** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)**
 
 
 Do not emit this manually, use the :ref:`emit_changed<class_EditorProperty_method_emit_changed>` method instead.
 Do not emit this manually, use the :ref:`emit_changed<class_EditorProperty_method_emit_changed>` method instead.
 
 
@@ -99,7 +99,7 @@ Emit it if you want to add this value as an animation key (check for keying bein
 
 
 .. _class_EditorProperty_signal_property_keyed_with_value:
 .. _class_EditorProperty_signal_property_keyed_with_value:
 
 
-- **property_keyed_with_value** **(** :ref:`String<class_String>` property, :ref:`Nil<class_Nil>` value **)**
+- **property_keyed_with_value** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)**
 
 
 Emit it if you want to key a property with a single value.
 Emit it if you want to key a property with a single value.
 
 

+ 1 - 1
classes/class_gdscriptfunctionstate.rst

@@ -32,7 +32,7 @@ Signals
 
 
 .. _class_GDScriptFunctionState_signal_completed:
 .. _class_GDScriptFunctionState_signal_completed:
 
 
-- **completed** **(** :ref:`Nil<class_Nil>` result **)**
+- **completed** **(** :ref:`Variant<class_Variant>` result **)**
 
 
 Method Descriptions
 Method Descriptions
 -------------------
 -------------------

+ 2 - 0
classes/class_geometry.rst

@@ -283,6 +283,8 @@ Given the two 2D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two
 
 
 - :ref:`int<class_int>` **get_uv84_normal_bit** **(** :ref:`Vector3<class_Vector3>` normal **)**
 - :ref:`int<class_int>` **get_uv84_normal_bit** **(** :ref:`Vector3<class_Vector3>` normal **)**
 
 
+Used internally by the engine.
+
 ----
 ----
 
 
 .. _class_Geometry_method_intersect_polygons_2d:
 .. _class_Geometry_method_intersect_polygons_2d:

+ 4 - 0
classes/class_input.rst

@@ -463,6 +463,10 @@ Returns ``true`` if you are pressing the mouse button specified with :ref:`Butto
 
 
 - void **joy_connection_changed** **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected, :ref:`String<class_String>` name, :ref:`String<class_String>` guid **)**
 - void **joy_connection_changed** **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected, :ref:`String<class_String>` name, :ref:`String<class_String>` guid **)**
 
 
+Notifies the ``Input`` singleton that a connection has changed, to update the state for the ``device`` index.
+
+This is used internally and should not have to be called from user scripts. See :ref:`joy_connection_changed<class_Input_signal_joy_connection_changed>` for the signal emitted when this is triggered internally.
+
 ----
 ----
 
 
 .. _class_Input_method_parse_input_event:
 .. _class_Input_method_parse_input_event:

+ 6 - 2
classes/class_inputeventkey.rst

@@ -90,7 +90,9 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas
 | *Getter*  | get_scancode()      |
 | *Getter*  | get_scancode()      |
 +-----------+---------------------+
 +-----------+---------------------+
 
 
-Key scancode, one of the :ref:`KeyList<enum_@GlobalScope_KeyList>` constants.
+The key scancode, which corresponds to one of the :ref:`KeyList<enum_@GlobalScope_KeyList>` constants.
+
+To get a human-readable representation of the ``InputEventKey``, use ``OS.get_scancode_string(event.scancode)`` where ``event`` is the ``InputEventKey``.
 
 
 ----
 ----
 
 
@@ -106,7 +108,7 @@ Key scancode, one of the :ref:`KeyList<enum_@GlobalScope_KeyList>` constants.
 | *Getter*  | get_unicode()      |
 | *Getter*  | get_unicode()      |
 +-----------+--------------------+
 +-----------+--------------------+
 
 
-Key Unicode identifier when relevant. Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`OS.set_ime_active<class_OS_method_set_ime_active>` for more information.
+The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`OS.set_ime_active<class_OS_method_set_ime_active>` for more information.
 
 
 Method Descriptions
 Method Descriptions
 -------------------
 -------------------
@@ -117,3 +119,5 @@ Method Descriptions
 
 
 Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`.
 Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`.
 
 
+To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_scancode_string(event.get_scancode_with_modifiers())`` where ``event`` is the ``InputEventKey``.
+

+ 0 - 177
classes/class_nil.rst

@@ -1,177 +0,0 @@
-:github_url: hide
-
-.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
-.. DO NOT EDIT THIS FILE, but the Nil.xml source instead.
-.. The source is found in doc/classes or modules/<name>/doc_classes.
-
-.. _class_Nil:
-
-Nil
-===
-
-
-
-Methods
--------
-
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)**     |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)** |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)** |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**   |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**         |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Array<class_Array>` from **)**                       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Dictionary<class_Dictionary>` from **)**             |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Object<class_Object>` from **)**                     |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`RID<class_RID>` from **)**                           |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`NodePath<class_NodePath>` from **)**                 |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Color<class_Color>` from **)**                       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Transform<class_Transform>` from **)**               |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Basis<class_Basis>` from **)**                       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`AABB<class_AABB>` from **)**                         |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Quat<class_Quat>` from **)**                         |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Plane<class_Plane>` from **)**                       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Transform2D<class_Transform2D>` from **)**           |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Vector3<class_Vector3>` from **)**                   |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Rect2<class_Rect2>` from **)**                       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`Vector2<class_Vector2>` from **)**                   |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`String<class_String>` from **)**                     |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`float<class_float>` from **)**                       |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`int<class_int>` from **)**                           |
-+------+---------------------------------------------------------------------------------------------------+
-| void | :ref:`Nil<class_Nil_method_Nil>` **(** :ref:`bool<class_bool>` from **)**                         |
-+------+---------------------------------------------------------------------------------------------------+
-
-Method Descriptions
--------------------
-
-.. _class_Nil_method_Nil:
-
-- void **Nil** **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Array<class_Array>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Dictionary<class_Dictionary>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Object<class_Object>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`RID<class_RID>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`NodePath<class_NodePath>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Color<class_Color>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Transform<class_Transform>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Basis<class_Basis>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`AABB<class_AABB>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Quat<class_Quat>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Plane<class_Plane>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Transform2D<class_Transform2D>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Vector3<class_Vector3>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Rect2<class_Rect2>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`Vector2<class_Vector2>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`String<class_String>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`float<class_float>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`int<class_int>` from **)**
-
-----
-
-- void **Nil** **(** :ref:`bool<class_bool>` from **)**
-

+ 10 - 0
classes/class_noisetexture.rst

@@ -20,6 +20,14 @@ Uses an :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` to fill the texture data
 
 
 NoiseTexture can also generate normalmap textures.
 NoiseTexture can also generate normalmap textures.
 
 
+The class uses :ref:`Thread<class_Thread>`\ s to generate the texture data internally, so :ref:`Texture.get_data<class_Texture_method_get_data>` may return ``null`` if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the data:
+
+::
+
+    var texture = preload("res://noise.tres")
+    yield(texture, "changed")
+    var image = texture.get_data()
+
 Properties
 Properties
 ----------
 ----------
 
 
@@ -70,6 +78,8 @@ If ``true``, the resulting texture contains a normal map created from the origin
 | *Getter*  | get_bump_strength()      |
 | *Getter*  | get_bump_strength()      |
 +-----------+--------------------------+
 +-----------+--------------------------+
 
 
+Strength of the bump maps used in this texture. A higher value will make the bump maps appear larger while a lower value will make them appear softer.
+
 ----
 ----
 
 
 .. _class_NoiseTexture_property_height:
 .. _class_NoiseTexture_property_height:

+ 2 - 0
classes/class_os.rst

@@ -1142,6 +1142,8 @@ Returns the window size including decorations like window borders.
 
 
 Returns the given scancode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``).
 Returns the given scancode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``).
 
 
+See also :ref:`InputEventKey.scancode<class_InputEventKey_property_scancode>` and :ref:`InputEventKey.get_scancode_with_modifiers<class_InputEventKey_method_get_scancode_with_modifiers>`.
+
 ----
 ----
 
 
 .. _class_OS_method_get_screen_count:
 .. _class_OS_method_get_screen_count:

+ 16 - 0
classes/class_particlesmaterial.rst

@@ -1119,45 +1119,61 @@ Method Descriptions
 
 
 - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag **)** const
 - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag **)** const
 
 
+Returns ``true`` if the specified flag is enabled.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_get_param:
 .. _class_ParticlesMaterial_method_get_param:
 
 
 - :ref:`float<class_float>` **get_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
 - :ref:`float<class_float>` **get_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
 
 
+Returns the value of the specified parameter.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_get_param_randomness:
 .. _class_ParticlesMaterial_method_get_param_randomness:
 
 
 - :ref:`float<class_float>` **get_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
 - :ref:`float<class_float>` **get_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
 
 
+Returns the randomness ratio associated with the specified parameter.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_get_param_texture:
 .. _class_ParticlesMaterial_method_get_param_texture:
 
 
 - :ref:`Texture<class_Texture>` **get_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
 - :ref:`Texture<class_Texture>` **get_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param **)** const
 
 
+Returns the :ref:`Texture<class_Texture>` used by the specified parameter.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_set_flag:
 .. _class_ParticlesMaterial_method_set_flag:
 
 
 - void **set_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)**
 - void **set_flag** **(** :ref:`Flags<enum_ParticlesMaterial_Flags>` flag, :ref:`bool<class_bool>` enable **)**
 
 
+If ``true``, enables the specified flag. See :ref:`Flags<enum_ParticlesMaterial_Flags>` for options.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_set_param:
 .. _class_ParticlesMaterial_method_set_param:
 
 
 - void **set_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
 - void **set_param** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
 
 
+Sets the specified :ref:`Parameter<enum_ParticlesMaterial_Parameter>`.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_set_param_randomness:
 .. _class_ParticlesMaterial_method_set_param_randomness:
 
 
 - void **set_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` randomness **)**
 - void **set_param_randomness** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`float<class_float>` randomness **)**
 
 
+Sets the randomness ratio for the specified :ref:`Parameter<enum_ParticlesMaterial_Parameter>`.
+
 ----
 ----
 
 
 .. _class_ParticlesMaterial_method_set_param_texture:
 .. _class_ParticlesMaterial_method_set_param_texture:
 
 
 - void **set_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`Texture<class_Texture>` texture **)**
 - void **set_param_texture** **(** :ref:`Parameter<enum_ParticlesMaterial_Parameter>` param, :ref:`Texture<class_Texture>` texture **)**
 
 
+Sets the :ref:`Texture<class_Texture>` for the specified :ref:`Parameter<enum_ParticlesMaterial_Parameter>`.
+

+ 3 - 3
classes/class_plane.rst

@@ -78,11 +78,11 @@ Constants
 
 
 .. _class_Plane_constant_PLANE_XY:
 .. _class_Plane_constant_PLANE_XY:
 
 
-- **PLANE_YZ** = **Plane( 1, 0, 0, 0 )**
+- **PLANE_YZ** = **Plane( 1, 0, 0, 0 )** --- A plane that extends in the Y and Z axes.
 
 
-- **PLANE_XZ** = **Plane( 0, 1, 0, 0 )**
+- **PLANE_XZ** = **Plane( 0, 1, 0, 0 )** --- A plane that extends in the X and Z axes.
 
 
-- **PLANE_XY** = **Plane( 0, 0, 1, 0 )**
+- **PLANE_XY** = **Plane( 0, 0, 1, 0 )** --- A plane that extends in the X and Y axes.
 
 
 Property Descriptions
 Property Descriptions
 ---------------------
 ---------------------

+ 5 - 5
classes/class_proceduralsky.rst

@@ -76,15 +76,15 @@ Enumerations
 
 
 enum **TextureSize**:
 enum **TextureSize**:
 
 
-- **TEXTURE_SIZE_256** = **0**
+- **TEXTURE_SIZE_256** = **0** --- Sky texture will be 256x128.
 
 
-- **TEXTURE_SIZE_512** = **1**
+- **TEXTURE_SIZE_512** = **1** --- Sky texture will be 512x256.
 
 
-- **TEXTURE_SIZE_1024** = **2**
+- **TEXTURE_SIZE_1024** = **2** --- Sky texture will be 1024x512. This is the default size.
 
 
-- **TEXTURE_SIZE_2048** = **3**
+- **TEXTURE_SIZE_2048** = **3** --- Sky texture will be 2048x1024.
 
 
-- **TEXTURE_SIZE_4096** = **4**
+- **TEXTURE_SIZE_4096** = **4** --- Sky texture will be 4096x2048.
 
 
 - **TEXTURE_SIZE_MAX** = **5** --- Represents the size of the :ref:`TextureSize<enum_ProceduralSky_TextureSize>` enum.
 - **TEXTURE_SIZE_MAX** = **5** --- Represents the size of the :ref:`TextureSize<enum_ProceduralSky_TextureSize>` enum.
 
 

File diff suppressed because it is too large
+ 246 - 4
classes/class_projectsettings.rst


+ 1 - 1
classes/class_quat.rst

@@ -84,7 +84,7 @@ Constants
 
 
 .. _class_Quat_constant_IDENTITY:
 .. _class_Quat_constant_IDENTITY:
 
 
-- **IDENTITY** = **Quat( 0, 0, 0, 1 )**
+- **IDENTITY** = **Quat( 0, 0, 0, 1 )** --- The identity rotation. Equivalent to an identity matrix. If a vector is transformed by an identity quaternion, it will not change.
 
 
 Property Descriptions
 Property Descriptions
 ---------------------
 ---------------------

+ 3 - 3
classes/class_richtextlabel.rst

@@ -169,7 +169,7 @@ Signals
 
 
 .. _class_RichTextLabel_signal_meta_clicked:
 .. _class_RichTextLabel_signal_meta_clicked:
 
 
-- **meta_clicked** **(** :ref:`Nil<class_Nil>` meta **)**
+- **meta_clicked** **(** :ref:`Variant<class_Variant>` meta **)**
 
 
 Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String<class_String>` type. If a particular type or an object is desired, the :ref:`push_meta<class_RichTextLabel_method_push_meta>` method must be used to manually insert the data into the tag stack.
 Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String<class_String>` type. If a particular type or an object is desired, the :ref:`push_meta<class_RichTextLabel_method_push_meta>` method must be used to manually insert the data into the tag stack.
 
 
@@ -177,7 +177,7 @@ Triggered when the user clicks on content between meta tags. If the meta is defi
 
 
 .. _class_RichTextLabel_signal_meta_hover_ended:
 .. _class_RichTextLabel_signal_meta_hover_ended:
 
 
-- **meta_hover_ended** **(** :ref:`Nil<class_Nil>` meta **)**
+- **meta_hover_ended** **(** :ref:`Variant<class_Variant>` meta **)**
 
 
 Triggers when the mouse exits a meta tag.
 Triggers when the mouse exits a meta tag.
 
 
@@ -185,7 +185,7 @@ Triggers when the mouse exits a meta tag.
 
 
 .. _class_RichTextLabel_signal_meta_hover_started:
 .. _class_RichTextLabel_signal_meta_hover_started:
 
 
-- **meta_hover_started** **(** :ref:`Nil<class_Nil>` meta **)**
+- **meta_hover_started** **(** :ref:`Variant<class_Variant>` meta **)**
 
 
 Triggers when the mouse enters a meta tag.
 Triggers when the mouse enters a meta tag.
 
 

+ 1 - 1
classes/class_scenetree.rst

@@ -142,7 +142,7 @@ Emitted when files are dragged from the OS file manager and dropped in the game
 
 
 .. _class_SceneTree_signal_global_menu_action:
 .. _class_SceneTree_signal_global_menu_action:
 
 
-- **global_menu_action** **(** :ref:`Nil<class_Nil>` id, :ref:`Nil<class_Nil>` meta **)**
+- **global_menu_action** **(** :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)**
 
 
 Emitted whenever global menu item is clicked.
 Emitted whenever global menu item is clicked.
 
 

+ 4 - 0
classes/class_scrollcontainer.rst

@@ -174,9 +174,13 @@ Method Descriptions
 
 
 - :ref:`HScrollBar<class_HScrollBar>` **get_h_scrollbar** **(** **)**
 - :ref:`HScrollBar<class_HScrollBar>` **get_h_scrollbar** **(** **)**
 
 
+Returns the horizontal scrollbar :ref:`HScrollBar<class_HScrollBar>` of this ``ScrollContainer``.
+
 ----
 ----
 
 
 .. _class_ScrollContainer_method_get_v_scrollbar:
 .. _class_ScrollContainer_method_get_v_scrollbar:
 
 
 - :ref:`VScrollBar<class_VScrollBar>` **get_v_scrollbar** **(** **)**
 - :ref:`VScrollBar<class_VScrollBar>` **get_v_scrollbar** **(** **)**
 
 
+Returns the vertical scrollbar :ref:`VScrollBar<class_VScrollBar>` of this ``ScrollContainer``.
+

+ 2 - 0
classes/class_sky.rst

@@ -85,3 +85,5 @@ The ``Sky``'s radiance map size. The higher the radiance map size, the more deta
 
 
 See :ref:`RadianceSize<enum_Sky_RadianceSize>` constants for values.
 See :ref:`RadianceSize<enum_Sky_RadianceSize>` constants for values.
 
 
+**Note:** Some hardware will have trouble with higher radiance sizes, especially :ref:`RADIANCE_SIZE_512<class_Sky_constant_RADIANCE_SIZE_512>` and above. Only use such high values on high-end hardware.
+

+ 3 - 1
classes/class_spatial.rst

@@ -525,7 +525,7 @@ Transforms ``global_point`` from world space to this node's local space.
 
 
 - void **translate** **(** :ref:`Vector3<class_Vector3>` offset **)**
 - void **translate** **(** :ref:`Vector3<class_Vector3>` offset **)**
 
 
-Changes the node's position by given offset :ref:`Vector3<class_Vector3>`.
+Changes the node's position by the given offset :ref:`Vector3<class_Vector3>`.
 
 
 Note that the translation ``offset`` is affected by the node's scale, so if scaled by e.g. ``(10, 1, 1)``, a translation by an offset of ``(2, 0, 0)`` would actually add 20 (``2 * 10``) to the X coordinate.
 Note that the translation ``offset`` is affected by the node's scale, so if scaled by e.g. ``(10, 1, 1)``, a translation by an offset of ``(2, 0, 0)`` would actually add 20 (``2 * 10``) to the X coordinate.
 
 
@@ -535,6 +535,8 @@ Note that the translation ``offset`` is affected by the node's scale, so if scal
 
 
 - void **translate_object_local** **(** :ref:`Vector3<class_Vector3>` offset **)**
 - void **translate_object_local** **(** :ref:`Vector3<class_Vector3>` offset **)**
 
 
+Changes the node's position by the given offset :ref:`Vector3<class_Vector3>` in local space.
+
 ----
 ----
 
 
 .. _class_Spatial_method_update_gizmo:
 .. _class_Spatial_method_update_gizmo:

+ 1 - 3
classes/class_staticbody.rst

@@ -18,9 +18,7 @@ Description
 
 
 Static body for 3D physics. A static body is a simple body that is not intended to move. In contrast to :ref:`RigidBody<class_RigidBody>`, they don't consume any CPU resources as long as they don't move.
 Static body for 3D physics. A static body is a simple body that is not intended to move. In contrast to :ref:`RigidBody<class_RigidBody>`, they don't consume any CPU resources as long as they don't move.
 
 
-A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active, the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies.
-
-Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
+Additionally, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
 
 
 Properties
 Properties
 ----------
 ----------

+ 3 - 1
classes/class_styleboxflat.rst

@@ -280,7 +280,9 @@ Border width for the top border.
 
 
 This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius (:ref:`set_corner_radius_all<class_StyleBoxFlat_method_set_corner_radius_all>`) into account.
 This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius (:ref:`set_corner_radius_all<class_StyleBoxFlat_method_set_corner_radius_all>`) into account.
 
 
-For corner radii smaller than 10, 4-5 should be enough. For corner radii smaller than 30, 8-12 should be enough.
+For corner radii smaller than 10, ``4`` or ``5`` should be enough. For corner radii smaller than 30, values between ``8`` and ``12`` should be enough.
+
+A corner detail of ``1`` will result in chamfered corners instead of rounded corners, which is useful for some artistic effects.
 
 
 ----
 ----
 
 

+ 4 - 0
classes/class_surfacetool.rst

@@ -214,6 +214,8 @@ Default flag is :ref:`Mesh.ARRAY_COMPRESS_DEFAULT<class_Mesh_constant_ARRAY_COMP
 
 
 - :ref:`Array<class_Array>` **commit_to_arrays** **(** **)**
 - :ref:`Array<class_Array>` **commit_to_arrays** **(** **)**
 
 
+Commits the data to the same format used by :ref:`ArrayMesh.add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`. This way you can further process the mesh data using the :ref:`ArrayMesh<class_ArrayMesh>` API.
+
 ----
 ----
 
 
 .. _class_SurfaceTool_method_create_from:
 .. _class_SurfaceTool_method_create_from:
@@ -228,6 +230,8 @@ Creates a vertex array from an existing :ref:`Mesh<class_Mesh>`.
 
 
 - void **create_from_blend_shape** **(** :ref:`Mesh<class_Mesh>` existing, :ref:`int<class_int>` surface, :ref:`String<class_String>` blend_shape **)**
 - void **create_from_blend_shape** **(** :ref:`Mesh<class_Mesh>` existing, :ref:`int<class_int>` surface, :ref:`String<class_String>` blend_shape **)**
 
 
+Creates a vertex array from the specified blend shape of an existing :ref:`Mesh<class_Mesh>`. This can be used to extract a specific pose from a blend shape.
+
 ----
 ----
 
 
 .. _class_SurfaceTool_method_deindex:
 .. _class_SurfaceTool_method_deindex:

+ 13 - 1
classes/class_texture.rst

@@ -22,6 +22,8 @@ A texture works by registering an image in the video hardware, which then can be
 
 
 Textures are often created by loading them from a file. See :ref:`@GDScript.load<class_@GDScript_method_load>`.
 Textures are often created by loading them from a file. See :ref:`@GDScript.load<class_@GDScript_method_load>`.
 
 
+``Texture`` is a base for other resources. It cannot be used directly.
+
 Properties
 Properties
 ----------
 ----------
 
 
@@ -106,7 +108,7 @@ Property Descriptions
 | *Getter*  | get_flags()      |
 | *Getter*  | get_flags()      |
 +-----------+------------------+
 +-----------+------------------+
 
 
-The texture's flags.
+The texture's :ref:`Flags<enum_Texture_Flags>`. :ref:`Flags<enum_Texture_Flags>` are used to set various properties of the ``Texture``.
 
 
 Method Descriptions
 Method Descriptions
 -------------------
 -------------------
@@ -115,24 +117,32 @@ Method Descriptions
 
 
 - void **draw** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** const
 - void **draw** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** const
 
 
+Draws the texture using a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`VisualServer<class_VisualServer>` API at the specified ``position``. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect<class_VisualServer_method_canvas_item_add_texture_rect>` with a rect at ``position`` and the size of this ``Texture``.
+
 ----
 ----
 
 
 .. _class_Texture_method_draw_rect:
 .. _class_Texture_method_draw_rect:
 
 
 - void **draw_rect** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** const
 - void **draw_rect** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null **)** const
 
 
+Draws the texture using a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`VisualServer<class_VisualServer>` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect<class_VisualServer_method_canvas_item_add_texture_rect>`.
+
 ----
 ----
 
 
 .. _class_Texture_method_draw_rect_region:
 .. _class_Texture_method_draw_rect_region:
 
 
 - void **draw_rect_region** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** const
 - void **draw_rect_region** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_Texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** const
 
 
+Draws a part of the texture using a :ref:`CanvasItem<class_CanvasItem>` with the :ref:`VisualServer<class_VisualServer>` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect_region<class_VisualServer_method_canvas_item_add_texture_rect_region>`.
+
 ----
 ----
 
 
 .. _class_Texture_method_get_data:
 .. _class_Texture_method_get_data:
 
 
 - :ref:`Image<class_Image>` **get_data** **(** **)** const
 - :ref:`Image<class_Image>` **get_data** **(** **)** const
 
 
+Returns an :ref:`Image<class_Image>` with the data from this ``Texture``. :ref:`Image<class_Image>`\ s can be accessed and manipulated directly.
+
 ----
 ----
 
 
 .. _class_Texture_method_get_height:
 .. _class_Texture_method_get_height:
@@ -163,3 +173,5 @@ Returns the texture width.
 
 
 - :ref:`bool<class_bool>` **has_alpha** **(** **)** const
 - :ref:`bool<class_bool>` **has_alpha** **(** **)** const
 
 
+Returns ``true`` if this ``Texture`` has an alpha channel.
+

+ 5 - 0
classes/class_texturearray.rst

@@ -11,5 +11,10 @@ TextureArray
 
 
 **Inherits:** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+Array of textures stored in a single primitive.
 
 
+Description
+-----------
+
+``TextureArray``\ s store an array of images in a single :ref:`Texture<class_Texture>` primitive. Each layer of the texture array has its own mipmap chain. This makes it is a good alternative to texture atlases.
 
 

+ 5 - 0
classes/class_texturelayered.rst

@@ -13,7 +13,12 @@ TextureLayered
 
 
 **Inherited By:** :ref:`Texture3D<class_Texture3D>`, :ref:`TextureArray<class_TextureArray>`
 **Inherited By:** :ref:`Texture3D<class_Texture3D>`, :ref:`TextureArray<class_TextureArray>`
 
 
+Base class for 3D texture types.
 
 
+Description
+-----------
+
+Base class for :ref:`Texture3D<class_Texture3D>` and :ref:`TextureArray<class_TextureArray>`. Cannot be used directly.
 
 
 Properties
 Properties
 ----------
 ----------

+ 4 - 2
classes/class_videoplayer.rst

@@ -16,7 +16,9 @@ Control for playing video streams.
 Description
 Description
 -----------
 -----------
 
 
-Control node for playing video streams. Supported formats are `WebM <https://www.webmproject.org/>`_ and `Ogg Theora <https://www.theora.org/>`_.
+Control node for playing video streams using :ref:`VideoStream<class_VideoStream>` resources.
+
+Supported video formats are `WebM <https://www.webmproject.org/>`_ (:ref:`VideoStreamWebm<class_VideoStreamWebm>`), `Ogg Theora <https://www.theora.org/>`_ (:ref:`VideoStreamTheora<class_VideoStreamTheora>`), and any format exposed via a GDNative plugin using :ref:`VideoStreamGDNative<class_VideoStreamGDNative>`.
 
 
 Properties
 Properties
 ----------
 ----------
@@ -146,7 +148,7 @@ Audio bus to use for sound playback.
 | *Getter*  | has_expand()      |
 | *Getter*  | has_expand()      |
 +-----------+-------------------+
 +-----------+-------------------+
 
 
-If ``true``, the video scales to the control size.
+If ``true``, the video scales to the control size. Otherwise, the control minimum size will be automatically adjusted to match the video stream's dimensions.
 
 
 ----
 ----
 
 

+ 5 - 0
classes/class_videostream.rst

@@ -15,3 +15,8 @@ VideoStream
 
 
 Base resource for video streams.
 Base resource for video streams.
 
 
+Description
+-----------
+
+Base resource type for all video streams. Classes that derive from ``VideoStream`` can all be used as resource types to play back videos in :ref:`VideoPlayer<class_VideoPlayer>`.
+

+ 11 - 0
classes/class_videostreamgdnative.rst

@@ -11,7 +11,14 @@ VideoStreamGDNative
 
 
 **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+:ref:`VideoStream<class_VideoStream>` resource for for video formats implemented via GDNative.
 
 
+Description
+-----------
+
+:ref:`VideoStream<class_VideoStream>` resource for for video formats implemented via GDNative.
+
+It can be used via `godot-videodecoder <https://github.com/KidRigger/godot-videodecoder>`_ which uses the `FFmpeg <https://ffmpeg.org>`_ library.
 
 
 Methods
 Methods
 -------
 -------
@@ -29,9 +36,13 @@ Method Descriptions
 
 
 - :ref:`String<class_String>` **get_file** **(** **)**
 - :ref:`String<class_String>` **get_file** **(** **)**
 
 
+Returns the video file handled by this ``VideoStreamGDNative``.
+
 ----
 ----
 
 
 .. _class_VideoStreamGDNative_method_set_file:
 .. _class_VideoStreamGDNative_method_set_file:
 
 
 - void **set_file** **(** :ref:`String<class_String>` file **)**
 - void **set_file** **(** :ref:`String<class_String>` file **)**
 
 
+Sets the video file that this ``VideoStreamGDNative`` resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
+

+ 9 - 0
classes/class_videostreamtheora.rst

@@ -11,7 +11,12 @@ VideoStreamTheora
 
 
 **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+:ref:`VideoStream<class_VideoStream>` resource for Ogg Theora videos.
 
 
+Description
+-----------
+
+:ref:`VideoStream<class_VideoStream>` resource handling the `Ogg Theora <https://www.theora.org/>`_ video format with ``.ogv`` extension.
 
 
 Methods
 Methods
 -------
 -------
@@ -29,9 +34,13 @@ Method Descriptions
 
 
 - :ref:`String<class_String>` **get_file** **(** **)**
 - :ref:`String<class_String>` **get_file** **(** **)**
 
 
+Returns the Ogg Theora video file handled by this ``VideoStreamTheora``.
+
 ----
 ----
 
 
 .. _class_VideoStreamTheora_method_set_file:
 .. _class_VideoStreamTheora_method_set_file:
 
 
 - void **set_file** **(** :ref:`String<class_String>` file **)**
 - void **set_file** **(** :ref:`String<class_String>` file **)**
 
 
+Sets the Ogg Theora video file that this ``VideoStreamTheora`` resource handles. The ``file`` name should have the ``.o`` extension.
+

+ 9 - 0
classes/class_videostreamwebm.rst

@@ -11,7 +11,12 @@ VideoStreamWebm
 
 
 **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
 
+:ref:`VideoStream<class_VideoStream>` resource for WebM videos.
 
 
+Description
+-----------
+
+:ref:`VideoStream<class_VideoStream>` resource handling the `WebM <https://www.webmproject.org/>`_ video format with ``.webm`` extension.
 
 
 Methods
 Methods
 -------
 -------
@@ -29,9 +34,13 @@ Method Descriptions
 
 
 - :ref:`String<class_String>` **get_file** **(** **)**
 - :ref:`String<class_String>` **get_file** **(** **)**
 
 
+Returns the WebM video file handled by this ``VideoStreamWebm``.
+
 ----
 ----
 
 
 .. _class_VideoStreamWebm_method_set_file:
 .. _class_VideoStreamWebm_method_set_file:
 
 
 - void **set_file** **(** :ref:`String<class_String>` file **)**
 - void **set_file** **(** :ref:`String<class_String>` file **)**
 
 
+Sets the WebM video file that this ``VideoStreamWebm`` resource handles. The ``file`` name should have the ``.webm`` extension.
+

+ 29 - 21
classes/class_viewport.rst

@@ -217,19 +217,19 @@ enum **UpdateMode**:
 
 
 enum **ShadowAtlasQuadrantSubdiv**:
 enum **ShadowAtlasQuadrantSubdiv**:
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0** --- This quadrant will not be used.
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = **1**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = **1** --- This quadrant will only be used by one shadow map.
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_4** = **2**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_4** = **2** --- This quadrant will be split in 4 and used by up to 4 shadow maps.
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_16** = **3**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_16** = **3** --- This quadrant will be split 16 ways and used by up to 16 shadow maps.
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = **4**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = **4** --- This quadrant will be split 64 ways and used by up to 64 shadow maps.
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5** --- This quadrant will be split 256 ways and used by up to 256 shadow maps. Unless the :ref:`shadow_atlas_size<class_Viewport_property_shadow_atlas_size>` is very high, the shadows in this quadrant will be very low resolution.
 
 
-- **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6**
+- **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6** --- This quadrant will be split 1024 ways and used by up to 1024 shadow maps. Unless the :ref:`shadow_atlas_size<class_Viewport_property_shadow_atlas_size>` is very high, the shadows in this quadrant will be very low resolution.
 
 
 - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** --- Represents the size of the :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` enum.
 - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** --- Represents the size of the :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` enum.
 
 
@@ -307,13 +307,13 @@ enum **MSAA**:
 
 
 - **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value.
 - **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value.
 
 
-- **MSAA_2X** = **1**
+- **MSAA_2X** = **1** --- Use 2x Multisample Antialiasing.
 
 
-- **MSAA_4X** = **2**
+- **MSAA_4X** = **2** --- Use 4x Multisample Antialiasing.
 
 
-- **MSAA_8X** = **3**
+- **MSAA_8X** = **3** --- Use 8x Multisample Antialiasing. Likely unsupported on low-end and older hardware.
 
 
-- **MSAA_16X** = **4**
+- **MSAA_16X** = **4** --- Use 16x Multisample Antialiasing. Likely unsupported on medium and low-end hardware.
 
 
 ----
 ----
 
 
@@ -329,13 +329,13 @@ enum **MSAA**:
 
 
 enum **Usage**:
 enum **Usage**:
 
 
-- **USAGE_2D** = **0**
+- **USAGE_2D** = **0** --- Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes.
 
 
-- **USAGE_2D_NO_SAMPLING** = **1**
+- **USAGE_2D_NO_SAMPLING** = **1** --- Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the :ref:`Usage<enum_Viewport_Usage>` types, this requires the least VRAM.
 
 
-- **USAGE_3D** = **2**
+- **USAGE_3D** = **2** --- Allocates full buffers for drawing 3D scenes and all 3D effects including buffers needed for 2D scenes and effects.
 
 
-- **USAGE_3D_NO_EFFECTS** = **3**
+- **USAGE_3D_NO_EFFECTS** = **3** --- Allocates buffers needed for drawing 3D scenes. But does not allocate buffers needed for reading from the screen and post-processing effects. Saves some VRAM.
 
 
 ----
 ----
 
 
@@ -524,7 +524,7 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly.
 | *Getter*  | get_hdr()      |
 | *Getter*  | get_hdr()      |
 +-----------+----------------+
 +-----------+----------------+
 
 
-If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm.
+If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. High Dynamic Range allows the viewport to receive values that are outside the 0-1 range. In Godot HDR uses 16 bits, meaning it does not store the full range of a floating point number.
 
 
 ----
 ----
 
 
@@ -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.
+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.
 
 
 ----
 ----
 
 
@@ -668,7 +668,7 @@ If ``true``, the result of rendering will be flipped vertically.
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 +-----------+-----------------------------------------+
 +-----------+-----------------------------------------+
 
 
-The subdivision amount of first quadrant on shadow atlas.
+The subdivision amount of the first quadrant on the shadow atlas.
 
 
 ----
 ----
 
 
@@ -684,7 +684,7 @@ The subdivision amount of first quadrant on shadow atlas.
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 +-----------+-----------------------------------------+
 +-----------+-----------------------------------------+
 
 
-The subdivision amount of second quadrant on shadow atlas.
+The subdivision amount of the second quadrant on the shadow atlas.
 
 
 ----
 ----
 
 
@@ -700,7 +700,7 @@ The subdivision amount of second quadrant on shadow atlas.
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 +-----------+-----------------------------------------+
 +-----------+-----------------------------------------+
 
 
-The subdivision amount of third quadrant on shadow atlas.
+The subdivision amount of the third quadrant on the shadow atlas.
 
 
 ----
 ----
 
 
@@ -716,7 +716,7 @@ The subdivision amount of third quadrant on shadow atlas.
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 | *Getter*  | get_shadow_atlas_quadrant_subdiv()      |
 +-----------+-----------------------------------------+
 +-----------+-----------------------------------------+
 
 
-The subdivision amount of fourth quadrant on shadow atlas.
+The subdivision amount of the fourth quadrant on the shadow atlas.
 
 
 ----
 ----
 
 
@@ -891,6 +891,8 @@ Returns information about the viewport from the rendering pipeline.
 
 
 - :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int<class_int>` quadrant **)** const
 - :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int<class_int>` quadrant **)** const
 
 
+Returns the :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` of the specified quadrant.
+
 ----
 ----
 
 
 .. _class_Viewport_method_get_size_override:
 .. _class_Viewport_method_get_size_override:
@@ -980,18 +982,24 @@ Returns ``true`` if the size override is enabled. See :ref:`set_size_override<cl
 
 
 - void **set_attach_to_screen_rect** **(** :ref:`Rect2<class_Rect2>` rect **)**
 - void **set_attach_to_screen_rect** **(** :ref:`Rect2<class_Rect2>` rect **)**
 
 
+Attaches this ``Viewport`` to the root ``Viewport`` with the specified rectangle. This bypasses the need for another node to display this ``Viewport`` but makes you responsible for updating the position of this ``Viewport`` manually.
+
 ----
 ----
 
 
 .. _class_Viewport_method_set_input_as_handled:
 .. _class_Viewport_method_set_input_as_handled:
 
 
 - void **set_input_as_handled** **(** **)**
 - void **set_input_as_handled** **(** **)**
 
 
+Stops the input from propagating further down the :ref:`SceneTree<class_SceneTree>`.
+
 ----
 ----
 
 
 .. _class_Viewport_method_set_shadow_atlas_quadrant_subdiv:
 .. _class_Viewport_method_set_shadow_atlas_quadrant_subdiv:
 
 
 - void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int<class_int>` quadrant, :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` subdiv **)**
 - void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int<class_int>` quadrant, :ref:`ShadowAtlasQuadrantSubdiv<enum_Viewport_ShadowAtlasQuadrantSubdiv>` subdiv **)**
 
 
+Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible.
+
 ----
 ----
 
 
 .. _class_Viewport_method_set_size_override:
 .. _class_Viewport_method_set_size_override:

+ 1 - 1
classes/class_visualserver.rst

@@ -4696,7 +4696,7 @@ Sets a viewport's canvas.
 
 
 - void **viewport_attach_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2( 0, 0, 0, 0 ), :ref:`int<class_int>` screen=0 **)**
 - void **viewport_attach_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2( 0, 0, 0, 0 ), :ref:`int<class_int>` screen=0 **)**
 
 
-Copies viewport to a region of the screen specified by ``rect``. If Viewport.:ref:`Viewport.render_direct_to_screen<class_Viewport_property_render_direct_to_screen>` is ``true``, then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
+Copies viewport to a region of the screen specified by ``rect``. If :ref:`Viewport.render_direct_to_screen<class_Viewport_property_render_direct_to_screen>` is ``true``, then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
 
 
 For example, you can set the root viewport to not render at all with the following code:
 For example, you can set the root viewport to not render at all with the following code:
 
 

Some files were not shown because too many files changed in this diff