From a23f6d0aa649d15a7b7453143d3247e4e02706b1 Mon Sep 17 00:00:00 2001 From: kobewi Date: Mon, 21 Nov 2022 03:48:36 +0100 Subject: [PATCH] Fill random docs --- doc/classes/CanvasGroup.xml | 3 +++ doc/classes/CanvasItem.xml | 4 ++++ doc/classes/EditorPlugin.xml | 20 ++++++++++++++++++++ doc/classes/HSlider.xml | 1 + doc/classes/Label.xml | 3 ++- doc/classes/LabelSettings.xml | 11 +++++++++++ doc/classes/NodePath.xml | 2 ++ doc/classes/PopupMenu.xml | 3 +++ doc/classes/ProjectSettings.xml | 1 + doc/classes/ScrollContainer.xml | 1 + doc/classes/Signal.xml | 5 +++++ doc/classes/SpinBox.xml | 1 + doc/classes/Sprite3D.xml | 1 + doc/classes/TextureProgressBar.xml | 2 ++ doc/classes/TileData.xml | 13 +++++++++++++ doc/classes/Tree.xml | 7 ++++++- doc/classes/VSlider.xml | 2 +- modules/gridmap/doc_classes/GridMap.xml | 4 ++++ 18 files changed, 81 insertions(+), 3 deletions(-) diff --git a/doc/classes/CanvasGroup.xml b/doc/classes/CanvasGroup.xml index 3bea8cde210..d2bcf3c7ac9 100644 --- a/doc/classes/CanvasGroup.xml +++ b/doc/classes/CanvasGroup.xml @@ -1,8 +1,11 @@ + Merges several 2D nodes into a single draw operation. + Child [CanvasItem] nodes of a [CanvasGroup] are drawn as a single object. It allows to e.g. draw overlapping translucent 2D nodes without blending (set [member CanvasItem.self_modulate] property of [CanvasGroup] to achieve this effect). + [b]Note:[/b] Since [CanvasGroup] and [member CanvasItem.clip_children] both utilize the backbuffer, children of a [CanvasGroup] who have their [member CanvasItem.clip_children] set to anything other than [constant CanvasItem.CLIP_CHILDREN_DISABLED] will not function correctly. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index a2859552a93..50bbbc71a0b 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -672,12 +672,16 @@ Represents the size of the [enum TextureRepeat] enum. + Child draws over parent and is not clipped. + Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn. + Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area. + Represents the size of the [enum ClipChildrenMode] enum. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 806588d1009..adcc87d062c 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -719,44 +719,64 @@ + Main editor toolbar, next to play buttons. + The toolbar that appears when 3D editor is active. + Left sidebar of the 3D editor. + Right sidebar of the 3D editor. + Bottom panel of the 3D editor. + The toolbar that appears when 2D editor is active. + Left sidebar of the 2D editor. + Right sidebar of the 2D editor. + Bottom panel of the 2D editor. + Bottom section of the inspector. + Tab of Project Settings dialog, to the left of other tabs. + Tab of Project Settings dialog, to the right of other tabs. + Dock slot, left side, upper-left (empty in default layout). + Dock slot, left side, bottom-left (empty in default layout). + Dock slot, left side, upper-right (in default layout includes Scene and Import docks). + Dock slot, left side, bottom-right (in default layout includes FileSystem dock). + Dock slot, right side, upper-left (empty in default layout). + Dock slot, right side, bottom-left (empty in default layout). + Dock slot, right side, upper-right (in default layout includes Inspector, Node and History docks). + Dock slot, right side, bottom-right (empty in default layout). Represents the size of the [enum DockSlot] enum. diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml index cb0a8b34dbf..19bb26a1b01 100644 --- a/doc/classes/HSlider.xml +++ b/doc/classes/HSlider.xml @@ -29,6 +29,7 @@ The background of the area to the left of the grabber. + The background of the area to the left of the grabber that displays when it's being hovered or focused. The background for the whole slider. Determines the height of the [code]grabber_area[/code]. diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 615aceac53b..cd87b4558f1 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -50,6 +50,7 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants. + A [LabelSettings] resource that can be shared between multiple [Label] nodes. Takes priority over theme properties. Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -100,7 +101,7 @@ Default text [Color] of the [Label]. - The tint of text outline. + The color of text outline. [Color] of the text's shadow effect. diff --git a/doc/classes/LabelSettings.xml b/doc/classes/LabelSettings.xml index aa972f2cf31..d73cb782954 100644 --- a/doc/classes/LabelSettings.xml +++ b/doc/classes/LabelSettings.xml @@ -1,29 +1,40 @@ + Collection of common settings to customize label text. + [LabelSettings] is a resource that can be assigned to a [Label] node to customize it. It will take priority over the properties defined in theme. The resource can be shared between multiple labels and swapped on the fly, so it's convenient and flexible way to setup text style. + [Font] used for the text. + Color of the text. + Size of the text. + Vertical space between lines when the text is multiline. + The color of the outline. + Text outline size. + Color of the shadow effect. If alpha is [code]0[/code], no shadow will be drawn. + Offset of the shadow effect, in pixels. + Size of the shadow effect. diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 022b4826ea3..c82ed5f1436 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -187,12 +187,14 @@ + Returns [code]true[/code] if two node paths are not equal. + Returns [code]true[/code] if two node paths are equal, i.e. all node names in the path are the same and in the same order. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 0dcb33ac4c4..a69163f4296 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -544,6 +544,7 @@ + Emitted when any item is added, modified or removed. @@ -576,8 +577,10 @@ Width of the single indentation level. + Horizontal padding to the right of the items (or left, in RTL layout). + Horizontal padding to the left of the items (or right, in RTL layout). The size of the item text outline. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 3478215f4fa..992234b3664 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -839,6 +839,7 @@ [b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified. + Default [InputEventAction] to swap input direction, i.e. change between left-to-right to right-to-left modes. Affects text-editting controls ([LineEdit], [TextEdit]). If a selection is currently active with the last caret in text fields, searches for the next occurrence of the selection, adds a caret and selects the next occurrence. diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index b96b7187e4a..af39261e81a 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -49,6 +49,7 @@ Controls whether horizontal scrollbar can be used and when it should be visible. See [enum ScrollMode] for options. + Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive. The current horizontal scroll value. diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index d99477ee955..3c98a0a0e1b 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -4,6 +4,8 @@ Class representing a signal defined in an object. + Signals can be connected to [Callable]s and emitted. When a signal is emitted, all connected callables are called. + Usually signals are accessed as properties of objects, but it's also possible to assign them to variables and pass them around, allowing for more dynamic connections. $DOCS_URL/getting_started/step_by_step/signals.html @@ -95,6 +97,7 @@ + Returns [code]true[/code] if either object or signal name are not valid. @@ -103,12 +106,14 @@ + Returns [code]true[/code] if two signals are not equal. + Returns [code]true[/code] if two signals are equal, i.e. their object and name are the same. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index e214867890f..7d63747bd2e 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -46,6 +46,7 @@ + Changes the alignment of the underlying [LineEdit]. If not [code]0[/code], [code]value[/code] will always be rounded to a multiple of [code]custom_arrow_step[/code] when interacting with the arrow buttons of the [SpinBox]. diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index 956e6467027..01671aa04e2 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -19,6 +19,7 @@ The number of columns in the sprite sheet. + If [code]true[/code], the sprite will use [member region_rect] and display only the specified part of its texture. The region of the atlas texture to display. [member region_enabled] must be [code]true[/code]. diff --git a/doc/classes/TextureProgressBar.xml b/doc/classes/TextureProgressBar.xml index 54b77bf5ebe..d7a9d06a153 100644 --- a/doc/classes/TextureProgressBar.xml +++ b/doc/classes/TextureProgressBar.xml @@ -13,6 +13,7 @@ + Returns the stretch margin with the specified index. See [member stretch_margin_bottom] and related properties. @@ -20,6 +21,7 @@ + Sets the stretch margin with the specified index. See [member stretch_margin_bottom] and related properties. diff --git a/doc/classes/TileData.xml b/doc/classes/TileData.xml index 798a536a88f..f815b8d0c39 100644 --- a/doc/classes/TileData.xml +++ b/doc/classes/TileData.xml @@ -1,8 +1,10 @@ + Settings for a single tile in a [TileSet]. + [TileData] object represents a single tile in a [TileSet]. It is usually edited using the tileset editor, but it can be modified at runtime using [method TileMap._tile_data_runtime_update]. @@ -196,32 +198,43 @@ + If [code]true[/code], the tile will have its texture flipped horizontally. + If [code]true[/code], the tile will have its texture flipped vertically. The [Material] to use for this [TileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader. + Color modulation of the tile. + Relative probability of this tile being selected when drawing a pattern of random tiles. + ID of the terrain from the terrain set that the tile uses. + ID of the terrain set that the tile uses. + Offsets the position of where the tile is drawn. + If [code]true[/code], the tile will display transposed, i.e. with horizontal and vertical texture UVs swapped. + Vertical point of the tile used for determining y-sorted order. + Ordering index of this tile, relative to [TileMap]. + Emitted when any of the properties are changed. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index bf79821e2da..6a016c3ebd5 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -84,6 +84,7 @@ + Returns the expand ratio assigned to the column. @@ -223,12 +224,14 @@ + Returns [code]true[/code] if the column has enabled clipping (see [method set_column_clip_content]). + Returns [code]true[/code] if the column has enabled expanding (see [method set_column_expand]). @@ -244,6 +247,7 @@ + Allows to enable clipping for column's content, making the content size ignored. @@ -259,7 +263,7 @@ - If [code]true[/code], the column will have the "Expand" flag of [Control]. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. + If [code]true[/code], the column will have the "Expand" flag of [Control]. Columns that have the "Expand" flag will use their expand ratio in a similar fashion to [member Control.size_flags_stretch_ratio] (see [method set_column_expand_ratio]). @@ -267,6 +271,7 @@ + Sets the relative expand ratio for a column. See [method set_column_expand]. diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index 488154106f0..4bc98dea6ff 100644 --- a/doc/classes/VSlider.xml +++ b/doc/classes/VSlider.xml @@ -33,7 +33,7 @@ The background of the area below the grabber. - The background of the area below the grabber, to the left of the grabber. + The background of the area below the grabber that displays when it's being hovered or focused. The background for the whole slider. Determines the width of the [code]grabber_area[/code]. diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 0f3662c3cff..bd5c9383640 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -25,12 +25,14 @@ + Clears all baked meshes. See [method make_baked_meshes]. + Returns [RID] of a baked mesh with the given [param idx]. @@ -133,6 +135,7 @@ + Bakes lightmap data for all meshes in the assigned [MeshLibrary]. @@ -146,6 +149,7 @@ + Notifies the [GridMap] about changed resource and recreates octant data.