From 9ca0dadd977e4c1567060b16ee7ad49ba5b43bf9 Mon Sep 17 00:00:00 2001 From: Micky Date: Thu, 29 Feb 2024 01:23:40 +0100 Subject: [PATCH] Add more keywords to base Variant types --- doc/classes/AABB.xml | 20 ++++++++++---------- doc/classes/Color.xml | 30 +++++++++++++++--------------- doc/classes/Rect2.xml | 16 ++++++++-------- doc/classes/Rect2i.xml | 16 ++++++++-------- doc/classes/String.xml | 28 ++++++++++++++-------------- 5 files changed, 55 insertions(+), 55 deletions(-) diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 427d38d421d6..5a6fdab77368 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -1,5 +1,5 @@ - + A 3D axis-aligned bounding box. @@ -59,7 +59,7 @@ [b]Note:[/b] It's recommended to use this method when [member size] is negative, as most other methods in Godot assume that the [member size]'s components are greater than [code]0[/code]. - + @@ -123,7 +123,7 @@ Returns the center point of the bounding box. This is the same as [code]position + (size / 2.0)[/code]. - + @@ -217,7 +217,7 @@ Returns the bounding box's volume. This is equivalent to [code]size.x * size.y * size.z[/code]. See also [method has_volume]. - + @@ -244,7 +244,7 @@ [/codeblocks] - + @@ -290,21 +290,21 @@ [b]Note:[/b] If you only need to know whether two bounding boxes are intersecting, use [method intersects], instead. - + Returns [code]true[/code] if this bounding box overlaps with the box [param with]. The edges of both boxes are [i]always[/i] excluded. - + Returns [code]true[/code] if this bounding box is on both sides of the given [param plane]. - + @@ -313,7 +313,7 @@ The ray begin at [param from], faces [param dir] and extends towards infinity. - + @@ -350,7 +350,7 @@ The origin point. This is usually the corner on the bottom-left and back of the bounding box. - + The bounding box's width, height, and depth starting from [member position]. Setting this value also affects the [member end] point. [b]Note:[/b] It's recommended setting the width, height, and depth to non-negative values. This is because most methods in Godot assume that the [member position] is the bottom-left-back corner, and the [member end] is the top-right-forward corner. To get an equivalent bounding box with non-negative size, use [method abs]. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 517fb6bef772..ae76ded56176 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -1,5 +1,5 @@ - + A color represented in RGBA format. @@ -97,7 +97,7 @@ - + @@ -141,7 +141,7 @@ [/codeblocks] - + @@ -159,7 +159,7 @@ [/codeblocks] - + @@ -472,37 +472,37 @@ - + The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque. - + Wrapper for [member a] that uses the range 0 to 255, instead of 0 to 1. - + The color's blue component, typically on the range of 0 to 1. - + Wrapper for [member b] that uses the range 0 to 255, instead of 0 to 1. - + The color's green component, typically on the range of 0 to 1. - + Wrapper for [member g] that uses the range 0 to 255, instead of 0 to 1. - + The HSV hue of this color, on the range 0 to 1. - + The color's red component, typically on the range of 0 to 1. - + Wrapper for [member r] that uses the range 0 to 255, instead of 0 to 1. - + The HSV saturation of this color, on the range 0 to 1. - + The HSV value (brightness) of this color, on the range 0 to 1. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 0471d73749a3..949b2d0f7088 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -1,5 +1,5 @@ - + A 2D axis-aligned bounding box using floating-point coordinates. @@ -72,7 +72,7 @@ [b]Note:[/b] It's recommended to use this method when [member size] is negative, as most other methods in Godot assume that the [member position] is the top-left corner, and the [member end] is the bottom-right corner. - + @@ -112,7 +112,7 @@ Returns the center point of the rectangle. This is the same as [code]position + (size / 2.0)[/code]. - + @@ -129,7 +129,7 @@ [/codeblocks] - + @@ -139,7 +139,7 @@ Returns a copy of this rectangle with its [param left], [param top], [param right], and [param bottom] sides extended by the given amounts. Negative values shrink the sides, instead. See also [method grow] and [method grow_side]. - + @@ -153,7 +153,7 @@ Returns [code]true[/code] if this rectangle has positive width and height. See also [method get_area]. - + @@ -183,7 +183,7 @@ [b]Note:[/b] If you only need to know whether two rectangles are overlapping, use [method intersects], instead. - + @@ -219,7 +219,7 @@ The origin point. This is usually the top-left corner of the rectangle. - + The rectangle's width and height, starting from [member position]. Setting this value also affects the [member end] point. [b]Note:[/b] It's recommended setting the width and height to non-negative values, as most methods in Godot assume that the [member position] is the top-left corner, and the [member end] is the bottom-right corner. To get an equivalent rectangle with non-negative size, use [method abs]. diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index c021a1be26f4..402f06efbc1e 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -1,5 +1,5 @@ - + A 2D axis-aligned bounding box using integer coordinates. @@ -71,7 +71,7 @@ [b]Note:[/b] It's recommended to use this method when [member size] is negative, as most other methods in Godot assume that the [member position] is the top-left corner, and the [member end] is the bottom-right corner. - + @@ -112,7 +112,7 @@ [b]Note:[/b] If the [member size] is odd, the result will be rounded towards [member position]. - + @@ -129,7 +129,7 @@ [/codeblocks] - + @@ -139,7 +139,7 @@ Returns a copy of this rectangle with its [param left], [param top], [param right], and [param bottom] sides extended by the given amounts. Negative values shrink the sides, instead. See also [method grow] and [method grow_side]. - + @@ -153,7 +153,7 @@ Returns [code]true[/code] if this rectangle has positive width and height. See also [method get_area]. - + @@ -183,7 +183,7 @@ [b]Note:[/b] If you only need to know whether two rectangles are overlapping, use [method intersects], instead. - + @@ -205,7 +205,7 @@ The origin point. This is usually the top-left corner of the rectangle. - + The rectangle's width and height, starting from [member position]. Setting this value also affects the [member end] point. [b]Note:[/b] It's recommended setting the width and height to non-negative values, as most methods in Godot assume that the [member position] is the top-left corner, and the [member end] is the bottom-right corner. To get an equivalent rectangle with non-negative size, use [method abs]. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 17f953f48ff1..b6d4b9b75b68 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -115,7 +115,7 @@ To get a [bool] result from a string comparison, use the [code]==[/code] operator instead. See also [method nocasecmp_to], [method naturalcasecmp_to], and [method naturalnocasecmp_to]. - + @@ -184,7 +184,7 @@ Returns a string with [param chars] characters erased starting from [param position]. If [param chars] goes beyond the string's length given the specified [param position], fewer characters will be erased from the returned string. Returns an empty string if either [param position] or [param chars] is negative. Returns the original string unmodified if [param chars] is [code]0[/code]. - + @@ -209,7 +209,7 @@ [b]Note:[/b] If you just want to know whether the string contains [param what], use [method contains]. In GDScript, you may also use the [code]in[/code] operator. - + @@ -537,7 +537,7 @@ Returns the number of characters in the string. Empty strings ([code]""[/code]) always return [code]0[/code]. See also [method is_empty]. - + @@ -553,14 +553,14 @@ [b]Note:[/b] [param chars] is not a prefix. Use [method trim_prefix] to remove a single prefix, rather than a set of characters. - + Does a simple expression match (also called "glob" or "globbing"), where [code]*[/code] matches zero or more arbitrary characters and [code]?[/code] matches any single character except a period ([code].[/code]). An empty string or empty expression always evaluates to [code]false[/code]. - + @@ -727,7 +727,7 @@ Returns the copy of this string in reverse order. - + @@ -735,7 +735,7 @@ Returns the index of the [b]last[/b] occurrence of [param what] in this string, or [code]-1[/code] if there are none. The search's start can be specified with [param from], continuing to the beginning of the string. This method is the reverse of [method find]. - + @@ -754,7 +754,7 @@ [/codeblock] - + @@ -762,7 +762,7 @@ Formats the string to be at least [param min_length] long, by adding [param character]s to the right of the string, if necessary. See also [method lpad]. - + @@ -887,7 +887,7 @@ [/codeblock] - + @@ -1008,21 +1008,21 @@ Converts the string to a [url=https://en.wikipedia.org/wiki/Wide_character]wide character[/url] ([code]wchar_t[/code], UTF-16 on Windows, UTF-32 on other platforms) encoded [PackedByteArray]. This is the inverse of [method PackedByteArray.get_string_from_wchar]. - + Removes the given [param prefix] from the start of the string, or returns the string unchanged. - + Removes the given [param suffix] from the end of the string, or returns the string unchanged. - +