diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 12 | ||||
| -rw-r--r-- | doc/classes/DisplayServer.xml | 2 | ||||
| -rw-r--r-- | doc/classes/EditorExportPlugin.xml | 25 | ||||
| -rw-r--r-- | doc/classes/NavigationServer2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/PhysicsDirectBodyState2D.xml | 9 | ||||
| -rw-r--r-- | doc/classes/PhysicsDirectBodyState2DExtension.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Quaternion.xml | 8 | ||||
| -rw-r--r-- | doc/classes/SurfaceTool.xml | 1 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Vector2.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Vector4.xml | 11 | ||||
| -rw-r--r-- | doc/classes/Vector4i.xml | 3 |
12 files changed, 66 insertions, 21 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 9575d2a5a1..a0b623936a 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -826,17 +826,21 @@ </method> <method name="print_rich" qualifiers="vararg"> <description> - Converts one or more arguments of any type to string in the best way possible and prints them to the console. The following BBCode tags are supported: b, i, u, s, indent, code, url, center, right, color, bgcolor, fgcolor. Color tags only support named colors such as [code]red[/code], [i]not[/i] hexadecimal color codes. Unsupported tags will be left as-is in standard output. - When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Displaying ANSI escape codes is currently only supported on Linux and macOS. Support for ANSI escape codes may vary across terminal emulators, especially for italic and strikethrough. + Converts one or more arguments of any type to string in the best way possible and prints them to the console. + The following BBCode tags are supported: [code]b[/code], [code]i[/code], [code]u[/code], [code]s[/code], [code]indent[/code], [code]code[/code], [code]url[/code], [code]center[/code], [code]right[/code], [code]color[/code], [code]bgcolor[/code], [code]fgcolor[/code]. + Color tags only support the following named colors: [code]black[/code], [code]red[/code], [code]green[/code], [code]yellow[/code], [code]blue[/code], [code]magenta[/code], [code]pink[/code], [code]purple[/code], [code]cyan[/code], [code]white[/code], [code]orange[/code], [code]gray[/code]. Hexadecimal color codes are not supported. + URL tags only support URLs wrapped by an URL tag, not URLs with a different title. + When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, [code]code[/code] is represented with faint text but without any font change. Unsupported tags are left as-is in standard output. [codeblocks] [gdscript] - print_rich("[code][b]Hello world![/b][/code]") # Prints out: [b]Hello world![/b] + print_rich("[color=green][b]Hello world![/b][/color]") # Prints out "Hello world!" in green with a bold font [/gdscript] [csharp] - GD.PrintRich("[code][b]Hello world![/b][/code]"); // Prints out: [b]Hello world![/b] + GD.PrintRich("[color=green][b]Hello world![/b][/color]"); // Prints out "Hello world!" in green with a bold font [/csharp] [/codeblocks] [b]Note:[/b] Consider using [method push_error] and [method push_warning] to print error and warning messages instead of [method print] or [method print_rich]. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed. + [b]Note:[/b] On Windows, only Windows 10 and later correctly displays ANSI escape codes in standard output. </description> </method> <method name="print_verbose" qualifiers="vararg"> diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index d0da097476..ece09f54a5 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -1587,7 +1587,7 @@ Default landscape orientation. </constant> <constant name="SCREEN_PORTRAIT" value="1" enum="ScreenOrientation"> - Default portrait orienstation. + Default portrait orientation. </constant> <constant name="SCREEN_REVERSE_LANDSCAPE" value="2" enum="ScreenOrientation"> Reverse landscape orientation (upside down). diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index e5740f806d..a5b42bb892 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -99,6 +99,17 @@ Return a [PackedStringArray] of additional features this preset, for the given [param platform], should have. </description> </method> + <method name="_get_export_options" qualifiers="virtual const"> + <return type="Dictionary[]" /> + <param index="0" name="platform" type="EditorExportPlatform" /> + <description> + Return a list of export options that can be configured for this export plugin. + Each element in the return value is a [Dictionary] with the following keys: + - [code]option[/code]: A dictionary with the structure documented by [method Object.get_property_list], but all keys are optional. + - [code]default_value[/code]: The default value for this option. + - [code]update_visibility[/code]: An optional boolean value. If set to [code]true[/code], the preset will emit [signal Object.property_list_changed] when the option is changed. + </description> + </method> <method name="_get_name" qualifiers="virtual const"> <return type="String" /> <description> @@ -106,6 +117,13 @@ Implementing this method is required. </description> </method> + <method name="_should_update_export_options" qualifiers="virtual const"> + <return type="bool" /> + <param index="0" name="platform" type="EditorExportPlatform" /> + <description> + Return [code]true[/code], if the result of [method _get_export_options] has changed and the export options of preset corresponding to [param platform] should be updated. + </description> + </method> <method name="add_file"> <return type="void" /> <param index="0" name="path" type="String" /> @@ -185,6 +203,13 @@ In case of a directory code-sign will error if you place non code object in directory. </description> </method> + <method name="get_option" qualifiers="const"> + <return type="Variant" /> + <param index="0" name="name" type="StringName" /> + <description> + Returns the current value of an export option supplied by [method _get_export_options]. + </description> + </method> <method name="skip"> <return type="void" /> <description> diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index a411ef2f70..75d648c540 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -10,7 +10,7 @@ For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method NavigationServer2D.region_set_navigation_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This allows allowing or forbidding some areas to 2D objects. To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity. - [b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. + [b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing an agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying. </description> <tutorials> diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml index 0716d71bae..aedd9373b1 100644 --- a/doc/classes/PhysicsDirectBodyState2D.xml +++ b/doc/classes/PhysicsDirectBodyState2D.xml @@ -141,7 +141,7 @@ <return type="Vector2" /> <param index="0" name="contact_idx" type="int" /> <description> - Returns the linear velocity vector at the collider's contact point. + Returns the velocity vector at the collider's contact point. </description> </method> <method name="get_contact_count" qualifiers="const"> @@ -179,6 +179,13 @@ Returns the local shape index of the collision. </description> </method> + <method name="get_contact_local_velocity_at_position" qualifiers="const"> + <return type="Vector2" /> + <param index="0" name="contact_idx" type="int" /> + <description> + Returns the velocity vector at the body's contact point. + </description> + </method> <method name="get_space_state"> <return type="PhysicsDirectSpaceState2D" /> <description> diff --git a/doc/classes/PhysicsDirectBodyState2DExtension.xml b/doc/classes/PhysicsDirectBodyState2DExtension.xml index e94d59480b..b6c0adb91d 100644 --- a/doc/classes/PhysicsDirectBodyState2DExtension.xml +++ b/doc/classes/PhysicsDirectBodyState2DExtension.xml @@ -154,6 +154,12 @@ <description> </description> </method> + <method name="_get_contact_local_velocity_at_position" qualifiers="virtual const"> + <return type="Vector2" /> + <param index="0" name="contact_idx" type="int" /> + <description> + </description> + </method> <method name="_get_inverse_inertia" qualifiers="virtual const"> <return type="float" /> <description> diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 60552c58a1..a606570ccf 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Quaternion" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - Quaternion. + A unit quaternion used for representing 3D rotations. </brief_description> <description> - A unit quaternion used for representing 3D rotations. Quaternions need to be normalized to be used for rotation. - It is similar to Basis, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. Basis stores rotation, scale, and shearing, while Quaternion only stores rotation. - Due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. + Quaternions are similar to [Basis], which implements the matrix representation of rotations. Unlike [Basis], which stores rotation, scale, and shearing, quaternions only store rotation. + Quaternions can be parametrized using both an axis-angle pair or Euler angles. Due to their compactness and the way they are stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. + [b]Note:[/b] Quaternions need to be normalized before being used for rotation. </description> <tutorials> <link title="Using 3D transforms">$DOCS_URL/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 0e07d2d023..a919bbdc6e 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -242,6 +242,7 @@ <param index="0" name="index" type="int" /> <description> Specifies the smooth group to use for the [i]next[/i] vertex. If this is never called, all vertices will have the default smooth group of [code]0[/code] and will be smoothed with adjacent vertices of the same group. To produce a mesh with flat normals, set the smooth group to [code]-1[/code]. + [b]Note:[/b] This function actually takes an [code]uint32_t[/code], so C# users should use [code]uint32.MaxValue[/code] instead of [code]-1[/code] to produce a mesh with flat normals. </description> </method> <method name="set_tangent"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 633e1b4e74..a1552982ae 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -498,7 +498,7 @@ <return type="String" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> - Returns the text inside the selection. + Returns the text inside the selection of a caret, or all the carets if [param caret_index] is its default value [code]-1[/code]. </description> </method> <method name="get_selection_column" qualifiers="const"> @@ -1378,7 +1378,7 @@ Select whole words as if the user double clicked. </constant> <constant name="SELECTION_MODE_LINE" value="4" enum="SelectionMode"> - Select whole lines as if the user tripped clicked. + Select whole lines as if the user triple clicked. </constant> <constant name="LINE_WRAPPING_NONE" value="0" enum="LineWrappingMode"> Line wrapping is disabled. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 35ccac120f..73f6f4be47 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -214,7 +214,7 @@ <return type="bool" /> <param index="0" name="to" type="Vector2" /> <description> - Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. + Returns [code]true[/code] if this vector and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> </method> <method name="is_finite" qualifiers="const"> @@ -288,7 +288,7 @@ <return type="Vector2" /> <description> Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. - [b]Note:[/b] This function may return incorrect values if the initial vector length is near zero. + [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. </description> </method> <method name="orthogonal" qualifiers="const"> diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index ea00ddaae1..cf829194e5 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -131,9 +131,9 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <param index="0" name="with" type="Vector4" /> + <param index="0" name="to" type="Vector4" /> <description> - Returns [code]true[/code] if this vector and [param with] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. + Returns [code]true[/code] if this vector and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> </method> <method name="is_finite" qualifiers="const"> @@ -164,7 +164,8 @@ <method name="length_squared" qualifiers="const"> <return type="float" /> <description> - Returns the squared length (squared magnitude) of this vector. This method runs faster than [method length]. + Returns the squared length (squared magnitude) of this vector. + This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. </description> </method> <method name="lerp" qualifiers="const"> @@ -198,14 +199,14 @@ <return type="Vector4" /> <param index="0" name="mod" type="float" /> <description> - Returns a new vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param mod]. + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param mod]. </description> </method> <method name="posmodv" qualifiers="const"> <return type="Vector4" /> <param index="0" name="modv" type="Vector4" /> <description> - Returns a new vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param modv]'s components. + Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param modv]'s components. </description> </method> <method name="round" qualifiers="const"> diff --git a/doc/classes/Vector4i.xml b/doc/classes/Vector4i.xml index e2de7a28dc..c2e03016bf 100644 --- a/doc/classes/Vector4i.xml +++ b/doc/classes/Vector4i.xml @@ -65,7 +65,8 @@ <method name="length_squared" qualifiers="const"> <return type="int" /> <description> - Returns the squared length (squared magnitude) of this vector. This method runs faster than [method length]. + Returns the squared length (squared magnitude) of this vector. + This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. </description> </method> <method name="max_axis_index" qualifiers="const"> |