Browse Source

doc: Sync classref with current source

Rémi Verschelde 6 years ago
parent
commit
592909db16

+ 11 - 17
doc/classes/AudioServer.xml

@@ -32,12 +32,6 @@
 				Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code].
 			</description>
 		</method>
-		<method name="capture_get_device">
-			<return type="String">
-			</return>
-			<description>
-			</description>
-		</method>
 		<method name="capture_get_device_list">
 			<return type="Array">
 			</return>
@@ -45,14 +39,6 @@
 				Returns the names of all audio input devices detected on the system.
 			</description>
 		</method>
-		<method name="capture_set_device">
-			<return type="void">
-			</return>
-			<argument index="0" name="name" type="String">
-			</argument>
-			<description>
-			</description>
-		</method>
 		<method name="capture_start">
 			<return type="int" enum="Error">
 			</return>
@@ -423,17 +409,25 @@
 		<member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count" default="1">
 			Number of available audio buses.
 		</member>
+		<member name="capture_device" type="String" setter="capture_set_device" getter="capture_get_device" default="&quot;&quot;">
+			Name of the current device for audio input (see [method capture_get_device_list]).
+		</member>
 		<member name="device" type="String" setter="set_device" getter="get_device" default="&quot;Default&quot;">
 			Name of the current device for audio output (see [method get_device_list]).
 		</member>
-		<member name="capture_device" type="String" setter="capture_set_device" getter="capture_get_device" default="&quot;Default&quot;">
-			Name of the current device for audio input (see [method capture_get_device_list]).
-		</member>
 		<member name="global_rate_scale" type="float" setter="set_global_rate_scale" getter="get_global_rate_scale" default="1.0">
 			Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast).
 		</member>
 	</members>
 	<signals>
+		<signal name="audio_mix_callback">
+			<description>
+			</description>
+		</signal>
+		<signal name="audio_update_callback">
+			<description>
+			</description>
+		</signal>
 		<signal name="bus_layout_changed">
 			<description>
 				Emitted when the [AudioBusLayout] changes.

+ 8 - 0
doc/classes/Basis.xml

@@ -208,5 +208,13 @@
 		</member>
 	</members>
 	<constants>
+		<constant name="IDENTITY" value="Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )">
+		</constant>
+		<constant name="FLIP_X" value="Basis( -1, 0, 0, 0, 1, 0, 0, 0, 1 )">
+		</constant>
+		<constant name="FLIP_Y" value="Basis( 1, 0, 0, 0, -1, 0, 0, 0, 1 )">
+		</constant>
+		<constant name="FLIP_Z" value="Basis( 1, 0, 0, 0, 1, 0, 0, 0, -1 )">
+		</constant>
 	</constants>
 </class>

+ 2 - 2
doc/classes/Camera2D.xml

@@ -110,7 +110,7 @@
 		<member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2">
 			Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
 		</member>
-		<member name="drag_margin_h_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled" default="true">
+		<member name="drag_margin_h_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled" default="false">
 			If [code]true[/code], the camera only moves when reaching the horizontal drag margins. If [code]false[/code], the camera moves horizontally regardless of margins.
 		</member>
 		<member name="drag_margin_left" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2">
@@ -122,7 +122,7 @@
 		<member name="drag_margin_top" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2">
 			Top margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
 		</member>
-		<member name="drag_margin_v_enabled" type="bool" setter="set_v_drag_enabled" getter="is_v_drag_enabled" default="true">
+		<member name="drag_margin_v_enabled" type="bool" setter="set_v_drag_enabled" getter="is_v_drag_enabled" default="false">
 			If [code]true[/code], the camera only moves when reaching the vertical drag margins. If [code]false[/code], the camera moves vertically regardless of margins.
 		</member>
 		<member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled" default="false">

+ 1 - 1
doc/classes/Control.xml

@@ -229,7 +229,7 @@
 				[codeblock]
 				func _ready():
 				    modulate = get_color("font_color", "Button") #get the color defined for button fonts
-				[/codeblock] 
+				[/codeblock]
 			</description>
 		</method>
 		<method name="get_combined_minimum_size" qualifiers="const">

+ 16 - 0
doc/classes/EditorInterface.xml

@@ -169,6 +169,22 @@
 				Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
 			</description>
 		</method>
+		<method name="set_distraction_free_mode">
+			<return type="void">
+			</return>
+			<argument index="0" name="enter" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="set_main_screen_editor">
+			<return type="void">
+			</return>
+			<argument index="0" name="name" type="String">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_plugin_enabled">
 			<return type="void">
 			</return>

+ 6 - 6
doc/classes/Image.xml

@@ -406,24 +406,24 @@
 			<description>
 			</description>
 		</method>
-		<method name="save_png" qualifiers="const">
+		<method name="save_exr" qualifiers="const">
 			<return type="int" enum="Error">
 			</return>
 			<argument index="0" name="path" type="String">
 			</argument>
+			<argument index="1" name="grayscale" type="bool" default="false">
+			</argument>
 			<description>
-				Saves the image as a PNG file to [code]path[/code].
+				Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitely as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE]  if Godot was compiled without the TinyEXR module.
 			</description>
 		</method>
-		<method name="save_exr" qualifiers="const">
+		<method name="save_png" qualifiers="const">
 			<return type="int" enum="Error">
 			</return>
 			<argument index="0" name="path" type="String">
 			</argument>
-			<argument index="1" name="grayscale" type="bool" default="false">
-			</argument>
 			<description>
-				Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitely as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE]  if Godot was compiled without the TinyEXR module.
+				Saves the image as a PNG file to [code]path[/code].
 			</description>
 		</method>
 		<method name="set_pixel">

+ 13 - 0
doc/classes/VisualShaderNodeVectorScalarMix.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualShaderNodeVectorScalarMix" inherits="VisualShaderNode" category="Core" version="3.2">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+	</methods>
+	<constants>
+	</constants>
+</class>