From 9e8981ae4f49698d193202d9ec91c0a77adb3b4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 27 Jan 2020 08:12:58 +0100 Subject: [PATCH] Sync classref with current source --- classes/class_@gdscript.rst | 6 +- classes/class_@globalscope.rst | 2 +- classes/class_canvaslayer.rst | 4 + classes/class_color.rst | 294 +++++++++--------- classes/class_cpuparticles.rst | 6 + classes/class_cpuparticles2d.rst | 6 + classes/class_editorinspectorplugin.rst | 2 +- classes/class_editorproperty.rst | 4 +- classes/class_gdscriptfunctionstate.rst | 2 +- classes/class_geometry.rst | 2 + classes/class_input.rst | 4 + classes/class_inputeventkey.rst | 8 +- classes/class_nil.rst | 177 ----------- classes/class_noisetexture.rst | 10 + classes/class_os.rst | 2 + classes/class_particlesmaterial.rst | 16 + classes/class_plane.rst | 6 +- classes/class_proceduralsky.rst | 10 +- classes/class_projectsettings.rst | 384 +++++++++++++++++++++++- classes/class_quat.rst | 2 +- classes/class_richtextlabel.rst | 6 +- classes/class_scenetree.rst | 2 +- classes/class_scrollcontainer.rst | 4 + classes/class_sky.rst | 2 + classes/class_spatial.rst | 4 +- classes/class_staticbody.rst | 4 +- classes/class_styleboxflat.rst | 4 +- classes/class_surfacetool.rst | 4 + classes/class_texture.rst | 14 +- classes/class_texturearray.rst | 5 + classes/class_texturelayered.rst | 5 + classes/class_videoplayer.rst | 6 +- classes/class_videostream.rst | 5 + classes/class_videostreamgdnative.rst | 11 + classes/class_videostreamtheora.rst | 9 + classes/class_videostreamwebm.rst | 9 + classes/class_viewport.rst | 50 +-- classes/class_visualserver.rst | 2 +- 38 files changed, 708 insertions(+), 385 deletions(-) delete mode 100644 classes/class_nil.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index bef8d88f9..7d16ca34a 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -255,15 +255,13 @@ Returns a color constructed from integer red, green, blue, and alpha channels. E - :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`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) -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`. ---- diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index b468f6b75..78dfa9064 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -2033,7 +2033,7 @@ enum **MethodFlags**: enum **Variant.Type**: -- **TYPE_NIL** = **0** --- Variable is of type :ref:`Nil` (only applied for ``null``). +- **TYPE_NIL** = **0** --- Variable is ``null``. - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool`. diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index a131f3a85..fff1109e3 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -86,6 +86,8 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. | *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: @@ -100,6 +102,8 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. | *Getter* | get_follow_viewport_scale() | +-----------+----------------------------------+ +Scales the layer when using :ref:`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: diff --git a/classes/class_color.rst b/classes/class_color.rst index 69e2f0aa2..50a96fc8d 100644 --- a/classes/class_color.rst +++ b/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`) may accept values greater than 1. -You can also create a color from standardized color names by using :ref:`@GDScript.ColorN`. +You can also create a color from standardized color names by using :ref:`@GDScript.ColorN` or directly using the color constants defined here. The standardized color set is based on the `X11 color names `_. Properties ---------- @@ -385,297 +385,297 @@ Constants .. _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 --------------------- diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index a83037be8..5a59ab007 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -644,6 +644,8 @@ The rectangle's extents if :ref:`emission_shape`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. + ---- .. _class_CPUParticles_property_emission_normals: @@ -656,6 +658,8 @@ The rectangle's extents if :ref:`emission_shape`. + ---- .. _class_CPUParticles_property_emission_points: @@ -670,6 +674,8 @@ The rectangle's extents if :ref:`emission_shape` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. + ---- .. _class_CPUParticles_property_emission_shape: diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 5250f4349..036a9496b 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -625,6 +625,8 @@ Particle draw order. Uses :ref:`DrawOrder` values | *Getter* | get_emission_colors() | +----------+----------------------------+ +Sets the :ref:`Color`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. + ---- .. _class_CPUParticles2D_property_emission_normals: @@ -637,6 +639,8 @@ Particle draw order. Uses :ref:`DrawOrder` values | *Getter* | get_emission_normals() | +----------+-----------------------------+ +Sets the direction the particles will be emitted in when using :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. + ---- .. _class_CPUParticles2D_property_emission_points: @@ -649,6 +653,8 @@ Particle draw order. Uses :ref:`DrawOrder` values | *Getter* | get_emission_points() | +----------+----------------------------+ +Sets the initial positions to spawn particles when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. + ---- .. _class_CPUParticles2D_property_emission_rect_extents: diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index c47acedb1..c9d8ed2e8 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -114,5 +114,5 @@ Called to allow adding controls at the end of the list. - :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual -Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty`. +Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty`. Returning ``true`` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index e41916962..105a7b68a 100644 --- a/classes/class_editorproperty.rst +++ b/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: -- **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** +- **property_changed** **(** :ref:`String` property, :ref:`Variant` value **)** Do not emit this manually, use the :ref:`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: -- **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** +- **property_keyed_with_value** **(** :ref:`String` property, :ref:`Variant` value **)** Emit it if you want to key a property with a single value. diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 5a3fc04c0..85a6409fc 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -32,7 +32,7 @@ Signals .. _class_GDScriptFunctionState_signal_completed: -- **completed** **(** :ref:`Nil` result **)** +- **completed** **(** :ref:`Variant` result **)** Method Descriptions ------------------- diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 322d9eb93..19112b8d8 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -283,6 +283,8 @@ Given the two 2D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two - :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** +Used internally by the engine. + ---- .. _class_Geometry_method_intersect_polygons_2d: diff --git a/classes/class_input.rst b/classes/class_input.rst index b9d404476..7bd09e5a7 100644 --- a/classes/class_input.rst +++ b/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` device, :ref:`bool` connected, :ref:`String` name, :ref:`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` for the signal emitted when this is triggered internally. + ---- .. _class_Input_method_parse_input_event: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 167750cf1..fd6e42a95 100644 --- a/classes/class_inputeventkey.rst +++ b/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() | +-----------+---------------------+ -Key scancode, one of the :ref:`KeyList` constants. +The key scancode, which corresponds to one of the :ref:`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` constants. | *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` 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` for more information. Method Descriptions ------------------- @@ -117,3 +119,5 @@ Method Descriptions Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`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``. + diff --git a/classes/class_nil.rst b/classes/class_nil.rst deleted file mode 100644 index 5c2b10330..000000000 --- a/classes/class_nil.rst +++ /dev/null @@ -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//doc_classes. - -.. _class_Nil: - -Nil -=== - - - -Methods -------- - -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Array` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Object` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RID` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Color` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Basis` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`AABB` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Quat` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Plane` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`String` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`float` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`int` from **)** | -+------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`bool` from **)** | -+------+---------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_Nil_method_Nil: - -- void **Nil** **(** :ref:`PoolColorArray` from **)** - ----- - -- void **Nil** **(** :ref:`PoolVector3Array` from **)** - ----- - -- void **Nil** **(** :ref:`PoolVector2Array` from **)** - ----- - -- void **Nil** **(** :ref:`PoolStringArray` from **)** - ----- - -- void **Nil** **(** :ref:`PoolRealArray` from **)** - ----- - -- void **Nil** **(** :ref:`PoolIntArray` from **)** - ----- - -- void **Nil** **(** :ref:`PoolByteArray` from **)** - ----- - -- void **Nil** **(** :ref:`Array` from **)** - ----- - -- void **Nil** **(** :ref:`Dictionary` from **)** - ----- - -- void **Nil** **(** :ref:`Object` from **)** - ----- - -- void **Nil** **(** :ref:`RID` from **)** - ----- - -- void **Nil** **(** :ref:`NodePath` from **)** - ----- - -- void **Nil** **(** :ref:`Color` from **)** - ----- - -- void **Nil** **(** :ref:`Transform` from **)** - ----- - -- void **Nil** **(** :ref:`Basis` from **)** - ----- - -- void **Nil** **(** :ref:`AABB` from **)** - ----- - -- void **Nil** **(** :ref:`Quat` from **)** - ----- - -- void **Nil** **(** :ref:`Plane` from **)** - ----- - -- void **Nil** **(** :ref:`Transform2D` from **)** - ----- - -- void **Nil** **(** :ref:`Vector3` from **)** - ----- - -- void **Nil** **(** :ref:`Rect2` from **)** - ----- - -- void **Nil** **(** :ref:`Vector2` from **)** - ----- - -- void **Nil** **(** :ref:`String` from **)** - ----- - -- void **Nil** **(** :ref:`float` from **)** - ----- - -- void **Nil** **(** :ref:`int` from **)** - ----- - -- void **Nil** **(** :ref:`bool` from **)** - diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index 049d71aa8..e72f1807e 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -20,6 +20,14 @@ Uses an :ref:`OpenSimplexNoise` to fill the texture data NoiseTexture can also generate normalmap textures. +The class uses :ref:`Thread`\ s to generate the texture data internally, so :ref:`Texture.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 ---------- @@ -70,6 +78,8 @@ If ``true``, the resulting texture contains a normal map created from the origin | *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: diff --git a/classes/class_os.rst b/classes/class_os.rst index 65a94e4fb..e036068ae 100644 --- a/classes/class_os.rst +++ b/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"``). +See also :ref:`InputEventKey.scancode` and :ref:`InputEventKey.get_scancode_with_modifiers`. + ---- .. _class_OS_method_get_screen_count: diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index b9cd454bd..cf5f84469 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -1119,45 +1119,61 @@ Method Descriptions - :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** const +Returns ``true`` if the specified flag is enabled. + ---- .. _class_ParticlesMaterial_method_get_param: - :ref:`float` **get_param** **(** :ref:`Parameter` param **)** const +Returns the value of the specified parameter. + ---- .. _class_ParticlesMaterial_method_get_param_randomness: - :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** const +Returns the randomness ratio associated with the specified parameter. + ---- .. _class_ParticlesMaterial_method_get_param_texture: - :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** const +Returns the :ref:`Texture` used by the specified parameter. + ---- .. _class_ParticlesMaterial_method_set_flag: - void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +If ``true``, enables the specified flag. See :ref:`Flags` for options. + ---- .. _class_ParticlesMaterial_method_set_param: - void **set_param** **(** :ref:`Parameter` param, :ref:`float` value **)** +Sets the specified :ref:`Parameter`. + ---- .. _class_ParticlesMaterial_method_set_param_randomness: - void **set_param_randomness** **(** :ref:`Parameter` param, :ref:`float` randomness **)** +Sets the randomness ratio for the specified :ref:`Parameter`. + ---- .. _class_ParticlesMaterial_method_set_param_texture: - void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture` texture **)** +Sets the :ref:`Texture` for the specified :ref:`Parameter`. + diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 6e0f8362b..b80d1c1dd 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -78,11 +78,11 @@ Constants .. _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 --------------------- diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 23609c200..dd3061c12 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -76,15 +76,15 @@ Enumerations 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. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 256447fa5..ebf448f96 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -578,6 +578,8 @@ Properties +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | ``false`` | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/irradiance_max_size` | ``128`` | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | ``true`` | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | ``false`` | @@ -777,6 +779,8 @@ Icon used for the project, set when project loads. Exporters will also use this | *Default* | ``""`` | +-----------+--------+ +Icon set in ``.icns`` format used on macOS to set the game's icon. This is done automatically on start by calling :ref:`OS.set_native_icon`. + ---- .. _class_ProjectSettings_property_application/config/name: @@ -825,6 +829,8 @@ If ``true``, the project will save user data to its own user directory (see :ref | *Default* | ``""`` | +-----------+--------+ +Icon set in ``.ico`` format used on Windows to set the game's icon. This is done automatically on start by calling :ref:`OS.set_native_icon`. + ---- .. _class_ProjectSettings_property_application/run/disable_stderr: @@ -931,6 +937,8 @@ Audio buses will disable automatically when sound goes below a given dB threshol | *Default* | ``"res://default_bus_layout.tres"`` | +-----------+-------------------------------------+ +Default :ref:`AudioBusLayout` resource file to use in the project, unless overridden by the scene. + ---- .. _class_ProjectSettings_property_audio/driver: @@ -1049,6 +1057,8 @@ Enables long-distance matching in Zstandard. | *Default* | ``27`` | +-----------+--------+ +Largest size limit (in power of 2) allowed when compressing using long-distance matching with Zstandard. + ---- .. _class_ProjectSettings_property_debug/gdscript/completion/autocomplete_setters_and_getters: @@ -1443,6 +1453,12 @@ Message to be displayed before the backtrace when the engine crashes. | *Default* | ``0`` | +-----------+-------+ +Maximum number of frames per second allowed. The actual number of frames per second may still be below this value if the game is lagging. + +If :ref:`display/window/vsync/use_vsync` is enabled, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate. + +This setting is therefore mostly relevant for lowering the maximum FPS below VSync, e.g. to perform non real-time rendering of static frames, or test the project under lag conditions. + ---- .. _class_ProjectSettings_property_debug/settings/gdscript/max_call_stack: @@ -1513,6 +1529,8 @@ Maximum call stack in visual scripting, to avoid infinite recursion. | *Default* | ``Color( 1, 0.2, 0.1, 0.8 )`` | +-----------+-------------------------------+ +Color of the contact points between collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu. + ---- .. _class_ProjectSettings_property_debug/shapes/collision/max_contacts_displayed: @@ -1523,6 +1541,8 @@ Maximum call stack in visual scripting, to avoid infinite recursion. | *Default* | ``10000`` | +-----------+-----------+ +Maximum number of contact points between collision shapes to display when "Visible Collision Shapes" is enabled in the Debug menu. + ---- .. _class_ProjectSettings_property_debug/shapes/collision/shape_color: @@ -1533,6 +1553,8 @@ Maximum call stack in visual scripting, to avoid infinite recursion. | *Default* | ``Color( 0, 0.6, 0.7, 0.5 )`` | +-----------+-------------------------------+ +Color of the collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu. + ---- .. _class_ProjectSettings_property_debug/shapes/navigation/disabled_geometry_color: @@ -1543,6 +1565,8 @@ Maximum call stack in visual scripting, to avoid infinite recursion. | *Default* | ``Color( 1, 0.7, 0.1, 0.4 )`` | +-----------+-------------------------------+ +Color of the disabled navigation geometry, visible when "Visible Navigation" is enabled in the Debug menu. + ---- .. _class_ProjectSettings_property_debug/shapes/navigation/geometry_color: @@ -1553,6 +1577,8 @@ Maximum call stack in visual scripting, to avoid infinite recursion. | *Default* | ``Color( 0.1, 1, 0.7, 0.4 )`` | +-----------+-------------------------------+ +Color of the navigation geometry, visible when "Visible Navigation" is enabled in the Debug menu. + ---- .. _class_ProjectSettings_property_display/mouse_cursor/custom_image: @@ -1793,6 +1819,8 @@ If ``Use Vsync`` is enabled and this setting is ``true``, enables vertical synch | *Default* | ``"res://script_templates"`` | +-----------+------------------------------+ +Search path for project-specific script templates. Script templates will be search both in the editor-specific path and in this project-specific path. + ---- .. _class_ProjectSettings_property_editor/search_in_file_extensions: @@ -1803,6 +1831,8 @@ If ``Use Vsync`` is enabled and this setting is ``true``, enables vertical synch | *Default* | ``PoolStringArray( "gd", "shader" )`` | +-----------+---------------------------------------+ +Text-based file extensions to include in the script editor's "Find in Files" feature. You can add e.g. ``tscn`` if you wish to also parse your scene files, especially if you use built-in scripts which are serialized in the scene files. + ---- .. _class_ProjectSettings_property_gui/common/default_scroll_deadzone: @@ -1813,6 +1843,8 @@ If ``Use Vsync`` is enabled and this setting is ``true``, enables vertical synch | *Default* | ``0`` | +-----------+-------+ +Default value for :ref:`ScrollContainer.scroll_deadzone`, which will be used for all :ref:`ScrollContainer`\ s unless overridden. + ---- .. _class_ProjectSettings_property_gui/common/swap_ok_cancel: @@ -1835,7 +1867,7 @@ If ``true``, swaps OK and Cancel buttons in dialogs on Windows and UWP to follow | *Default* | ``""`` | +-----------+--------+ -Use a custom theme resource, set a path to it here. +Path to a custom :ref:`Theme` resource file to use for the project (``theme`` or generic ``tres``/``res`` extension). ---- @@ -1847,7 +1879,7 @@ Use a custom theme resource, set a path to it here. | *Default* | ``""`` | +-----------+--------+ -Use a custom default font resource, set a path to it here. +Path to a custom :ref:`Font` resource to use as default for all GUI elements of the project. ---- @@ -1871,7 +1903,7 @@ If ``true``, makes sure the theme used works with HiDPI. | *Default* | ``2000`` | +-----------+----------+ -Timer setting for incremental search in Tree, IntemList, etc. controls (in milliseconds). +Timer setting for incremental search in :ref:`Tree`, :ref:`ItemList`, etc. controls (in milliseconds). ---- @@ -1883,7 +1915,7 @@ Timer setting for incremental search in Tree, IntemList, etc. controls (in milli | *Default* | ``3`` | +-----------+-------+ -Timer for detecting idle in the editor (in seconds). +Timer for detecting idle in :ref:`TextEdit` (in seconds). ---- @@ -1895,84 +1927,138 @@ Timer for detecting idle in the editor (in seconds). | *Default* | ``0.5`` | +-----------+---------+ +Default delay for tooltips (in seconds). + ---- .. _class_ProjectSettings_property_input/ui_accept: - :ref:`Dictionary` **input/ui_accept** +Default :ref:`InputEventAction` to confirm a focused button, menu or list item, or validate input. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_cancel: - :ref:`Dictionary` **input/ui_cancel** +Default :ref:`InputEventAction` to discard a modal or pending input. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_down: - :ref:`Dictionary` **input/ui_down** +Default :ref:`InputEventAction` to move down in the UI. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_end: - :ref:`Dictionary` **input/ui_end** +Default :ref:`InputEventAction` to go to the end position of a :ref:`Control` (e.g. last item in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_END` on typical desktop UI systems. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_focus_next: - :ref:`Dictionary` **input/ui_focus_next** +Default :ref:`InputEventAction` to focus the next :ref:`Control` in the scene. The focus behavior can be configured via :ref:`Control.focus_next`. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_focus_prev: - :ref:`Dictionary` **input/ui_focus_prev** +Default :ref:`InputEventAction` to focus the previous :ref:`Control` in the scene. The focus behavior can be configured via :ref:`Control.focus_previous`. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_home: - :ref:`Dictionary` **input/ui_home** +Default :ref:`InputEventAction` to go to the start position of a :ref:`Control` (e.g. first item in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_HOME` on typical desktop UI systems. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_left: - :ref:`Dictionary` **input/ui_left** +Default :ref:`InputEventAction` to move left in the UI. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_page_down: - :ref:`Dictionary` **input/ui_page_down** +Default :ref:`InputEventAction` to go down a page in a :ref:`Control` (e.g. in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_PAGEDOWN` on typical desktop UI systems. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_page_up: - :ref:`Dictionary` **input/ui_page_up** +Default :ref:`InputEventAction` to go up a page in a :ref:`Control` (e.g. in an :ref:`ItemList` or a :ref:`Tree`), matching the behavior of :ref:`@GlobalScope.KEY_PAGEUP` on typical desktop UI systems. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_right: - :ref:`Dictionary` **input/ui_right** +Default :ref:`InputEventAction` to move right in the UI. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_select: - :ref:`Dictionary` **input/ui_select** +Default :ref:`InputEventAction` to select an item in a :ref:`Control` (e.g. in an :ref:`ItemList` or a :ref:`Tree`). + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input/ui_up: - :ref:`Dictionary` **input/ui_up** +Default :ref:`InputEventAction` to move up in the UI. + +**Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + ---- .. _class_ProjectSettings_property_input_devices/pointing/emulate_mouse_from_touch: @@ -2007,6 +2093,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 1. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_10: @@ -2017,6 +2105,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 10. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_11: @@ -2027,6 +2117,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 11. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_12: @@ -2037,6 +2129,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 12. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_13: @@ -2047,6 +2141,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 13. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_14: @@ -2057,6 +2153,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 14. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_15: @@ -2067,6 +2165,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 15. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_16: @@ -2077,6 +2177,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 16. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_17: @@ -2087,6 +2189,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 17. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_18: @@ -2097,6 +2201,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 18. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_19: @@ -2107,6 +2213,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 19. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_2: @@ -2117,6 +2225,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 2. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_20: @@ -2127,6 +2237,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 20. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_3: @@ -2137,6 +2249,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 3. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_4: @@ -2147,6 +2261,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 4. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_5: @@ -2157,6 +2273,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 5. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_6: @@ -2167,6 +2285,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 6. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_7: @@ -2177,6 +2297,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 7. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_8: @@ -2187,6 +2309,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 8. + ---- .. _class_ProjectSettings_property_layer_names/2d_physics/layer_9: @@ -2197,6 +2321,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D physics layer 9. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_1: @@ -2207,6 +2333,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 1. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_10: @@ -2217,6 +2345,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 10. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_11: @@ -2227,6 +2357,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 11. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_12: @@ -2237,6 +2369,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 12. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_13: @@ -2247,6 +2381,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 13. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_14: @@ -2257,6 +2393,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 14. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_15: @@ -2267,6 +2405,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 15. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_16: @@ -2277,6 +2417,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 16. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_17: @@ -2287,6 +2429,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 17. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_18: @@ -2297,6 +2441,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 18. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_19: @@ -2307,6 +2453,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 19. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_2: @@ -2317,6 +2465,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 2. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_20: @@ -2327,6 +2477,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 20. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_3: @@ -2337,6 +2489,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 3. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_4: @@ -2347,6 +2501,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 4. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_5: @@ -2357,6 +2513,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 5. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_6: @@ -2367,6 +2525,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 6. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_7: @@ -2377,6 +2537,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 7. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_8: @@ -2387,6 +2549,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 8. + ---- .. _class_ProjectSettings_property_layer_names/2d_render/layer_9: @@ -2397,6 +2561,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 2D render layer 9. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_1: @@ -2407,6 +2573,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 1. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_10: @@ -2417,6 +2585,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 10. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_11: @@ -2427,6 +2597,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 11. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_12: @@ -2437,6 +2609,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 12. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_13: @@ -2447,6 +2621,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 13. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_14: @@ -2457,6 +2633,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 14. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_15: @@ -2467,6 +2645,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 15. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_16: @@ -2477,6 +2657,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 16. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_17: @@ -2487,6 +2669,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 17. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_18: @@ -2497,6 +2681,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 18. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_19: @@ -2507,6 +2693,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 19. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_2: @@ -2517,6 +2705,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 2. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_20: @@ -2527,6 +2717,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 20. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_3: @@ -2537,6 +2729,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 3. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_4: @@ -2547,6 +2741,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 4. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_5: @@ -2557,6 +2753,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 5. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_6: @@ -2567,6 +2765,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 6. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_7: @@ -2577,6 +2777,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 7. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_8: @@ -2587,6 +2789,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 8. + ---- .. _class_ProjectSettings_property_layer_names/3d_physics/layer_9: @@ -2597,6 +2801,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D physics layer 9. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_1: @@ -2607,6 +2813,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 1. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_10: @@ -2617,6 +2825,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 10. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_11: @@ -2627,6 +2837,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 11. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_12: @@ -2637,6 +2849,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 12. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_13: @@ -2647,6 +2861,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 13. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_14: @@ -2657,6 +2873,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 14 + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_15: @@ -2667,6 +2885,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 15. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_16: @@ -2677,6 +2897,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 16. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_17: @@ -2687,6 +2909,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 17. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_18: @@ -2697,6 +2921,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 18. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_19: @@ -2707,6 +2933,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 19. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_2: @@ -2717,6 +2945,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 2. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_20: @@ -2727,6 +2957,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 20. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_3: @@ -2737,6 +2969,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 3. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_4: @@ -2747,6 +2981,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 4. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_5: @@ -2757,6 +2993,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 5. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_6: @@ -2767,6 +3005,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 6. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_7: @@ -2777,6 +3017,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 7. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_8: @@ -2787,6 +3029,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 8. + ---- .. _class_ProjectSettings_property_layer_names/3d_render/layer_9: @@ -2797,6 +3041,8 @@ If ``true``, sends touch input events when clicking or dragging the mouse. | *Default* | ``""`` | +-----------+--------+ +Optional name for the 3D render layer 9. + ---- .. _class_ProjectSettings_property_locale/fallback: @@ -2951,6 +3197,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``30`` | +-----------+--------+ +Timeout (in seconds) for connection attempts using TCP. + ---- .. _class_ProjectSettings_property_network/limits/webrtc/max_channel_in_buffer_kb: @@ -2961,6 +3209,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``64`` | +-----------+--------+ +Maximum size (in kiB) for the :ref:`WebRTCDataChannel` input buffer. + ---- .. _class_ProjectSettings_property_network/limits/websocket_client/max_in_buffer_kb: @@ -2971,6 +3221,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``64`` | +-----------+--------+ +Maximum size (in kiB) for the :ref:`WebSocketClient` input buffer. + ---- .. _class_ProjectSettings_property_network/limits/websocket_client/max_in_packets: @@ -2981,6 +3233,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``1024`` | +-----------+----------+ +Maximum number of concurrent input packets for :ref:`WebSocketClient`. + ---- .. _class_ProjectSettings_property_network/limits/websocket_client/max_out_buffer_kb: @@ -2991,6 +3245,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``64`` | +-----------+--------+ +Maximum size (in kiB) for the :ref:`WebSocketClient` output buffer. + ---- .. _class_ProjectSettings_property_network/limits/websocket_client/max_out_packets: @@ -3001,6 +3257,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``1024`` | +-----------+----------+ +Maximum number of concurrent output packets for :ref:`WebSocketClient`. + ---- .. _class_ProjectSettings_property_network/limits/websocket_server/max_in_buffer_kb: @@ -3011,6 +3269,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``64`` | +-----------+--------+ +Maximum size (in kiB) for the :ref:`WebSocketServer` input buffer. + ---- .. _class_ProjectSettings_property_network/limits/websocket_server/max_in_packets: @@ -3021,6 +3281,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``1024`` | +-----------+----------+ +Maximum number of concurrent input packets for :ref:`WebSocketServer`. + ---- .. _class_ProjectSettings_property_network/limits/websocket_server/max_out_buffer_kb: @@ -3031,6 +3293,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``64`` | +-----------+--------+ +Maximum size (in kiB) for the :ref:`WebSocketServer` output buffer. + ---- .. _class_ProjectSettings_property_network/limits/websocket_server/max_out_packets: @@ -3041,6 +3305,8 @@ Default size of packet peer stream for deserializing Godot data. Over this size, | *Default* | ``1024`` | +-----------+----------+ +Maximum number of concurrent output packets for :ref:`WebSocketServer`. + ---- .. _class_ProjectSettings_property_network/remote_fs/page_read_ahead: @@ -3075,6 +3341,8 @@ Page size used by remote filesystem (in bytes). | *Default* | ``""`` | +-----------+--------+ +CA certificates bundle to use for SSL connections. If not defined, Godot's internal CA certificates are used. + ---- .. _class_ProjectSettings_property_node/name_casing: @@ -3109,6 +3377,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``4096`` | +-----------+----------+ +Size of the hash table used for the broad-phase 2D hash grid algorithm. + ---- .. _class_ProjectSettings_property_physics/2d/cell_size: @@ -3119,6 +3389,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``128`` | +-----------+---------+ +Cell size used for the broad-phase 2D hash grid algorithm. + ---- .. _class_ProjectSettings_property_physics/2d/default_angular_damp: @@ -3129,6 +3401,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``1.0`` | +-----------+---------+ +The default angular damp in 2D. + ---- .. _class_ProjectSettings_property_physics/2d/default_gravity: @@ -3139,6 +3413,15 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``98`` | +-----------+--------+ +The default gravity strength in 2D. + +**Note:** This property is only read when the project starts. To change the default gravity at runtime, use the following code sample: + +:: + + # Set the default gravity strength to 98. + Physics2DServer.area_set_param(get_viewport().find_world_2d().get_space(), Physics2DServer.AREA_PARAM_GRAVITY, 98) + ---- .. _class_ProjectSettings_property_physics/2d/default_gravity_vector: @@ -3149,6 +3432,15 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``Vector2( 0, 1 )`` | +-----------+---------------------+ +The default gravity direction in 2D. + +**Note:** This property is only read when the project starts. To change the default gravity vector at runtime, use the following code sample: + +:: + + # Set the default gravity direction to `Vector2(0, 1)`. + Physics2DServer.area_set_param(get_viewport().find_world_2d().get_space(), Physics2DServer.AREA_PARAM_GRAVITY_VECTOR, Vector2(0, 1)) + ---- .. _class_ProjectSettings_property_physics/2d/default_linear_damp: @@ -3159,6 +3451,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``0.1`` | +-----------+---------+ +The default linear damp in 2D. + ---- .. _class_ProjectSettings_property_physics/2d/large_object_surface_threshold_in_cells: @@ -3169,6 +3463,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``512`` | +-----------+---------+ +Threshold defining the surface size that constitutes a large object with regard to cells in the broad-phase 2D hash grid algorithm. + ---- .. _class_ProjectSettings_property_physics/2d/physics_engine: @@ -3179,6 +3475,10 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``"DEFAULT"`` | +-----------+---------------+ +Sets which physics engine to use for 2D physics. + +"DEFAULT" and "GodotPhysics" are the same, as there is currently no alternative 2D physics server implemented. + ---- .. _class_ProjectSettings_property_physics/2d/sleep_threshold_angular: @@ -3189,6 +3489,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``0.139626`` | +-----------+--------------+ +Threshold angular velocity under which a 2D physics body will be considered inactive. See :ref:`Physics2DServer.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD`. + ---- .. _class_ProjectSettings_property_physics/2d/sleep_threshold_linear: @@ -3199,6 +3501,8 @@ What to use to separate node name from number. This is mostly an editor setting. | *Default* | ``2.0`` | +-----------+---------+ +Threshold linear velocity under which a 2D physics body will be considered inactive. See :ref:`Physics2DServer.SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD`. + ---- .. _class_ProjectSettings_property_physics/2d/thread_model: @@ -3211,6 +3515,8 @@ What to use to separate node name from number. This is mostly an editor setting. Sets whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. +**Warning:** As of Godot 3.2, there are mixed reports about the use of a Multi-Threaded thread model for physics. Be sure to assess whether it does give you extra performance and no regressions when using it. + ---- .. _class_ProjectSettings_property_physics/2d/time_before_sleep: @@ -3221,6 +3527,8 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``0.5`` | +-----------+---------+ +Time (in seconds) of inactivity before which a 2D physics body will put to sleep. See :ref:`Physics2DServer.SPACE_PARAM_BODY_TIME_TO_SLEEP`. + ---- .. _class_ProjectSettings_property_physics/3d/active_soft_world: @@ -3231,6 +3539,8 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``true`` | +-----------+----------+ +Sets whether the 3D physics world will be created with support for :ref:`SoftBody` physics. Only applies to the Bullet physics engine. + ---- .. _class_ProjectSettings_property_physics/3d/default_angular_damp: @@ -3241,6 +3551,8 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``0.1`` | +-----------+---------+ +The default angular damp in 3D. + ---- .. _class_ProjectSettings_property_physics/3d/default_gravity: @@ -3251,6 +3563,15 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``9.8`` | +-----------+---------+ +The default gravity strength in 3D. + +**Note:** This property is only read when the project starts. To change the default gravity at runtime, use the following code sample: + +:: + + # Set the default gravity strength to 9.8. + PhysicsServer.area_set_param(get_viewport().find_world().get_space(), PhysicsServer.AREA_PARAM_GRAVITY, 9.8) + ---- .. _class_ProjectSettings_property_physics/3d/default_gravity_vector: @@ -3261,6 +3582,15 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``Vector3( 0, -1, 0 )`` | +-----------+-------------------------+ +The default gravity direction in 3D. + +**Note:** This property is only read when the project starts. To change the default gravity vector at runtime, use the following code sample: + +:: + + # Set the default gravity direction to `Vector3(0, -1, 0)`. + PhysicsServer.area_set_param(get_viewport().find_world().get_space(), PhysicsServer.AREA_PARAM_GRAVITY_VECTOR, Vector3(0, -1, 0)) + ---- .. _class_ProjectSettings_property_physics/3d/default_linear_damp: @@ -3271,6 +3601,8 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``0.1`` | +-----------+---------+ +The default linear damp in 3D. + ---- .. _class_ProjectSettings_property_physics/3d/physics_engine: @@ -3281,7 +3613,9 @@ Sets whether physics is run on the main thread or a separate one. Running the se | *Default* | ``"DEFAULT"`` | +-----------+---------------+ -Sets which physics engine to use. +Sets which physics engine to use for 3D physics. + +"DEFAULT" is currently the `Bullet `_ physics engine. The "GodotPhysics" engine is still supported as an alternative. ---- @@ -3293,6 +3627,8 @@ Sets which physics engine to use. | *Default* | ``true`` | +-----------+----------+ +Enables :ref:`Viewport.physics_object_picking` on the root viewport. + ---- .. _class_ProjectSettings_property_physics/common/physics_fps: @@ -3487,6 +3823,8 @@ If ``true``, allocates the main framebuffer with high dynamic range. High dynami | *Default* | ``false`` | +-----------+-----------+ +Lower-end override for :ref:`rendering/quality/depth/hdr` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/depth_prepass/disable_for_vendors: @@ -3533,6 +3871,8 @@ The directional shadow's size in pixels. Higher values will result in sharper sh | *Default* | ``2048`` | +-----------+----------+ +Lower-end override for :ref:`rendering/quality/directional_shadow/size` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/driver/driver_name: @@ -3621,7 +3961,7 @@ Strategy used for framebuffer allocation. The simpler it is, the less resources | *Default* | ``3`` | +-----------+-------+ -Same as :ref:`rendering/quality/intended_usage/framebuffer_allocation` but for mobile defaults to "3D Without Effects". If effects are desired, set to "3D". +Lower-end override for :ref:`rendering/quality/intended_usage/framebuffer_allocation` on mobile devices, due to performance concerns or driver support. ---- @@ -3669,6 +4009,22 @@ If ``true``, uses a high amount of samples to create blurred variants of reflect | *Default* | ``false`` | +-----------+-----------+ +Lower-end override for :ref:`rendering/quality/reflections/high_quality_ggx` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/quality/reflections/irradiance_max_size: + +- :ref:`int` **rendering/quality/reflections/irradiance_max_size** + ++-----------+---------+ +| *Default* | ``128`` | ++-----------+---------+ + +Limits the size of the irradiance map which is normally determined by :ref:`Sky.radiance_size`. A higher size results in a higher quality irradiance map similarly to :ref:`rendering/quality/reflections/high_quality_ggx`. Use a higher value when using high-frequency HDRI maps, otherwise keep this as low as possible. + +**Note:** Low and mid range hardware do not support complex irradiance maps well and may crash if this is set too high. + ---- .. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections: @@ -3691,6 +4047,8 @@ If ``true``, uses texture arrays instead of mipmaps for reflection probes and pa | *Default* | ``false`` | +-----------+-----------+ +Lower-end override for :ref:`rendering/quality/reflections/texture_array_reflections` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx: @@ -3713,6 +4071,8 @@ If ``true``, uses faster but lower-quality Blinn model to generate blurred refle | *Default* | ``true`` | +-----------+----------+ +Lower-end override for :ref:`rendering/quality/shading/force_blinn_over_ggx` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley: @@ -3735,6 +4095,8 @@ If ``true``, uses faster but lower-quality Lambert material lighting model inste | *Default* | ``true`` | +-----------+----------+ +Lower-end override for :ref:`rendering/quality/shading/force_lambert_over_burley` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading: @@ -3757,6 +4119,8 @@ If ``true``, forces vertex shading for all rendering. This can increase performa | *Default* | ``true`` | +-----------+----------+ +Lower-end override for :ref:`rendering/quality/shading/force_vertex_shading` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_0_subdiv: @@ -3827,6 +4191,8 @@ Size for shadow atlas (used for OmniLights and SpotLights). See documentation. | *Default* | ``2048`` | +-----------+----------+ +Lower-end override for :ref:`rendering/quality/shadow_atlas/size` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode: @@ -3849,6 +4215,8 @@ Shadow filter mode. Higher-quality settings result in smoother shadows that flic | *Default* | ``0`` | +-----------+-------+ +Lower-end override for :ref:`rendering/quality/shadows/filter_mode` on mobile devices, due to performance concerns or driver support. + ---- .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/follow_surface: @@ -3871,7 +4239,7 @@ Improves quality of subsurface scattering, but cost significantly increases. | *Default* | ``1`` | +-----------+-------+ -Quality setting for subsurface scaterring (samples taken). +Quality setting for subsurface scattering (samples taken). ---- @@ -3883,6 +4251,8 @@ Quality setting for subsurface scaterring (samples taken). | *Default* | ``1.0`` | +-----------+---------+ +Max radius used for subsurface scattering samples. + ---- .. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/weight_samples: diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 6cf18b4c1..9737cd12a 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -84,7 +84,7 @@ Constants .. _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 --------------------- diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index ae2366bc6..aa3c2bf20 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -169,7 +169,7 @@ Signals .. _class_RichTextLabel_signal_meta_clicked: -- **meta_clicked** **(** :ref:`Nil` meta **)** +- **meta_clicked** **(** :ref:`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` type. If a particular type or an object is desired, the :ref:`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: -- **meta_hover_ended** **(** :ref:`Nil` meta **)** +- **meta_hover_ended** **(** :ref:`Variant` meta **)** 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: -- **meta_hover_started** **(** :ref:`Nil` meta **)** +- **meta_hover_started** **(** :ref:`Variant` meta **)** Triggers when the mouse enters a meta tag. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 72a3d113d..5462f3e1d 100644 --- a/classes/class_scenetree.rst +++ b/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: -- **global_menu_action** **(** :ref:`Nil` id, :ref:`Nil` meta **)** +- **global_menu_action** **(** :ref:`Variant` id, :ref:`Variant` meta **)** Emitted whenever global menu item is clicked. diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 1ce5f5f7b..25b4fad6e 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -174,9 +174,13 @@ Method Descriptions - :ref:`HScrollBar` **get_h_scrollbar** **(** **)** +Returns the horizontal scrollbar :ref:`HScrollBar` of this ``ScrollContainer``. + ---- .. _class_ScrollContainer_method_get_v_scrollbar: - :ref:`VScrollBar` **get_v_scrollbar** **(** **)** +Returns the vertical scrollbar :ref:`VScrollBar` of this ``ScrollContainer``. + diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 0f97dba18..42decb22f 100644 --- a/classes/class_sky.rst +++ b/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` constants for values. +**Note:** Some hardware will have trouble with higher radiance sizes, especially :ref:`RADIANCE_SIZE_512` and above. Only use such high values on high-end hardware. + diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index d355399e8..5461e203f 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -525,7 +525,7 @@ Transforms ``global_point`` from world space to this node's local space. - void **translate** **(** :ref:`Vector3` offset **)** -Changes the node's position by given offset :ref:`Vector3`. +Changes the node's position by the given offset :ref:`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. @@ -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` offset **)** +Changes the node's position by the given offset :ref:`Vector3` in local space. + ---- .. _class_Spatial_method_update_gizmo: diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 0d6f5461f..acbab955d 100644 --- a/classes/class_staticbody.rst +++ b/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`, 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 ---------- diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 89fd07c68..8a398ff34 100644 --- a/classes/class_styleboxflat.rst +++ b/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`) 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. ---- diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 4279d19e2..59413fadb 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -214,6 +214,8 @@ Default flag is :ref:`Mesh.ARRAY_COMPRESS_DEFAULT` **commit_to_arrays** **(** **)** +Commits the data to the same format used by :ref:`ArrayMesh.add_surface_from_arrays`. This way you can further process the mesh data using the :ref:`ArrayMesh` API. + ---- .. _class_SurfaceTool_method_create_from: @@ -228,6 +230,8 @@ Creates a vertex array from an existing :ref:`Mesh`. - void **create_from_blend_shape** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** +Creates a vertex array from the specified blend shape of an existing :ref:`Mesh`. This can be used to extract a specific pose from a blend shape. + ---- .. _class_SurfaceTool_method_deindex: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 84d9557b7..11f1b078c 100644 --- a/classes/class_texture.rst +++ b/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`. +``Texture`` is a base for other resources. It cannot be used directly. + Properties ---------- @@ -106,7 +108,7 @@ Property Descriptions | *Getter* | get_flags() | +-----------+------------------+ -The texture's flags. +The texture's :ref:`Flags`. :ref:`Flags` are used to set various properties of the ``Texture``. Method Descriptions ------------------- @@ -115,24 +117,32 @@ Method Descriptions - void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API at the specified ``position``. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect` with a rect at ``position`` and the size of this ``Texture``. + ---- .. _class_Texture_method_draw_rect: - void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect`. + ---- .. _class_Texture_method_draw_rect_region: - void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const +Draws a part of the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect_region`. + ---- .. _class_Texture_method_get_data: - :ref:`Image` **get_data** **(** **)** const +Returns an :ref:`Image` with the data from this ``Texture``. :ref:`Image`\ s can be accessed and manipulated directly. + ---- .. _class_Texture_method_get_height: @@ -163,3 +173,5 @@ Returns the texture width. - :ref:`bool` **has_alpha** **(** **)** const +Returns ``true`` if this ``Texture`` has an alpha channel. + diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst index e921730f8..e10a51b2e 100644 --- a/classes/class_texturearray.rst +++ b/classes/class_texturearray.rst @@ -11,5 +11,10 @@ TextureArray **Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +Array of textures stored in a single primitive. +Description +----------- + +``TextureArray``\ s store an array of images in a single :ref:`Texture` primitive. Each layer of the texture array has its own mipmap chain. This makes it is a good alternative to texture atlases. diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index c35e1f429..76bfa854f 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -13,7 +13,12 @@ TextureLayered **Inherited By:** :ref:`Texture3D`, :ref:`TextureArray` +Base class for 3D texture types. +Description +----------- + +Base class for :ref:`Texture3D` and :ref:`TextureArray`. Cannot be used directly. Properties ---------- diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 77ffbc3d1..7370c2b49 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -16,7 +16,9 @@ Control for playing video streams. Description ----------- -Control node for playing video streams. Supported formats are `WebM `_ and `Ogg Theora `_. +Control node for playing video streams using :ref:`VideoStream` resources. + +Supported video formats are `WebM `_ (:ref:`VideoStreamWebm`), `Ogg Theora `_ (:ref:`VideoStreamTheora`), and any format exposed via a GDNative plugin using :ref:`VideoStreamGDNative`. Properties ---------- @@ -146,7 +148,7 @@ Audio bus to use for sound playback. | *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. ---- diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index a3adffabb..93f50f5b9 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -15,3 +15,8 @@ VideoStream 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`. + diff --git a/classes/class_videostreamgdnative.rst b/classes/class_videostreamgdnative.rst index 5424f386b..f6fa3f3ed 100644 --- a/classes/class_videostreamgdnative.rst +++ b/classes/class_videostreamgdnative.rst @@ -11,7 +11,14 @@ VideoStreamGDNative **Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +:ref:`VideoStream` resource for for video formats implemented via GDNative. +Description +----------- + +:ref:`VideoStream` resource for for video formats implemented via GDNative. + +It can be used via `godot-videodecoder `_ which uses the `FFmpeg `_ library. Methods ------- @@ -29,9 +36,13 @@ Method Descriptions - :ref:`String` **get_file** **(** **)** +Returns the video file handled by this ``VideoStreamGDNative``. + ---- .. _class_VideoStreamGDNative_method_set_file: - void **set_file** **(** :ref:`String` file **)** +Sets the video file that this ``VideoStreamGDNative`` resource handles. The supported extensions depend on the GDNative plugins used to expose video formats. + diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 2c179c90e..ee05f8415 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -11,7 +11,12 @@ VideoStreamTheora **Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +:ref:`VideoStream` resource for Ogg Theora videos. +Description +----------- + +:ref:`VideoStream` resource handling the `Ogg Theora `_ video format with ``.ogv`` extension. Methods ------- @@ -29,9 +34,13 @@ Method Descriptions - :ref:`String` **get_file** **(** **)** +Returns the Ogg Theora video file handled by this ``VideoStreamTheora``. + ---- .. _class_VideoStreamTheora_method_set_file: - void **set_file** **(** :ref:`String` file **)** +Sets the Ogg Theora video file that this ``VideoStreamTheora`` resource handles. The ``file`` name should have the ``.o`` extension. + diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 3e9b42811..90288fdf9 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -11,7 +11,12 @@ VideoStreamWebm **Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +:ref:`VideoStream` resource for WebM videos. +Description +----------- + +:ref:`VideoStream` resource handling the `WebM `_ video format with ``.webm`` extension. Methods ------- @@ -29,9 +34,13 @@ Method Descriptions - :ref:`String` **get_file** **(** **)** +Returns the WebM video file handled by this ``VideoStreamWebm``. + ---- .. _class_VideoStreamWebm_method_set_file: - void **set_file** **(** :ref:`String` file **)** +Sets the WebM video file that this ``VideoStreamWebm`` resource handles. The ``file`` name should have the ``.webm`` extension. + diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 46185aa3b..005ddc564 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -217,19 +217,19 @@ enum **UpdateMode**: 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` 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` 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. @@ -307,13 +307,13 @@ enum **MSAA**: - **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**: -- **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` 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() | +-----------+----------------+ -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() | +-----------+-----------------+ -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() | +-----------+-----------------------------------------+ -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() | +-----------+-----------------------------------------+ -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() | +-----------+-----------------------------------------+ -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() | +-----------+-----------------------------------------+ -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` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** const +Returns the :ref:`ShadowAtlasQuadrantSubdiv` of the specified quadrant. + ---- .. _class_Viewport_method_get_size_override: @@ -980,18 +982,24 @@ Returns ``true`` if the size override is enabled. See :ref:`set_size_override` 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: - void **set_input_as_handled** **(** **)** +Stops the input from propagating further down the :ref:`SceneTree`. + ---- .. _class_Viewport_method_set_shadow_atlas_quadrant_subdiv: - void **set_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant, :ref:`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: diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 74273a820..77ab55d67 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -4696,7 +4696,7 @@ Sets a viewport's canvas. - void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** -Copies viewport to a region of the screen specified by ``rect``. If Viewport.:ref:`Viewport.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` 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: