From 70db9caf20ab7edbf9b848a6beaeefa9fdb45c7d Mon Sep 17 00:00:00 2001 From: Relintai Date: Sun, 10 Sep 2023 08:42:24 +0200 Subject: [PATCH] Re-extracted class docs. Also fixed smaller issues. --- doc/classes/@GlobalScope.xml | 6 +- doc/classes/CanvasItem.xml | 17 +----- doc/classes/Control.xml | 7 ++- doc/classes/InputEventShortCut.xml | 6 +- doc/classes/Navigation2DServer.xml | 15 ----- doc/classes/NavigationAgent.xml | 6 +- doc/classes/NavigationMesh.xml | 8 +-- doc/classes/NavigationPolygon.xml | 6 +- doc/classes/Popup.xml | 1 + doc/classes/ProjectSettings.xml | 70 +----------------------- doc/classes/RichTextLabel.xml | 7 +++ doc/classes/ScriptServer.xml | 10 ++-- doc/classes/StringName.xml | 1 - modules/gridmap/doc_classes/GridMap.xml | 14 ++--- modules/tile_map/doc_classes/TileMap.xml | 26 ++++----- 15 files changed, 60 insertions(+), 140 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 4f41b6c44..0a1e31325 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -102,14 +102,14 @@ The [ResourceSaver] singleton. + + The [ScriptServer] singleton. + The [Time] singleton. - - The [ScriptServer] singleton. - The [TranslationServer] singleton. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 770506556..b38d047f7 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -352,12 +352,6 @@ Returns [code]true[/code] if local transform notifications are communicated to children. - - - - Returns [code]true[/code] if the node is set as top-level. See [method set_as_toplevel]. - - @@ -384,13 +378,6 @@ Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. - - - - - If [code]enable[/code] is [code]true[/code], this [CanvasItem] will [i]not[/i] inherit its transform from parent [CanvasItem]s. Its draw order will also be changed to make it draw on top of other [CanvasItem]s that are not set as top-level. The [CanvasItem] will effectively act as if it was placed as a child of a bare [Node]. See also [method is_set_as_toplevel]. - - @@ -434,8 +421,8 @@ If [code]true[/code], the object draws behind its parent. - - If [code]true[/code], the object draws on top of its parent. + + If [code]true[/code], this [CanvasItem] will [i]not[/i] inherit its transform from parent [CanvasItem]s. Its draw order will also be changed to make it draw on top of other [CanvasItem]s that do not have [member top_level] set to [code]true[/code]. The [CanvasItem] will effectively act as if it was placed as a child of a bare [Node]. If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index e4f8f3b1d..8fcd684eb 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -440,6 +440,11 @@ Best used with [constant Node.NOTIFICATION_DRAG_END]. + + + + + @@ -777,7 +782,7 @@ The [Node] which must be a parent of the focused [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused. Setting this will override the node [member shortcut_context_path] is pointing. You can get rid of this override by setting this back to null. - + The [NodePath] for the [Node] which must be a parent of the focused [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused. [member shortcut_context] can be used to temporarily override this when needed. diff --git a/doc/classes/InputEventShortCut.xml b/doc/classes/InputEventShortCut.xml index aadb20295..c6151ca8d 100644 --- a/doc/classes/InputEventShortCut.xml +++ b/doc/classes/InputEventShortCut.xml @@ -8,9 +8,13 @@ + + The [ShortCut] represented by this event. Its [method ShortCut.matches_event] method will always return [code]true[/code] for this event. - \ No newline at end of file + + + diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index a635dac3f..c3d1b840f 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -367,13 +367,6 @@ Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code]. - - - - - Returns the map cell height. [b]Note:[/b] Currently not implemented. - - @@ -465,14 +458,6 @@ Sets the map active. - - - - - - Set the map cell height used to weld the navigation mesh polygons. [b]Note:[/b] Currently not implemented. - - diff --git a/doc/classes/NavigationAgent.xml b/doc/classes/NavigationAgent.xml index d82841561..0330fad96 100644 --- a/doc/classes/NavigationAgent.xml +++ b/doc/classes/NavigationAgent.xml @@ -179,16 +179,16 @@ The height of the avoidance agent. Agents will ignore other agents or obstacles that are above or below their current position + height in 2D avoidance. Does nothing in 3D avoidance which uses radius spheres alone. - + The maximum number of neighbors for the agent to consider. - + The maximum speed that an agent can move. A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers. - + The distance to search for other agents. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 39ac35d61..459812c22 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -144,13 +144,10 @@ The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values. - + The name of the group to scan for geometry. Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT]. - - The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. - Any regions with a size smaller than this will be merged with larger regions if possible. [b]Note:[/b] This value will be squared to calculate the number of cells. For example, a value of 20 will set the number of cells to 400. @@ -161,6 +158,9 @@ + + The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. + diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 8c3faba32..f35f65d8c 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -193,6 +193,9 @@ The distance to erode/shrink the traversable area from obstructions when baking polygons. + + The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map. + The physics layers to scan for static colliders. Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH]. @@ -211,9 +214,6 @@ Filling rule for baking polygons that defines in complex polygons which polygon sub-regions will be considered inside a given polygon, and which sub-regions will not, aka what is a hole. - - The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map. - diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index 7c7010e31..1b48e2517 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -57,6 +57,7 @@ If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event. [b]Note:[/b] Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to [code]false[/code]. + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index fa3f2d983..317174d87 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -333,68 +333,6 @@ Largest size limit (in power of 2) allowed when compressing using long-distance matching with Zstandard. Higher values can result in better compression, but will require more memory when compressing and decompressing. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards. @@ -497,8 +435,6 @@ Editor-only override for [member debug/settings/crash_handler/message]. Does not affect exported projects in debug or release mode. - - 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. See also [member physics/common/physics_ticks_per_second]. If [member display/window/vsync/use_vsync] is enabled, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate. @@ -610,7 +546,7 @@ Color to use to display disabled navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. - + Color of the curve path geometry, visible when "Visible Paths" is enabled in the Debug menu. @@ -1504,10 +1440,6 @@ This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. - - Default cell height for 2D navigation maps. See [method Navigation2DServer.map_set_cell_height]. - [b]Note:[/b] Currently not implemented. - Default cell size for 2D navigation maps. See [method Navigation2DServer.map_set_cell_size]. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 0dbed4eed..25dced785 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -177,6 +177,13 @@ Adds a context marker to the tag stack. See [method pop_context]. + + + + + + + diff --git a/doc/classes/ScriptServer.xml b/doc/classes/ScriptServer.xml index 844bd0e48..6f9193bf4 100644 --- a/doc/classes/ScriptServer.xml +++ b/doc/classes/ScriptServer.xml @@ -1,5 +1,5 @@ - + Global script class management singleton. @@ -12,7 +12,7 @@ - + Returns the class name that the script named [code]class[/code] directly extends. This may be an engine class or another global script class. @@ -25,14 +25,14 @@ - + Returns the global class name bound to the [Script] at [code]path[/code]. - + Returns the native engine class that the script named [code]class[/code] eventually extends. @@ -69,4 +69,4 @@ - \ No newline at end of file + diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index e9c174f63..854eaeb65 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -8,7 +8,6 @@ You will usually just pass a [String] to methods expecting a [StringName] and it will be automatically converted, but you may occasionally want to construct a [StringName] ahead of time with the [StringName] constructor or, in GDScript, the literal syntax [code]@"example"[/code]. See also [NodePath], which is a similar concept specifically designed to store pre-parsed scene tree paths. - diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 2f7e35b47..7567bc284 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -161,6 +161,13 @@ Sets an individual bit on the [member collision_mask]. + + + + + Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes. + + @@ -169,13 +176,6 @@ [code]pos[/code] should be in the GridMap's local coordinate space. - - - - - Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes. - - diff --git a/modules/tile_map/doc_classes/TileMap.xml b/modules/tile_map/doc_classes/TileMap.xml index 3e8b2523c..6f4763872 100644 --- a/modules/tile_map/doc_classes/TileMap.xml +++ b/modules/tile_map/doc_classes/TileMap.xml @@ -49,6 +49,12 @@ + + + + Returns the current navigation map [RID] use by this region. + + @@ -129,6 +135,13 @@ + + + + + Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map. + + @@ -153,19 +166,6 @@ - - - - - Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map. - - - - - - Returns the current navigation map [RID] use by this region. - -