diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GlobalScope.xml | 4 | ||||
| -rw-r--r-- | doc/classes/AtlasTexture.xml | 5 | ||||
| -rw-r--r-- | doc/classes/Input.xml | 4 | ||||
| -rw-r--r-- | doc/classes/NavigationServer2D.xml | 40 | ||||
| -rw-r--r-- | doc/classes/NavigationServer3D.xml | 40 |
5 files changed, 87 insertions, 6 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index d57d241b53..c86f264830 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -50,7 +50,7 @@ <argument index="0" name="x" type="float"> </argument> <description> - Returns the arc cosine of [code]x[/code] in radians. Use to get the angle of cosine [code]x[/code]. + Returns the arc cosine of [code]x[/code] in radians. Use to get the angle of cosine [code]x[/code]. [code]x[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method acos] will return [constant @GDScript.NAN]. [codeblock] # c is 0.523599 or 30 degrees if converted with rad2deg(c) c = acos(0.866025) @@ -63,7 +63,7 @@ <argument index="0" name="x" type="float"> </argument> <description> - Returns the arc sine of [code]x[/code] in radians. Use to get the angle of sine [code]x[/code]. + Returns the arc sine of [code]x[/code] in radians. Use to get the angle of sine [code]x[/code]. [code]x[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method asin] will return [constant @GDScript.NAN]. [codeblock] # s is 0.523599 or 30 degrees if converted with rad2deg(s) s = asin(0.5) diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 5bc077ef49..9865319419 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AtlasTexture" inherits="Texture2D" version="4.0"> <brief_description> - Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. + Crops out one part of a texture, such as a texture from a texture atlas. </brief_description> <description> - [Texture2D] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture2D], a margin that defines the border width, and a region that defines the actual area of the AtlasTexture. + [Texture2D] resource that crops out one part of the [member atlas] texture, defined by [member region]. The main use case is cropping out textures from a texture atlas, which is a big texture file that packs multiple smaller textures. Consists of a [Texture2D] for the [member atlas], a [member region] that defines the area of [member atlas] to use, and a [member margin] that defines the border width. + [AtlasTexture] cannot be used in an [AnimatedTexture], cannot be tiled in nodes such as [TextureRect], and does not work properly if used inside of other [AtlasTexture] resources. Multiple [AtlasTexture] resources can be used to crop multiple textures from the atlas. Using a texture atlas helps to optimize video memory costs and render calls compared to using multiple small files. </description> <tutorials> </tutorials> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 1f872db6c6..50a675e8db 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -51,7 +51,7 @@ <description> Returns the acceleration of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. Note this method returns an empty [Vector3] when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. - [b]Note:[/b] This method only works on iOS, Android, and UWP. On other platforms, it always returns [constant Vector3.ZERO]. + [b]Note:[/b] This method only works on iOS, Android, and UWP. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS and UWP it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). </description> </method> <method name="get_action_raw_strength" qualifiers="const"> @@ -107,7 +107,7 @@ </return> <description> Returns the gravity of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. - [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. + [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). </description> </method> <method name="get_gyroscope" qualifiers="const"> diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 4f34a8a424..b811607bad 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -267,6 +267,37 @@ Creates a new region. </description> </method> + <method name="region_get_connection_pathway_end" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connection_pathway_start" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connections_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <description> + Returns how many connections this [code]region[/code] has with other regions in the map. + </description> + </method> <method name="region_get_layers" qualifiers="const"> <return type="int"> </return> @@ -321,6 +352,15 @@ </description> </method> </methods> + <signals> + <signal name="map_changed"> + <argument index="0" name="map" type="RID"> + </argument> + <description> + Emitted when a navigation map is updated, when a region moves or is modified. + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 0653c0d27d..6d56428933 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -335,6 +335,37 @@ Creates a new region. </description> </method> + <method name="region_get_connection_pathway_end" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connection_pathway_start" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connections_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <description> + Returns how many connections this [code]region[/code] has with other regions in the map. + </description> + </method> <method name="region_get_layers" qualifiers="const"> <return type="int"> </return> @@ -398,6 +429,15 @@ </description> </method> </methods> + <signals> + <signal name="map_changed"> + <argument index="0" name="map" type="RID"> + </argument> + <description> + Emitted when a navigation map is updated, when a region moves or is modified. + </description> + </signal> + </signals> <constants> </constants> </class> |