浏览代码

doc: Sync classref with current source

Rémi Verschelde 7 年之前
父节点
当前提交
fee29570d0

+ 4 - 4
doc/classes/@GDScript.xml

@@ -20,7 +20,7 @@
 			</argument>
 			</argument>
 			<argument index="2" name="b8" type="int">
 			<argument index="2" name="b8" type="int">
 			</argument>
 			</argument>
-			<argument index="3" name="a8" type="int">
+			<argument index="3" name="a8" type="int" default="255">
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255.
 				Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255.
@@ -38,7 +38,7 @@
 			</return>
 			</return>
 			<argument index="0" name="name" type="String">
 			<argument index="0" name="name" type="String">
 			</argument>
 			</argument>
-			<argument index="1" name="alpha" type="float">
+			<argument index="1" name="alpha" type="float" default="1.0">
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Returns a color according to the standardised [code]name[/code] with [code]alpha[/code] ranging from 0 to 1.
 				Returns a color according to the standardised [code]name[/code] with [code]alpha[/code] ranging from 0 to 1.
@@ -1131,9 +1131,9 @@
 		<method name="yield">
 		<method name="yield">
 			<return type="GDScriptFunctionState">
 			<return type="GDScriptFunctionState">
 			</return>
 			</return>
-			<argument index="0" name="object" type="Object">
+			<argument index="0" name="object" type="Object" default="null">
 			</argument>
 			</argument>
-			<argument index="1" name="signal" type="String">
+			<argument index="1" name="signal" type="String" default="&quot;&quot;">
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state.
 				Stops the function execution and returns the current state. Call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state.

+ 10 - 0
doc/classes/ArrayMesh.xml

@@ -66,6 +66,16 @@
 				Return the amount of surfaces that the [code]ArrayMesh[/code] holds.
 				Return the amount of surfaces that the [code]ArrayMesh[/code] holds.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="lightmap_unwrap">
+			<return type="int" enum="Error">
+			</return>
+			<argument index="0" name="arg0" type="Transform">
+			</argument>
+			<argument index="1" name="arg1" type="float">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="regen_normalmaps">
 		<method name="regen_normalmaps">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>

+ 6 - 0
doc/classes/AudioStream.xml

@@ -12,6 +12,12 @@
 	<demos>
 	<demos>
 	</demos>
 	</demos>
 	<methods>
 	<methods>
+		<method name="get_length" qualifiers="const">
+			<return type="float">
+			</return>
+			<description>
+			</description>
+		</method>
 	</methods>
 	</methods>
 	<constants>
 	<constants>
 	</constants>
 	</constants>

+ 2 - 0
doc/classes/AudioStreamPlayer.xml

@@ -56,6 +56,8 @@
 		<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget">
 		<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget">
 			If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants.
 			If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants.
 		</member>
 		</member>
+		<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
+		</member>
 		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
 		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
 			If [code]true[/code] audio is playing.
 			If [code]true[/code] audio is playing.
 		</member>
 		</member>

+ 2 - 0
doc/classes/AudioStreamPlayer2D.xml

@@ -62,6 +62,8 @@
 		<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
 		<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
 			Maximum distance from which audio is still hearable.
 			Maximum distance from which audio is still hearable.
 		</member>
 		</member>
+		<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
+		</member>
 		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
 		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
 			If [code]true[/code] audio is playing.
 			If [code]true[/code] audio is playing.
 		</member>
 		</member>

+ 2 - 0
doc/classes/AudioStreamPlayer3D.xml

@@ -86,6 +86,8 @@
 		<member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode">
 		<member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode">
 			Decides if audio should pause when source is outside of 'max_distance' range.
 			Decides if audio should pause when source is outside of 'max_distance' range.
 		</member>
 		</member>
+		<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
+		</member>
 		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
 		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
 			If [code]true[/code], audio is playing.
 			If [code]true[/code], audio is playing.
 		</member>
 		</member>

+ 26 - 0
doc/classes/OS.xml

@@ -36,6 +36,12 @@
 				Returns [code]true[/code] if the current host platform is using multiple threads.
 				Returns [code]true[/code] if the current host platform is using multiple threads.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="center_window">
+			<return type="void">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="delay_msec" qualifiers="const">
 		<method name="delay_msec" qualifiers="const">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
@@ -232,6 +238,12 @@
 				Returns the number of cores available in the host machine.
 				Returns the number of cores available in the host machine.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="get_real_window_size" qualifiers="const">
+			<return type="Vector2">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_scancode_string" qualifiers="const">
 		<method name="get_scancode_string" qualifiers="const">
 			<return type="String">
 			<return type="String">
 			</return>
 			</return>
@@ -458,6 +470,12 @@
 				If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable.
 				If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="is_window_always_on_top" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="kill">
 		<method name="kill">
 			<return type="int" enum="Error">
 			<return type="int" enum="Error">
 			</return>
 			</return>
@@ -586,6 +604,14 @@
 				Enables backup saves if [code]enabled[/code] is [code]true[/code].
 				Enables backup saves if [code]enabled[/code] is [code]true[/code].
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="set_window_always_on_top">
+			<return type="void">
+			</return>
+			<argument index="0" name="enabled" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_window_title">
 		<method name="set_window_title">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>

+ 10 - 10
doc/classes/StreamPeerTCP.xml

@@ -29,16 +29,6 @@
 				Disconnect from host.
 				Disconnect from host.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="set_no_delay">
-			<return type="void">
-			</return>
-			<argument index="0" name="enabled" type="bool">
-			</argument>
-			<description>
-				Disable Nagle algorithm to improve latency for small packets.
-				Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.
-			</description>
-		</method>
 		<method name="get_connected_host" qualifiers="const">
 		<method name="get_connected_host" qualifiers="const">
 			<return type="String">
 			<return type="String">
 			</return>
 			</return>
@@ -66,6 +56,16 @@
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="set_no_delay">
+			<return type="void">
+			</return>
+			<argument index="0" name="enabled" type="bool">
+			</argument>
+			<description>
+				Disable Nagle algorithm to improve latency for small packets.
+				Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.
+			</description>
+		</method>
 	</methods>
 	</methods>
 	<constants>
 	<constants>
 		<constant name="STATUS_NONE" value="0" enum="Status">
 		<constant name="STATUS_NONE" value="0" enum="Status">

+ 1 - 1
doc/classes/Viewport.xml

@@ -302,7 +302,7 @@
 			Amount of objects in frame.
 			Amount of objects in frame.
 		</constant>
 		</constant>
 		<constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
 		<constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
-			Amount of vertices in frame. 
+			Amount of vertices in frame.
 		</constant>
 		</constant>
 		<constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
 		<constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
 			Amount of material changes in frame.
 			Amount of material changes in frame.

文件差异内容过多而无法显示
+ 1868 - 194
doc/classes/VisualServer.xml


+ 53 - 0
doc/classes/WebSocketClient.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WebSocketClient" inherits="WebSocketMultiplayerPeer" category="Core" version="3.1-dev">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<demos>
+	</demos>
+	<methods>
+		<method name="connect_to_url">
+			<return type="int" enum="Error">
+			</return>
+			<argument index="0" name="url" type="String">
+			</argument>
+			<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray(  )">
+			</argument>
+			<argument index="2" name="gd_mp_api" type="bool" default="false">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="disconnect_from_host">
+			<return type="void">
+			</return>
+			<description>
+			</description>
+		</method>
+	</methods>
+	<signals>
+		<signal name="connection_closed">
+			<description>
+			</description>
+		</signal>
+		<signal name="connection_error">
+			<description>
+			</description>
+		</signal>
+		<signal name="connection_established">
+			<argument index="0" name="protocol" type="String">
+			</argument>
+			<description>
+			</description>
+		</signal>
+		<signal name="data_received">
+			<description>
+			</description>
+		</signal>
+	</signals>
+	<constants>
+	</constants>
+</class>

+ 31 - 0
doc/classes/WebSocketMultiplayerPeer.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" category="Core" version="3.1-dev">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<demos>
+	</demos>
+	<methods>
+		<method name="get_peer" qualifiers="const">
+			<return type="WebSocketPeer">
+			</return>
+			<argument index="0" name="peer_id" type="int">
+			</argument>
+			<description>
+			</description>
+		</method>
+	</methods>
+	<signals>
+		<signal name="peer_packet">
+			<argument index="0" name="peer_source" type="int">
+			</argument>
+			<description>
+			</description>
+		</signal>
+	</signals>
+	<constants>
+	</constants>
+</class>

+ 51 - 0
doc/classes/WebSocketPeer.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WebSocketPeer" inherits="PacketPeer" category="Core" version="3.1-dev">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<demos>
+	</demos>
+	<methods>
+		<method name="close">
+			<return type="void">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="get_write_mode" qualifiers="const">
+			<return type="int" enum="WebSocketPeer.WriteMode">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="is_connected_to_host" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="set_write_mode">
+			<return type="void">
+			</return>
+			<argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="was_string_packet" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
+	</methods>
+	<constants>
+		<constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode">
+		</constant>
+		<constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode">
+		</constant>
+	</constants>
+</class>

+ 69 - 0
doc/classes/WebSocketServer.xml

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WebSocketServer" inherits="WebSocketMultiplayerPeer" category="Core" version="3.1-dev">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<demos>
+	</demos>
+	<methods>
+		<method name="has_peer" qualifiers="const">
+			<return type="bool">
+			</return>
+			<argument index="0" name="id" type="int">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="is_listening" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="listen">
+			<return type="int" enum="Error">
+			</return>
+			<argument index="0" name="port" type="int">
+			</argument>
+			<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray(  )">
+			</argument>
+			<argument index="2" name="gd_mp_api" type="bool" default="false">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="stop">
+			<return type="void">
+			</return>
+			<description>
+			</description>
+		</method>
+	</methods>
+	<signals>
+		<signal name="client_connected">
+			<argument index="0" name="id" type="int">
+			</argument>
+			<argument index="1" name="protocol" type="String">
+			</argument>
+			<description>
+			</description>
+		</signal>
+		<signal name="client_disconnected">
+			<argument index="0" name="id" type="int">
+			</argument>
+			<description>
+			</description>
+		</signal>
+		<signal name="data_received">
+			<argument index="0" name="id" type="int">
+			</argument>
+			<description>
+			</description>
+		</signal>
+	</signals>
+	<constants>
+	</constants>
+</class>

部分文件因为文件数量过多而无法显示