diff options
Diffstat (limited to 'doc')
36 files changed, 697 insertions, 96 deletions
diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 965fad1961..a7d3e46684 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -36,6 +36,13 @@ Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. </description> </method> + <method name="get_hmd_transform"> + <return type="Transform"> + </return> + <description> + Returns the primary interface's transformation. + </description> + </method> <method name="get_interface" qualifiers="const"> <return type="ARVRInterface"> </return> @@ -59,6 +66,24 @@ Returns a list of available interfaces with both id and name of the interface. </description> </method> + <method name="get_last_commit_usec"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_last_frame_usec"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_last_process_usec"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_reference_frame" qualifiers="const"> <return type="Transform"> </return> @@ -82,17 +107,10 @@ Get the number of trackers currently registered. </description> </method> - <method name="set_primary_interface"> - <return type="void"> - </return> - <argument index="0" name="interface" type="ARVRInterface"> - </argument> - <description> - Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. - </description> - </method> </methods> <members> + <member name="primary_interface" type="ARVRInterface" setter="set_primary_interface" getter="get_primary_interface"> + </member> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. </member> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 178c714a20..f3280e7a27 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -103,6 +103,13 @@ Get the blend time (in seconds) between two animations, referenced by their names. </description> </method> + <method name="get_playing_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method. + </description> + </method> <method name="has_animation" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 2e2176743f..5f85751c13 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -131,8 +131,11 @@ <method name="duplicate"> <return type="Array"> </return> + <argument index="0" name="deep" type="bool" default="False"> + </argument> <description> - Returns a copy of this [code]Array[/code]. + Returns a copy of the array. + If [code]deep[/code] is [code]true[/code], a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. </description> </method> <method name="empty"> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 0be91427b1..7b3ba632cc 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -126,6 +126,18 @@ Returns the volume of the bus at index [code]bus_idx[/code] in dB. </description> </method> + <method name="get_device"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_device_list"> + <return type="Array"> + </return> + <description> + </description> + </method> <method name="get_mix_rate" qualifiers="const"> <return type="float"> </return> @@ -313,6 +325,14 @@ Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. </description> </method> + <method name="set_device"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="String"> + </argument> + <description> + </description> + </method> <method name="swap_bus_effects"> <return type="void"> </return> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index f7270fa5f9..554ed99964 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -8,6 +8,7 @@ For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). </description> <tutorials> + http://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html </tutorials> <demos> </demos> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 0b7cd4ef7a..7f7f152ae9 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -14,15 +14,17 @@ <method name="clear_current"> <return type="void"> </return> + <argument index="0" name="enable_next" type="bool" default="true"> + </argument> <description> - If this is the current Camera, remove it from being current. If it is inside the node tree, request to make the next Camera current, if any. + If this is the current Camera, remove it from being current. If [code]enable_next[/code] is true, request to make the next Camera current, if any. </description> </method> <method name="get_camera_transform" qualifiers="const"> <return type="Transform"> </return> <description> - Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. </description> </method> <method name="is_position_behind" qualifiers="const"> @@ -31,14 +33,14 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Returns [code]true[/code] if the given position is behind the Camera. + Returns [code]true[/code] if the given position is behind the Camera. Note that a position which returns [code]false[/code] may still be outside the Camera's field of view. </description> </method> <method name="make_current"> <return type="void"> </return> <description> - Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. + Makes this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. </description> </method> <method name="project_local_ray_normal" qualifiers="const"> @@ -56,7 +58,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> - Returns how a 2D coordinate in the Viewport rectangle maps to a 3D point in worldspace. + Returns the 3D point in worldspace that maps to the given 2D coordinate in the [Viewport] rectangle. </description> </method> <method name="project_ray_normal" qualifiers="const"> @@ -87,7 +89,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) + Sets the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) </description> </method> <method name="set_perspective"> @@ -100,7 +102,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. + Sets the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. </description> </method> <method name="unproject_position" qualifiers="const"> @@ -109,7 +111,7 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Returns how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. + Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in worldspace. </description> </method> </methods> @@ -124,7 +126,7 @@ If not [code]DOPPLER_TRACKING_DISABLED[/code] this Camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. Default value: [code]DOPPLER_TRACKING_DISABLED[/code]. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> - Set the [Environment] to use for this Camera. + The [Environment] to use for this Camera. </member> <member name="far" type="float" setter="set_zfar" getter="get_zfar"> The distance to the far culling boundary for this Camera relative to its local z-axis. @@ -136,7 +138,7 @@ The horizontal (X) offset of the Camera viewport. </member> <member name="keep_aspect" type="int" setter="set_keep_aspect_mode" getter="get_keep_aspect_mode" enum="Camera.KeepAspect"> - The axis to lock during [member fov]/[member size] adjustments. + The axis to lock during [member fov]/[member size] adjustments. Can be either [code]KEEP_WIDTH[/code] or [code]KEEP_HEIGHT[/code]. </member> <member name="near" type="float" setter="set_znear" getter="get_znear"> The distance to the near culling boundary for this Camera relative to its local z-axis. @@ -148,7 +150,7 @@ The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length. </member> <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset"> - The horizontal (Y) offset of the Camera viewport. + The vertical (Y) offset of the Camera viewport. </member> </members> <constants> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index b2b0938822..3e4d1b29f7 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -13,11 +13,11 @@ <demos> </demos> <methods> - <method name="get_world_2d" qualifiers="const"> - <return type="World2D"> + <method name="get_canvas" qualifiers="const"> + <return type="RID"> </return> <description> - Return the [World2D] used by this layer. + Returns the RID of the canvas used by this layer. </description> </method> </methods> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 95e8622cf4..4b6a9cca8a 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -773,6 +773,10 @@ <constant name="NOTIFICATION_MODAL_CLOSE" value="46"> Sent when an open modal dialog closes. See [member show_modal]. </constant> + <constant name="NOTIFICATION_SCROLL_BEGIN" value="47"> + </constant> + <constant name="NOTIFICATION_SCROLL_END" value="48"> + </constant> <constant name="CURSOR_ARROW" value="0" enum="CursorShape"> Show the system's arrow mouse cursor when the user hovers the node. Use with [method set_default_cursor_shape]. </constant> @@ -908,6 +912,8 @@ </constant> <constant name="GROW_DIRECTION_END" value="1" enum="GrowDirection"> </constant> + <constant name="GROW_DIRECTION_BOTH" value="2" enum="GrowDirection"> + </constant> <constant name="ANCHOR_BEGIN" value="0" enum="Anchor"> Snaps one of the 4 anchor's sides to the origin of the node's [code]Rect[/code], in the top left. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset]. </constant> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index d7118265f1..3c1413b028 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -19,6 +19,8 @@ <method name="duplicate"> <return type="Dictionary"> </return> + <argument index="0" name="deep" type="bool" default="False"> + </argument> <description> </description> </method> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 0a8d95d25d..846d6f18ff 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -102,6 +102,21 @@ <description> </description> </method> + <method name="add_tool_menu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="handler" type="Object"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <argument index="3" name="ud" type="Variant" default="null"> + </argument> + <description> + Adds a custom menu to 'Project > Tools' as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it. + </description> + </method> <method name="add_tool_submenu_item"> <return type="void"> </return> @@ -347,6 +362,15 @@ <description> </description> </method> + <method name="remove_tool_menu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Removes a menu [code]name[/code] from 'Project > Tools'. + </description> + </method> <method name="save_external_data" qualifiers="virtual"> <return type="void"> </return> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 534323348e..bd368e967a 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -163,14 +163,14 @@ Returns a [String] saved in Pascal format from the file. </description> </method> - <method name="get_path"> + <method name="get_path" qualifiers="const"> <return type="String"> </return> <description> Returns the path as a [String] for the current open file. </description> </method> - <method name="get_path_absolute"> + <method name="get_path_absolute" qualifiers="const"> <return type="String"> </return> <description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 5bd7c4cd3e..018b548ef1 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -111,6 +111,12 @@ String queryString = httpClient.query_string_from_dict(fields) returns:= "username=user&password=pass" [/codeblock] + Furthermore, if a key has a null value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added. + [codeblock] + var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]} + String queryString = httpClient.query_string_from_dict(fields) + returns:= "single=123&not_valued&multiple=22&multiple=33&multiple=44" + [/codeblock] </description> </method> <method name="read_response_body_chunk"> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index c1bd8d34eb..ea61aced83 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -67,6 +67,14 @@ Blits [code]src_rect[/code] area from [code]src[/code] image to this image at the coordinates given by [code]dst[/code]. [code]src[/code] pixel is copied onto [code]dst[/code] if the corresponding [code]mask[/code] pixel's alpha value is not 0. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. </description> </method> + <method name="bumpmap_to_normalmap"> + <return type="void"> + </return> + <argument index="0" name="bump_scale" type="float" default="1.0"> + </argument> + <description> + </description> + </method> <method name="clear_mipmaps"> <return type="void"> </return> @@ -436,109 +444,109 @@ <constant name="FORMAT_LA8" value="1" enum="Format"> </constant> <constant name="FORMAT_R8" value="2" enum="Format"> - OpenGL texture format RED with a single component and a bitdepth of 8. + OpenGL texture format RED with a single component and a bitdepth of 8. </constant> <constant name="FORMAT_RG8" value="3" enum="Format"> - OpenGL texture format RG with two components and a bitdepth of 8 for each. + OpenGL texture format RG with two components and a bitdepth of 8 for each. </constant> <constant name="FORMAT_RGB8" value="4" enum="Format"> - OpenGL texture format RGB with three components, each with a bitdepth of 8. + OpenGL texture format RGB with three components, each with a bitdepth of 8. </constant> <constant name="FORMAT_RGBA8" value="5" enum="Format"> - OpenGL texture format RGBA with four components, each with a bitdepth of 8. + OpenGL texture format RGBA with four components, each with a bitdepth of 8. </constant> <constant name="FORMAT_RGBA4444" value="6" enum="Format"> - OpenGL texture format RGBA with four components, each with a bitdepth of 4. + OpenGL texture format RGBA with four components, each with a bitdepth of 4. </constant> <constant name="FORMAT_RGBA5551" value="7" enum="Format"> - OpenGL texture format GL_RGB5_A1 where 5 bits of depth for each component of RGB and one bit for alpha. + OpenGL texture format GL_RGB5_A1 where 5 bits of depth for each component of RGB and one bit for alpha. </constant> <constant name="FORMAT_RF" value="8" enum="Format"> - OpenGL texture format GL_R32F where there's one component, a 32-bit floating-point value. + OpenGL texture format GL_R32F where there's one component, a 32-bit floating-point value. </constant> <constant name="FORMAT_RGF" value="9" enum="Format"> - OpenGL texture format GL_RG32F where there are two components, each a 32-bit floating-point values. + OpenGL texture format GL_RG32F where there are two components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RGBF" value="10" enum="Format"> - OpenGL texture format GL_RGB32F where there are three components, each a 32-bit floating-point values. + OpenGL texture format GL_RGB32F where there are three components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RGBAF" value="11" enum="Format"> - OpenGL texture format GL_RGBA32F where there are four components, each a 32-bit floating-point values. + OpenGL texture format GL_RGBA32F where there are four components, each a 32-bit floating-point values. </constant> <constant name="FORMAT_RH" value="12" enum="Format"> - OpenGL texture format GL_R32F where there's one component, a 16-bit "half-precision" floating-point value. + OpenGL texture format GL_R32F where there's one component, a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGH" value="13" enum="Format"> - OpenGL texture format GL_RG32F where there's two components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format GL_RG32F where there's two components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBH" value="14" enum="Format"> - OpenGL texture format GL_RGB32F where there's three components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format GL_RGB32F where there's three components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBAH" value="15" enum="Format"> - OpenGL texture format GL_RGBA32F where there's four components, each a 16-bit "half-precision" floating-point value. + OpenGL texture format GL_RGBA32F where there's four components, each a 16-bit "half-precision" floating-point value. </constant> <constant name="FORMAT_RGBE9995" value="16" enum="Format"> - A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single exponent. + A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single exponent. </constant> <constant name="FORMAT_DXT1" value="17" enum="Format"> - The S3TC texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha. More information can be found at https://www.khronos.org/opengl/wiki/S3_Texture_Compression. + The S3TC texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha. More information can be found at https://www.khronos.org/opengl/wiki/S3_Texture_Compression. </constant> <constant name="FORMAT_DXT3" value="18" enum="Format"> - The S3TC texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas. + The S3TC texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas. </constant> <constant name="FORMAT_DXT5" value="19" enum="Format"> - The S3TC texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparency gradients than DXT3. + The S3TC texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparency gradients than DXT3. </constant> <constant name="FORMAT_RGTC_R" value="20" enum="Format"> - Texture format that uses Red Green Texture Compression, normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. More information can be found here https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression. + Texture format that uses Red Green Texture Compression, normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. More information can be found here https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression. </constant> <constant name="FORMAT_RGTC_RG" value="21" enum="Format"> - Texture format that uses Red Green Texture Compression, normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. + Texture format that uses Red Green Texture Compression, normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. </constant> <constant name="FORMAT_BPTC_RGBA" value="22" enum="Format"> - Texture format that uses BPTC compression with unsigned normalized RGBA components. More information can be found at https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression. + Texture format that uses BPTC compression with unsigned normalized RGBA components. More information can be found at https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression. </constant> <constant name="FORMAT_BPTC_RGBF" value="23" enum="Format"> - Texture format that uses BPTC compression with signed floating-point RGB components. + Texture format that uses BPTC compression with signed floating-point RGB components. </constant> <constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format"> - Texture format that uses BPTC compression with unsigned floating-point RGB components. + Texture format that uses BPTC compression with unsigned floating-point RGB components. </constant> <constant name="FORMAT_PVRTC2" value="25" enum="Format"> - Texture format used on PowerVR-supported mobile platforms, uses 2 bit color depth with no alpha. More information on PVRTC can be found here https://en.wikipedia.org/wiki/PVRTC. + Texture format used on PowerVR-supported mobile platforms, uses 2 bit color depth with no alpha. More information on PVRTC can be found here https://en.wikipedia.org/wiki/PVRTC. </constant> <constant name="FORMAT_PVRTC2A" value="26" enum="Format"> - Same as PVRTC2, but with an alpha component. + Same as PVRTC2, but with an alpha component. </constant> <constant name="FORMAT_PVRTC4" value="27" enum="Format"> - Similar to PVRTC2, but with 4 bit color depth and no alpha. + Similar to PVRTC2, but with 4 bit color depth and no alpha. </constant> <constant name="FORMAT_PVRTC4A" value="28" enum="Format"> - Same as PVRTC4, but with an alpha component. + Same as PVRTC4, but with an alpha component. </constant> <constant name="FORMAT_ETC" value="29" enum="Format"> - Ericsson Texture Compression format, also referred to as 'ETC1', and is part of the OpenGL ES graphics standard. An overview of the format is given at https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1. + Ericsson Texture Compression format, also referred to as 'ETC1', and is part of the OpenGL ES graphics standard. An overview of the format is given at https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1. </constant> <constant name="FORMAT_ETC2_R11" value="30" enum="Format"> - Ericsson Texture Compression format 2 variant R11_EAC, which provides one channel of unsigned data. + Ericsson Texture Compression format 2 variant R11_EAC, which provides one channel of unsigned data. </constant> <constant name="FORMAT_ETC2_R11S" value="31" enum="Format"> - Ericsson Texture Compression format 2 variant SIGNED_R11_EAC, which provides one channel of signed data. + Ericsson Texture Compression format 2 variant SIGNED_R11_EAC, which provides one channel of signed data. </constant> <constant name="FORMAT_ETC2_RG11" value="32" enum="Format"> - Ericsson Texture Compression format 2 variant RG11_EAC, which provides two channels of unsigned data. + Ericsson Texture Compression format 2 variant RG11_EAC, which provides two channels of unsigned data. </constant> <constant name="FORMAT_ETC2_RG11S" value="33" enum="Format"> - Ericsson Texture Compression format 2 variant SIGNED_RG11_EAC, which provides two channels of signed data. + Ericsson Texture Compression format 2 variant SIGNED_RG11_EAC, which provides two channels of signed data. </constant> <constant name="FORMAT_ETC2_RGB8" value="34" enum="Format"> - Ericsson Texture Compression format 2 variant RGB8, which is a followup of ETC1 and compresses RGB888 data. + Ericsson Texture Compression format 2 variant RGB8, which is a followup of ETC1 and compresses RGB888 data. </constant> <constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format"> - Ericsson Texture Compression format 2 variant RGBA8, which compresses RGBA8888 data with full alpha support. + Ericsson Texture Compression format 2 variant RGBA8, which compresses RGBA8888 data with full alpha support. </constant> <constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format"> - Ericsson Texture Compression format 2 variant RGB8_PUNCHTHROUGH_ALPHA1, which compresses RGBA data to make alpha either fully transparent or fully opaque. + Ericsson Texture Compression format 2 variant RGB8_PUNCHTHROUGH_ALPHA1, which compresses RGBA data to make alpha either fully transparent or fully opaque. </constant> <constant name="FORMAT_MAX" value="37" enum="Format"> </constant> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index f3bff5a146..f537908625 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -333,7 +333,7 @@ </methods> <signals> <signal name="joy_connection_changed"> - <argument index="0" name="index" type="int"> + <argument index="0" name="device" type="int"> </argument> <argument index="1" name="connected" type="bool"> </argument> diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml index d47df796a2..1ac7b5107e 100644 --- a/doc/classes/InterpolatedCamera.xml +++ b/doc/classes/InterpolatedCamera.xml @@ -5,7 +5,7 @@ </brief_description> <description> InterpolatedCamera is a [Camera] which smoothly moves to match a target node's position and rotation. - If it is not [member enabled], or does not have a valid target set, InterpolatedCamera acts like a normal Camera. + If it is not [member enabled] or does not have a valid target set, InterpolatedCamera acts like a normal Camera. </description> <tutorials> </tutorials> @@ -18,16 +18,16 @@ <argument index="0" name="target" type="Object"> </argument> <description> - Set the node to move toward. + Sets the node to move toward and orient with. </description> </method> </methods> <members> <member name="enabled" type="bool" setter="set_interpolation_enabled" getter="is_interpolation_enabled"> - If [code]true[/code], and a target is set, the camera will move automatically. + If [code]true[/code] and a target is set, the camera will move automatically. </member> <member name="speed" type="float" setter="set_speed" getter="get_speed"> - How quickly the camera moves. + How quickly the camera moves toward its target. Higher values will result in tighter camera motion. </member> <member name="target" type="NodePath" setter="set_target_path" getter="get_target_path"> The target's [NodePath]. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index e4db5aeb84..bd1d6be4f5 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -87,6 +87,15 @@ <description> </description> </method> + <method name="get_item_icon_modulate" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns a [Color] modulating item's icon at the specified index. + </description> + </method> <method name="get_item_icon_region" qualifiers="const"> <return type="Rect2"> </return> @@ -135,6 +144,13 @@ Returns the current vertical scroll bar for the List. </description> </method> + <method name="is_anything_selected"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if one or more items are selected. + </description> + </method> <method name="is_item_disabled" qualifiers="const"> <return type="bool"> </return> @@ -171,6 +187,17 @@ Returns whether or not item at the specified index is currently selected. </description> </method> + <method name="move_item"> + <return type="void"> + </return> + <argument index="0" name="from_idx" type="int"> + </argument> + <argument index="1" name="to_idx" type="int"> + </argument> + <description> + Moves item at index [code]from_idx[/code] to [code]to_idx[/code]. + </description> + </method> <method name="remove_item"> <return type="void"> </return> @@ -225,6 +252,17 @@ Set (or replace) icon of the item at the specified index. </description> </method> + <method name="set_item_icon_modulate"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="modulate" type="Color"> + </argument> + <description> + Sets a modulating [Color] for item's icon at the specified index. + </description> + </method> <method name="set_item_icon_region"> <return type="void"> </return> @@ -306,6 +344,13 @@ Ensure item at specified index is not selected. </description> </method> + <method name="unselect_all"> + <return type="void"> + </return> + <description> + Ensure there are no items selected. + </description> + </method> </methods> <members> <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect"> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml new file mode 100644 index 0000000000..591d715174 --- /dev/null +++ b/doc/classes/MultiplayerAPI.xml @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MultiplayerAPI" inherits="Reference" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_peer"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="connected_to_server"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="connection_failed"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="del_peer"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_network_connected_peers" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <description> + </description> + </method> + <method name="get_network_unique_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_rpc_sender_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="has_network_peer" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_network_server" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="poll"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="server_disconnected"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_root_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> + </member> + <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections"> + </member> + </members> + <signals> + <signal name="connected_to_server"> + <description> + </description> + </signal> + <signal name="connection_failed"> + <description> + </description> + </signal> + <signal name="network_peer_connected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="network_peer_disconnected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="server_disconnected"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index b3b9ada26c..08f22d49d3 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Navigation" inherits="Spatial" category="Core" version="3.1"> <brief_description> - A collection of [code]NavigationMesh[/code] resources and methods used for pathfinding. + Mesh-based navigation and pathfinding node. </brief_description> <description> - The Navigation node is used for basic or advanced navigation. By default it will automatically collect all child [code]NavigationMesh[/code] resources, but they can also be added on the fly through scripting. It can be used for generating a simple path between two points or it can be used to ensure that a navigation agent is angled perfectly to the terrain it is navigating. + Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default these will be automatically collected from child [NavigationMeshInstance] nodes, but they can also be added on the fly with [method navmesh_add]. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the closest navigation point to the point passed. + Returns the navigation point closest to the point given. Points are in local coordinate space. </description> </method> <method name="get_closest_point_normal"> @@ -26,7 +26,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the surface normal of the navigation mesh at the point passed. For instance, if the point passed was at a 45 degree slope it would return something like (0.5,0.5,0). This is useful for rotating a navigation agent in accordance with the [code]NavigationMesh[/code]. + Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. </description> </method> <method name="get_closest_point_owner"> @@ -35,7 +35,7 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the nearest [code]NavigationMeshInstance[/code] to the point passed. + Returns the owner of the [NavigationMesh] which contains the navigation point closest to the point given. This is usually a [NavigtionMeshInstance]. For meshes added via [method navmesh_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). </description> </method> <method name="get_closest_point_to_segment"> @@ -48,7 +48,7 @@ <argument index="2" name="use_collision" type="bool" default="false"> </argument> <description> - Returns the nearest point to the line segment passed. The third optional parameter takes collisions into account. + Returns the navigation point closest to the given line segment. When enabling [code]use_collision[/code], only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. </description> </method> <method name="get_simple_path"> @@ -61,7 +61,7 @@ <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> - Returns a path of points as a [code]PoolVector3Array[/code]. If [code]optimize[/code] is false the [code]NavigationMesh[/code] agent properties will be taken into account, otherwise it will return the nearest path and ignore agent radius, height, etc. + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (raidus, height, etc.) are considered in the path calculation, otherwise they are ignored. </description> </method> <method name="navmesh_add"> @@ -74,7 +74,7 @@ <argument index="2" name="owner" type="Object" default="null"> </argument> <description> - Adds a [code]NavigationMesh[/code] to the list of NavigationMesh's in this node. Returns an id. Its position, rotation and scale are associated with the [code]Transform[/code] passed. The [code]Node[/code] (or [code]Object[/code]) that owns this node is an optional parameter. + Adds a [NavigationMesh]. Returns an ID for use with [method navmesh_remove] or [method navmesh_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. </description> </method> <method name="navmesh_remove"> @@ -83,7 +83,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Removes a [code]NavigationMesh[/code] from the list of NavigationMesh's in this node. + Removes the [NavigationMesh] with the given ID. </description> </method> <method name="navmesh_set_transform"> @@ -94,13 +94,13 @@ <argument index="1" name="xform" type="Transform"> </argument> <description> - Associates a [code]NavigationMesh[/code]'s id with a [code]Transform[/code]. Its position, rotation and scale are based on the [code]Transform[/code] passed. + Sets the transform applied to the [NavigationMesh] with the given ID. </description> </method> </methods> <members> <member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector"> - Defines which direction is up. The default defines 0,1,0 as up which is the world up direction. To make this a ceiling use 0,-1,0 to define down as up. + Defines which direction is up. By default this is [code](0, 1, 0)[/code], which is the world up direction. </member> </members> <constants> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index d2f4513372..364da55f99 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -1,9 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Navigation2D" inherits="Node2D" category="Core" version="3.1"> <brief_description> - Class to assist with character navigation and pathfinding. + 2D navigation and pathfinding node. </brief_description> <description> + Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default these are automatically collected from child [NavigationPolygonInstance] nodes, but they can also be added on the fly with [method navpoly_add]. </description> <tutorials> </tutorials> @@ -16,6 +17,7 @@ <argument index="0" name="to_point" type="Vector2"> </argument> <description> + Returns the navigation point closest to the point given. Points are in local coordinate space. </description> </method> <method name="get_closest_point_owner"> @@ -24,6 +26,7 @@ <argument index="0" name="to_point" type="Vector2"> </argument> <description> + Returns the owner of the [NavigationPolygon] which contains the navigation point closest to the point given. This is usually a [NavigtionPolygonInstance]. For polygons added via [method navpoly_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). </description> </method> <method name="get_simple_path"> @@ -36,6 +39,7 @@ <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. </description> </method> <method name="navpoly_add"> @@ -48,6 +52,7 @@ <argument index="2" name="owner" type="Object" default="null"> </argument> <description> + Adds a [NavigationPolygon]. Returns an ID for use with [method navpoly_remove] or [method navpoly_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. </description> </method> <method name="navpoly_remove"> @@ -56,6 +61,7 @@ <argument index="0" name="id" type="int"> </argument> <description> + Removes the [NavigationPolygon] with the given ID. </description> </method> <method name="navpoly_set_transform"> @@ -66,6 +72,7 @@ <argument index="1" name="xform" type="Transform2D"> </argument> <description> + Sets the transform applied to the [NavigationPolygon] with the given ID. </description> </method> </methods> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 9129f64340..5d0f70bc59 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -453,7 +453,30 @@ <return type="void"> </return> <description> - Prints the scene hierarchy of this node and all it's children to stdout. Used mainly for debugging purposes. + Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. Example output: + [codeblock] + TheGame + TheGame/Menu + TheGame/Menu/Label + TheGame/Menu/Camera2D + TheGame/SplashScreen + TheGame/SplashScreen/Camera2D + [/codeblock] + </description> + </method> + <method name="print_tree_pretty"> + <return type="void"> + </return> + <description> + Similar to [method print_tree], this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output: + [codeblock] + ┖╴TheGame + ┠╴Menu + ┃ ┠╴Label + ┃ ┖╴Camera2D + ┖-SplashScreen + ┖╴Camera2D + [/codeblock] </description> </method> <method name="propagate_call"> @@ -739,9 +762,13 @@ </method> </methods> <members> + <member name="custom_multiplayer_api" type="MultiplayerAPI" setter="set_custom_multiplayer_api" getter="get_custom_multiplayer_api"> + </member> <member name="filename" type="String" setter="set_filename" getter="get_filename"> When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. </member> + <member name="multiplayer_api" type="MultiplayerAPI" setter="" getter="get_multiplayer_api"> + </member> <member name="name" type="String" setter="set_name" getter="get_name"> The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed </member> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index a98385f1d2..d38a89874c 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -40,6 +40,7 @@ <return type="void"> </return> <description> + Centers the window on the screen if in windowed mode. </description> </method> <method name="delay_msec" qualifiers="const"> @@ -48,7 +49,7 @@ <argument index="0" name="msec" type="int"> </argument> <description> - Delay executing of the current thread by given milliseconds. + Delay execution of the current thread by given milliseconds. </description> </method> <method name="delay_usec" qualifiers="const"> @@ -57,7 +58,7 @@ <argument index="0" name="usec" type="int"> </argument> <description> - Delay executing of the current thread by given microseconds. + Delay execution of the current thread by given microseconds. </description> </method> <method name="dump_memory_to_file"> @@ -67,7 +68,7 @@ </argument> <description> Dumps the memory allocation ringlist to a file (only works in debug). - Entry format per line: "Address - Size - Description" + Entry format per line: "Address - Size - Description". </description> </method> <method name="dump_resources_to_file"> @@ -77,7 +78,7 @@ </argument> <description> Dumps all used resources to file (only works in debug). - Entry format per line: "Resource Type : Resource Location" + Entry format per line: "Resource Type : Resource Location". At the end of the file is a statistic of all used Resource Types. </description> </method> @@ -116,6 +117,22 @@ Returns the scancode of the given string (e.g. "Escape") </description> </method> + <method name="get_audio_driver_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the total number of available audio drivers. + </description> + </method> + <method name="get_audio_driver_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="driver" type="int"> + </argument> + <description> + Returns the audio driver name for the given index. + </description> + </method> <method name="get_cmdline_args"> <return type="PoolStringArray"> </return> @@ -242,6 +259,7 @@ <return type="Vector2"> </return> <description> + Returns the window size including decorations like window borders. </description> </method> <method name="get_scancode_string" qualifiers="const"> @@ -366,7 +384,7 @@ <return type="int"> </return> <description> - Return the current unix timestamp. + Returns the current unix epoch timestamp. </description> </method> <method name="get_unix_time_from_datetime" qualifiers="const"> @@ -391,10 +409,25 @@ If the project name is empty, [code]user://[/code] falls back to [code]res://[/code]. </description> </method> + <method name="get_video_driver_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_video_driver_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="driver" type="int"> + </argument> + <description> + </description> + </method> <method name="get_virtual_keyboard_height"> <return type="int"> </return> <description> + Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. </description> </method> <method name="has_environment" qualifiers="const"> @@ -412,6 +445,7 @@ <argument index="0" name="tag_name" type="String"> </argument> <description> + Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. See feature tags documentation. </description> </method> <method name="has_touchscreen_ui_hint" qualifiers="const"> @@ -478,6 +512,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if the window should always be on top of other windows. </description> </method> <method name="kill"> @@ -614,6 +649,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + Sets whether the window should always be on top. </description> </method> <method name="set_window_title"> @@ -654,27 +690,31 @@ The current screen index (starting from 0). </member> <member name="exit_code" type="int" setter="set_exit_code" getter="get_exit_code"> + The exit code passed to the OS when the main loop exits. </member> <member name="keep_screen_on" type="bool" setter="set_keep_screen_on" getter="is_keep_screen_on"> + If [code]true[/code] the engine tries to keep the screen on while the game is running. Useful on mobile. </member> <member name="low_processor_usage_mode" type="bool" setter="set_low_processor_usage_mode" getter="is_in_low_processor_usage_mode"> + If [code]true[/code] the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. </member> - <member name="screen_orientation" type="int" setter="set_screen_orientation" getter="get_screen_orientation" enum="_OS.ScreenOrientation"> + <member name="screen_orientation" type="int" setter="set_screen_orientation" getter="get_screen_orientation" enum="OS.ScreenOrientation"> The current screen orientation. </member> <member name="vsync_enabled" type="bool" setter="set_use_vsync" getter="is_vsync_enabled"> + If [code]true[/code] vertical synchronization (Vsync) is enabled. </member> <member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window"> - If [code]true[/code], removes the window frame. + If [code]true[/code] removes the window frame. </member> <member name="window_fullscreen" type="bool" setter="set_window_fullscreen" getter="is_window_fullscreen"> - If [code]true[/code], the window is fullscreen. + If [code]true[/code] the window is fullscreen. </member> <member name="window_maximized" type="bool" setter="set_window_maximized" getter="is_window_maximized"> - If [code]true[/code], the window is maximized. + If [code]true[/code] the window is maximized. </member> <member name="window_minimized" type="bool" setter="set_window_minimized" getter="is_window_minimized"> - If [code]true[/code], the window is minimized. + If [code]true[/code] the window is minimized. </member> <member name="window_position" type="Vector2" setter="set_window_position" getter="get_window_position"> The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. @@ -688,82 +728,121 @@ </members> <constants> <constant name="DAY_SUNDAY" value="0" enum="Weekday"> + Sunday. </constant> <constant name="DAY_MONDAY" value="1" enum="Weekday"> + Monday. </constant> <constant name="DAY_TUESDAY" value="2" enum="Weekday"> + Tuesday. </constant> <constant name="DAY_WEDNESDAY" value="3" enum="Weekday"> + Wednesday. </constant> <constant name="DAY_THURSDAY" value="4" enum="Weekday"> + Thursday. </constant> <constant name="DAY_FRIDAY" value="5" enum="Weekday"> + Friday. </constant> <constant name="DAY_SATURDAY" value="6" enum="Weekday"> + Saturday. </constant> <constant name="MONTH_JANUARY" value="1" enum="Month"> + January. </constant> <constant name="MONTH_FEBRUARY" value="2" enum="Month"> + February. </constant> <constant name="MONTH_MARCH" value="3" enum="Month"> + March. </constant> <constant name="MONTH_APRIL" value="4" enum="Month"> + April. </constant> <constant name="MONTH_MAY" value="5" enum="Month"> + May. </constant> <constant name="MONTH_JUNE" value="6" enum="Month"> + June. </constant> <constant name="MONTH_JULY" value="7" enum="Month"> + July. </constant> <constant name="MONTH_AUGUST" value="8" enum="Month"> + August. </constant> <constant name="MONTH_SEPTEMBER" value="9" enum="Month"> + September. </constant> <constant name="MONTH_OCTOBER" value="10" enum="Month"> + October. </constant> <constant name="MONTH_NOVEMBER" value="11" enum="Month"> + November. </constant> <constant name="MONTH_DECEMBER" value="12" enum="Month"> + December. </constant> <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0" enum="ScreenOrientation"> + Landscape screen orientation. </constant> <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1" enum="ScreenOrientation"> + Portrait screen orientation. </constant> <constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2" enum="ScreenOrientation"> + Reverse landscape screen orientation. </constant> <constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3" enum="ScreenOrientation"> + Reverse portrait screen orientation. </constant> <constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4" enum="ScreenOrientation"> + Uses landscape or reverse landscape based on the hardware sensor. </constant> <constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5" enum="ScreenOrientation"> + Uses portrait or reverse portrait based on the hardware sensor. </constant> <constant name="SCREEN_ORIENTATION_SENSOR" value="6" enum="ScreenOrientation"> + Uses most suitable orientation based on the hardware sensor. </constant> <constant name="SYSTEM_DIR_DESKTOP" value="0" enum="SystemDir"> + Desktop directory path. </constant> <constant name="SYSTEM_DIR_DCIM" value="1" enum="SystemDir"> + DCIM (Digital Camera Images) directory path. </constant> <constant name="SYSTEM_DIR_DOCUMENTS" value="2" enum="SystemDir"> + Documents directory path. </constant> <constant name="SYSTEM_DIR_DOWNLOADS" value="3" enum="SystemDir"> + Downloads directory path. </constant> <constant name="SYSTEM_DIR_MOVIES" value="4" enum="SystemDir"> + Movies directory path. </constant> <constant name="SYSTEM_DIR_MUSIC" value="5" enum="SystemDir"> + Music directory path. </constant> <constant name="SYSTEM_DIR_PICTURES" value="6" enum="SystemDir"> + Pictures directory path. </constant> <constant name="SYSTEM_DIR_RINGTONES" value="7" enum="SystemDir"> + Ringtones directory path. </constant> <constant name="POWERSTATE_UNKNOWN" value="0" enum="PowerState"> + Unknown powerstate. </constant> <constant name="POWERSTATE_ON_BATTERY" value="1" enum="PowerState"> + Unplugged, running on battery. </constant> <constant name="POWERSTATE_NO_BATTERY" value="2" enum="PowerState"> + Plugged in, no battery available. </constant> <constant name="POWERSTATE_CHARGING" value="3" enum="PowerState"> + Plugged in, battery charging. </constant> <constant name="POWERSTATE_CHARGED" value="4" enum="PowerState"> + Plugged in, battery fully charged. </constant> </constants> </class> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index de6f60c384..8cb53dd98e 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -194,6 +194,13 @@ </member> </members> <signals> + <signal name="item_focused"> + <argument index="0" name="ID" type="int"> + </argument> + <description> + This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). + </description> + </signal> <signal name="item_selected"> <argument index="0" name="ID" type="int"> </argument> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 70e6fab5b6..166a4be2b0 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -108,6 +108,31 @@ Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. </description> </method> + <method name="add_radio_check_item"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="accel" type="int" default="0"> + </argument> + <description> + The same as [method add_check_item] but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + </description> + </method> + <method name="add_radio_check_shortcut"> + <return type="void"> + </return> + <argument index="0" name="shortcut" type="ShortCut"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> <method name="add_separator"> <return type="void"> </return> @@ -239,7 +264,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="is_item_checked" qualifiers="const"> @@ -248,7 +273,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the checkstate status of the item at index "idx". + Return whether the item at index "idx" is checked. </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -260,6 +285,15 @@ Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. </description> </method> + <method name="is_item_radio_checkable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + </description> + </method> <method name="is_item_separator" qualifiers="const"> <return type="bool"> </return> @@ -300,6 +334,18 @@ Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> + <method name="set_item_as_radio_checkable"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + The same as [method set_item_as_checkable] but placing a radio button in case of enabling. If used for disabling, it's the same. + Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. + </description> + </method> <method name="set_item_as_separator"> <return type="void"> </return> @@ -445,6 +491,13 @@ </member> </members> <signals> + <signal name="id_focused"> + <argument index="0" name="ID" type="int"> + </argument> + <description> + This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action. + </description> + </signal> <signal name="id_pressed"> <argument index="0" name="ID" type="int"> </argument> @@ -483,6 +536,10 @@ </theme_item> <theme_item name="panel_disabled" type="StyleBox"> </theme_item> + <theme_item name="radio_checked" type="Texture"> + </theme_item> + <theme_item name="radio_unchecked" type="Texture"> + </theme_item> <theme_item name="separator" type="StyleBox"> </theme_item> <theme_item name="submenu" type="Texture"> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 3a258011b2..33f2b9758b 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -10,6 +10,7 @@ It can be used to perform SLERP (spherical-linear interpolation) between two rotations. </description> <tutorials> + http://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions </tutorials> <demos> </demos> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index be90288308..8846616851 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -1,12 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SceneTree" inherits="MainLoop" category="Core" version="3.1"> <brief_description> + SceneTree manages a hierarchy of nodes. </brief_description> <description> + As one of the most important classes, the [code]SceneTree[/code] manages the hierarchy of nodes in a scene as well as scenes themselves. Nodes can be added, retrieved and removed. The whole scene tree (and thus the current scene) can be paused. Scenes can be loaded, switched and reloaded. You can also use the SceneTree to organize your nodes into groups: every node can be assigned as many groups as you want to create, e.g. a "enemy" group. You can then iterate these groups or even call methods and set properties on all the group's members at once. </description> <tutorials> http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scene_tree.html - http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html + http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html </tutorials> <demos> </demos> @@ -19,6 +21,7 @@ <argument index="1" name="method" type="String"> </argument> <description> + Calls [code]method[/code] on each member of the given group. </description> </method> <method name="call_group_flags" qualifiers="vararg"> @@ -31,6 +34,7 @@ <argument index="2" name="method" type="String"> </argument> <description> + Calls [code]method[/code] on each member of the given group, respecting the given [enum GROUP_CALL] flags. </description> </method> <method name="change_scene"> @@ -39,6 +43,7 @@ <argument index="0" name="path" type="String"> </argument> <description> + Changes to the scene at the given [code]path[/code]. </description> </method> <method name="change_scene_to"> @@ -47,6 +52,7 @@ <argument index="0" name="packed_scene" type="PackedScene"> </argument> <description> + Changes to the given [PackedScene]. </description> </method> <method name="create_timer"> @@ -57,6 +63,7 @@ <argument index="1" name="pause_mode_process" type="bool" default="true"> </argument> <description> + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this SceneTree. If [code]pause_mode_process[/code] is set to false, pausing the SceneTree will also pause the timer. </description> </method> <method name="get_frame" qualifiers="const"> @@ -69,18 +76,21 @@ <return type="PoolIntArray"> </return> <description> + Returns the peer IDs of all connected peers of this SceneTree's [member network_peer]. </description> </method> <method name="get_network_unique_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the unique peer ID of this SceneTree's [member network_peer]. </description> </method> <method name="get_node_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of nodes in this SceneTree. </description> </method> <method name="get_nodes_in_group"> @@ -89,12 +99,14 @@ <argument index="0" name="group" type="String"> </argument> <description> + Returns all nodes assigned to the given group. </description> </method> <method name="get_rpc_sender_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the sender's peer ID for the most recently received RPC call. </description> </method> <method name="has_group" qualifiers="const"> @@ -103,26 +115,28 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns [code]true[/code] if the given group exists. </description> </method> <method name="has_network_peer" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). + Returns [code]true[/code] if there is a [member network_peer] set. </description> </method> <method name="is_input_handled"> <return type="bool"> </return> <description> + Returns [code]true[/code] if the most recent InputEvent was marked as handled with [method set_input_as_handled]. </description> </method> <method name="is_network_server" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). + Returns [code]true[/code] if this SceneTree's [member network_peer] is in server mode (listening for connections). </description> </method> <method name="notify_group"> @@ -133,6 +147,7 @@ <argument index="1" name="notification" type="int"> </argument> <description> + Sends the given notification to all members of the [code]group[/code]. </description> </method> <method name="notify_group_flags"> @@ -145,6 +160,7 @@ <argument index="2" name="notification" type="int"> </argument> <description> + Sends the given notification to all members of the [code]group[/code], respecting the given [enum GROUP_CALL] flags. </description> </method> <method name="queue_delete"> @@ -153,18 +169,21 @@ <argument index="0" name="obj" type="Object"> </argument> <description> + Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame. </description> </method> <method name="quit"> <return type="void"> </return> <description> + Quits the application. </description> </method> <method name="reload_current_scene"> <return type="int" enum="Error"> </return> <description> + Reloads the currently active scene. </description> </method> <method name="set_auto_accept_quit"> @@ -173,6 +192,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the application automatically accepts quitting. </description> </method> <method name="set_group"> @@ -185,6 +205,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. </description> </method> <method name="set_group_flags"> @@ -199,12 +220,14 @@ <argument index="3" name="value" type="Variant"> </argument> <description> + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GROUP_CALL] flags. </description> </method> <method name="set_input_as_handled"> <return type="void"> </return> <description> + Marks the most recent input event as handled. </description> </method> <method name="set_quit_on_go_back"> @@ -213,6 +236,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] the application quits automatically on going back (e.g. on Android). </description> </method> <method name="set_screen_stretch"> @@ -227,37 +251,48 @@ <argument index="3" name="shrink" type="float" default="1"> </argument> <description> + Configures screen stretching to the given [enum StretchMode], [enum StretchAspect], minimum size and [code]shrink[/code]. </description> </method> </methods> <members> <member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene"> + The current scene. </member> <member name="debug_collisions_hint" type="bool" setter="set_debug_collisions_hint" getter="is_debugging_collisions_hint"> </member> <member name="debug_navigation_hint" type="bool" setter="set_debug_navigation_hint" getter="is_debugging_navigation_hint"> </member> <member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root"> + The root of the edited scene. + </member> + <member name="multiplayer_api" type="MultiplayerAPI" setter="set_multiplayer_api" getter="get_multiplayer_api"> </member> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. </member> <member name="paused" type="bool" setter="set_pause" getter="is_paused"> + If [code]true[/code] the SceneTree is paused. </member> <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections"> + If [code]true[/code] the SceneTree's [member network_peer] refuses new incoming connections. </member> <member name="root" type="Viewport" setter="" getter="get_root"> + The SceneTree's [Viewport]. </member> <member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling"> + If [code]true[/code] font oversampling is used. </member> </members> <signals> <signal name="connected_to_server"> <description> + Emitted whenever this SceneTree's [member network_peer] successfully connected to a server. Only emitted on clients. </description> </signal> <signal name="connection_failed"> <description> + Emitted whenever this SceneTree's [member network_peer] fails to establish a connection to a server. Only emitted on clients. </description> </signal> <signal name="files_dropped"> @@ -266,56 +301,67 @@ <argument index="1" name="screen" type="int"> </argument> <description> + Emitted whenever files are drag-and-dropped onto the window. </description> </signal> <signal name="idle_frame"> <description> + Emitted immediately before [method Node._process] is called on every node in the SceneTree. </description> </signal> <signal name="network_peer_connected"> <argument index="0" name="id" type="int"> </argument> <description> + Emitted whenever this SceneTree's [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). </description> </signal> <signal name="network_peer_disconnected"> <argument index="0" name="id" type="int"> </argument> <description> + Emitted whenever this SceneTree's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. </description> </signal> <signal name="node_added"> <argument index="0" name="node" type="Object"> </argument> <description> + Emitted whenever a node is added to the SceneTree. </description> </signal> <signal name="node_configuration_warning_changed"> <argument index="0" name="node" type="Object"> </argument> <description> + Emitted when a node's configuration changed. Only emitted in tool mode. </description> </signal> <signal name="node_removed"> <argument index="0" name="node" type="Object"> </argument> <description> + Emitted whenever a node is removed from the SceneTree. </description> </signal> <signal name="physics_frame"> <description> + Emitted immediately before [method Node._physics_process] is called on every node in the SceneTree. </description> </signal> <signal name="screen_resized"> <description> + Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. </description> </signal> <signal name="server_disconnected"> <description> + Emitted whenever this SceneTree's [member network_peer] disconnected from server. Only emitted on clients. </description> </signal> <signal name="tree_changed"> <description> + Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.). </description> </signal> </signals> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 79b70fec99..28fbdea58d 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -13,6 +13,8 @@ <methods> </methods> <members> + <member name="scroll_deadzone" type="int" setter="set_deadzone" getter="get_deadzone"> + </member> <member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll"> The current horizontal scroll value. </member> @@ -26,6 +28,16 @@ If [code]true[/code], enables vertical scrolling. </member> </members> + <signals> + <signal name="scroll_ended"> + <description> + </description> + </signal> + <signal name="scroll_started"> + <description> + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index d8644c5419..7d78d71330 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -196,8 +196,11 @@ <method name="generate_normals"> <return type="void"> </return> + <argument index="0" name="flip" type="bool" default="false"> + </argument> <description> Generates normals from Vertices so you do not have to do it manually. + Setting "flip" [code]true[/code] inverts resulting normals. </description> </method> <method name="generate_tangents"> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 330487adf7..11e94abc03 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -78,6 +78,12 @@ Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> + <method name="get_tabs_rearrange_group" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_popup"> <return type="void"> </return> @@ -120,11 +126,21 @@ Sets a title for the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. </description> </method> + <method name="set_tabs_rearrange_group"> + <return type="void"> + </return> + <argument index="0" name="group_id" type="int"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> The current tab index. When set, this index's [Control] node's [code]visible[/code] property is set to [code]true[/code] and all others are set to [code]false[/code]. </member> + <member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled"> + </member> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign"> The alignment of all tabs in the tab container. See the [code]ALIGN_*[/code] constants for details. </member> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 615bc83c2d..0d5f1f0ba9 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -80,6 +80,12 @@ <description> </description> </method> + <method name="get_tabs_rearrange_group" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="move_tab"> <return type="void"> </return> @@ -129,10 +135,20 @@ <description> </description> </method> + <method name="set_tabs_rearrange_group"> + <return type="void"> + </return> + <argument index="0" name="group_id" type="int"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> </member> + <member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled"> + </member> <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled"> </member> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 8a71cb2059..76d94fbfbc 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -130,6 +130,14 @@ <description> </description> </method> + <method name="get_keyword_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="keyword" type="String"> + </argument> + <description> + </description> + </method> <method name="get_line" qualifiers="const"> <return type="String"> </return> @@ -193,6 +201,14 @@ <description> </description> </method> + <method name="has_keyword_color" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="keyword" type="String"> + </argument> + <description> + </description> + </method> <method name="insert_text_at_cursor"> <return type="void"> </return> diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 18bd886b0b..2ae4ef2cf8 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -51,6 +51,12 @@ <member name="texture_under" type="Texture" setter="set_under_texture" getter="get_under_texture"> [Texture] that draws under the progress bar. The bar's background. </member> + <member name="tint_over" type="Color" setter="set_tint_over" getter="get_tint_over"> + </member> + <member name="tint_progress" type="Color" setter="set_tint_progress" getter="get_tint_progress"> + </member> + <member name="tint_under" type="Color" setter="set_tint_under" getter="get_tint_under"> + </member> </members> <constants> <constant name="FILL_LEFT_TO_RIGHT" value="0" enum="FillMode"> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 10978970e9..4e218f5595 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -254,6 +254,14 @@ Return the texture offset of the tile. </description> </method> + <method name="tile_get_tile_mode" qualifiers="const"> + <return type="int" enum="TileSet.TileMode"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> <method name="tile_set_light_occluder"> <return type="void"> </return> @@ -410,6 +418,16 @@ Set the texture offset of the tile. </description> </method> + <method name="tile_set_tile_mode"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="tilemode" type="int" enum="TileSet.TileMode"> + </argument> + <description> + </description> + </method> </methods> <constants> <constant name="BITMASK_2X2" value="0" enum="BitmaskMode"> @@ -432,5 +450,11 @@ </constant> <constant name="BIND_BOTTOMRIGHT" value="256" enum="AutotileBindings"> </constant> + <constant name="SINGLE_TILE" value="0" enum="TileMode"> + </constant> + <constant name="AUTO_TILE" value="1" enum="TileMode"> + </constant> + <constant name="ANIMATED_TILE" value="2" enum="TileMode"> + </constant> </constants> </class> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index df5c2ab3ae..d9f9d8cc73 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -8,6 +8,7 @@ </description> <tutorials> http://docs.godotengine.org/en/3.0/tutorials/math/index.html + http://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html </tutorials> <demos> </demos> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index b293ec3368..5ffe807606 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -84,10 +84,10 @@ <method name="cross"> <return type="float"> </return> - <argument index="0" name="b" type="Vector2"> + <argument index="0" name="with" type="Vector2"> </argument> <description> - Returns the 2-dimensional analog of the cross product with [code]b[/code]. + Returns the 2-dimensional analog of the cross product with the given Vector2. </description> </method> <method name="cubic_interpolate"> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 48d09ccd95..d2639590a1 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -72,6 +72,12 @@ <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> </member> </members> + <signals> + <signal name="finished"> + <description> + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/WebSocketClient.xml b/doc/classes/WebSocketClient.xml index 79313c90c7..496baa5787 100644 --- a/doc/classes/WebSocketClient.xml +++ b/doc/classes/WebSocketClient.xml @@ -28,6 +28,10 @@ </description> </method> </methods> + <members> + <member name="verify_ssl" type="bool" setter="set_verify_ssl_enabled" getter="is_verify_ssl_enabled"> + </member> + </members> <signals> <signal name="connection_closed"> <description> |