gaming/godot
gaming/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot synced 2024-09-04 21:18:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2018-04-10 10:12:42 +02:00
parent cb996d7169
commit cb7fe2c793
30 changed files with 478 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
doc/classes/ARVRServer.xml
View file

@ -36,6 +36,12 @@
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>
</description>
</method>
<method name="get_interface" qualifiers="const">
<return type="ARVRInterface">
</return>
@ -59,6 +65,30 @@
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_primary_interface" qualifiers="const">
<return type="ARVRInterface">
</return>
<description>
</description>
</method>
<method name="get_reference_frame" qualifiers="const">
<return type="Transform">
</return>

1
doc/classes/AnimationPlayer.xml
View file

@ -110,7 +110,6 @@
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>

5
doc/classes/Array.xml
View file

@ -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">

20
doc/classes/AudioServer.xml
View file

@ -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>

4
doc/classes/Camera.xml
View file

@ -14,8 +14,10 @@
<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 it is inside the node tree and [code]enabled_next[/code] is [code]true[/true], request to make the next Camera current, if any.
</description>
</method>
<method name="get_camera_transform" qualifiers="const">

6
doc/classes/CanvasLayer.xml
View file

@ -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>

6
doc/classes/Control.xml
View file

@ -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>

2
doc/classes/Dictionary.xml
View file

@ -19,6 +19,8 @@
<method name="duplicate">
<return type="Dictionary">
</return>
<argument index="0" name="deep" type="bool" default="False">
</argument>
<description>
</description>
</method>

22
doc/classes/EditorPlugin.xml
View file

@ -102,6 +102,20 @@
<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>
</description>
</method>
<method name="add_tool_submenu_item">
<return type="void">
</return>
@ -347,6 +361,14 @@
<description>
</description>
</method>
<method name="remove_tool_menu_item">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="save_external_data" qualifiers="virtual">
<return type="void">
</return>

4
doc/classes/File.xml
View file

@ -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>

78
doc/classes/Image.xml
View file

@ -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>

2
doc/classes/Input.xml
View file

@ -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>

22
doc/classes/ItemList.xml
View file

@ -144,6 +144,12 @@
Returns the current vertical scroll bar for the List.
</description>
</method>
<method name="is_anything_selected">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_item_disabled" qualifiers="const">
<return type="bool">
</return>
@ -180,6 +186,16 @@
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="p_from_idx" type="int">
</argument>
<argument index="1" name="p_to_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="remove_item">
<return type="void">
</return>
@ -326,6 +342,12 @@
Ensure item at specified index is not selected.
</description>
</method>
<method name="unselect_all">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect">

131
doc/classes/MultiplayerAPI.xml Normal file
View file

@ -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>

2
doc/classes/Navigation.xml
View file

@ -100,7 +100,7 @@
</methods>
<members>
<member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector">
Defines which direction is up. By default this is [code](0, 1, 0)[/code], which is the world up direction.
Defines which direction is up. By default this is [code](0, 1, 0)[/code], which is the world up direction.
</member>
</members>
<constants>

4
doc/classes/Node.xml
View file

@ -762,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>

28
doc/classes/OS.xml
View file

@ -116,6 +116,20 @@
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>
</description>
</method>
<method name="get_audio_driver_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="get_cmdline_args">
<return type="PoolStringArray">
</return>
@ -391,6 +405,20 @@
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="arg0" type="int">
</argument>
<description>
</description>
</method>
<method name="get_virtual_keyboard_height">
<return type="int">
</return>

6
doc/classes/OptionButton.xml
View file

@ -194,6 +194,12 @@
</member>
</members>
<signals>
<signal name="item_focused">
<argument index="0" name="ID" type="int">
</argument>
<description>
</description>
</signal>
<signal name="item_selected">
<argument index="0" name="ID" type="int">
</argument>

93
doc/classes/PopupMenu.xml
View file

@ -24,19 +24,6 @@
Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. 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="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_check_shortcut">
<return type="void">
</return>
@ -49,18 +36,6 @@
<description>
</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_icon_check_item">
<return type="void">
</return>
@ -77,21 +52,6 @@
created from the index. 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="add_icon_radio_check_item">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<argument index="1" name="label" type="String">
</argument>
<argument index="2" name="id" type="int" default="-1">
</argument>
<argument index="3" name="accel" type="int" default="0">
</argument>
<description>
The same as [method add_icon_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_icon_check_shortcut">
<return type="void">
</return>
@ -148,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>
@ -282,15 +267,6 @@
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_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_checked" qualifiers="const">
<return type="bool">
</return>
@ -309,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>
@ -506,6 +491,12 @@
</member>
</members>
<signals>
<signal name="id_focused">
<argument index="0" name="ID" type="int">
</argument>
<description>
</description>
</signal>
<signal name="id_pressed">
<argument index="0" name="ID" type="int">
</argument>
@ -544,6 +535,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">

4
doc/classes/SceneTree.xml
View file

@ -266,6 +266,8 @@
<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>
@ -359,7 +361,7 @@
</signal>
<signal name="tree_changed">
<description>
Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.).
Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.).
</description>
</signal>
</signals>

12
doc/classes/ScrollContainer.xml
View file

@ -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>

16
doc/classes/TabContainer.xml
View file

@ -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>

16
doc/classes/Tabs.xml
View file

@ -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">

16
doc/classes/TextEdit.xml
View file

@ -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>

6
doc/classes/TextureProgress.xml
View file

@ -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">

24
doc/classes/TileSet.xml
View file

@ -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>

2
doc/classes/Vector2.xml
View file

@ -84,7 +84,7 @@
<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].

6
doc/classes/VideoPlayer.xml
View file

@ -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>

4
doc/classes/WebSocketClient.xml
View file

@ -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>

8
modules/gdnative/doc_classes/GDNativeLibrary.xml
View file

@ -9,12 +9,6 @@
<demos>
</demos>
<methods>
<method name="get_config_file">
<return type="ConfigFile">
</return>
<description>
</description>
</method>
<method name="get_current_dependencies" qualifiers="const">
<return type="PoolStringArray">
</return>
@ -29,6 +23,8 @@
</method>
</methods>
<members>
<member name="config_file" type="ConfigFile" setter="set_config_file" getter="get_config_file">
</member>
<member name="load_once" type="bool" setter="set_load_once" getter="should_load_once">
</member>
<member name="reloadable" type="bool" setter="set_reloadable" getter="is_reloadable">