godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2019-08-13 12:35:50 +02:00
parent 5f1dce4354
commit 592909db16
7 changed files with 60 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/classes/AudioServer.xml
View File

@ -32,12 +32,6 @@
Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code].
</description> </description>
</method> </method>
<method name="capture_get_device">
<return type="String">
</return>
<description>
</description>
</method>
<method name="capture_get_device_list"> <method name="capture_get_device_list">
<return type="Array"> <return type="Array">
</return> </return>
@ -45,14 +39,6 @@
Returns the names of all audio input devices detected on the system. Returns the names of all audio input devices detected on the system.
</description> </description>
</method> </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"> <method name="capture_start">
<return type="int" enum="Error"> <return type="int" enum="Error">
</return> </return>
@ -423,17 +409,25 @@
<member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count" default="1"> <member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count" default="1">
Number of available audio buses. Number of available audio buses.
</member> </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;"> <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]). Name of the current device for audio output (see [method get_device_list]).
</member> </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"> <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). 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> </member>
</members> </members>
<signals> <signals>
<signal name="audio_mix_callback">
<description>
</description>
</signal>
<signal name="audio_update_callback">
<description>
</description>
</signal>
<signal name="bus_layout_changed"> <signal name="bus_layout_changed">
<description> <description>
Emitted when the [AudioBusLayout] changes. Emitted when the [AudioBusLayout] changes.

8
doc/classes/Basis.xml
View File

@ -208,5 +208,13 @@
</member> </member>
</members> </members>
<constants> <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> </constants>
</class> </class>

4
doc/classes/Camera2D.xml
View File

@ -110,7 +110,7 @@
<member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2"> <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. 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>
<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. 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>
<member name="drag_margin_left" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2"> <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"> <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. 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>
<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. 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>
<member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled" default="false"> <member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled" default="false">

16
doc/classes/EditorInterface.xml
View File

@ -169,6 +169,22 @@
Selects the file, with the path provided by [code]file[/code], in the FileSystem dock. Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
</description> </description>
</method> </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"> <method name="set_plugin_enabled">
<return type="void"> <return type="void">
</return> </return>

18
doc/classes/Image.xml
View File

@ -406,15 +406,6 @@
<description> <description>
</description> </description>
</method> </method>
<method name="save_png" qualifiers="const">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Saves the image as a PNG file to [code]path[/code].
</description>
</method>
<method name="save_exr" qualifiers="const"> <method name="save_exr" qualifiers="const">
<return type="int" enum="Error"> <return type="int" enum="Error">
</return> </return>
@ -426,6 +417,15 @@
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 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> </description>
</method> </method>
<method name="save_png" qualifiers="const">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Saves the image as a PNG file to [code]path[/code].
</description>
</method>
<method name="set_pixel"> <method name="set_pixel">
<return type="void"> <return type="void">
</return> </return>

13
doc/classes/VisualShaderNodeVectorScalarMix.xml Normal file
View File

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