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

doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2019-06-24 10:39:59 +02:00
parent 131a4b14fa
commit 5e21310343
5 changed files with 46 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/classes/AudioEffectPitchShift.xml
View File

@ -12,10 +12,26 @@
<methods>
</methods>
<members>
<member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectPitchShift.FFT_Size">
</member>
<member name="oversampling" type="int" setter="set_oversampling" getter="get_oversampling">
</member>
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
</member>
</members>
<constants>
<constant name="FFT_SIZE_256" value="0" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_512" value="1" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_1024" value="2" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_2048" value="3" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_4096" value="4" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_MAX" value="5" enum="FFT_Size">
</constant>
</constants>
</class>

8
doc/classes/ColorPicker.xml
View File

@ -45,14 +45,14 @@
<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha">
If [code]true[/code], shows an alpha channel slider (transparency).
</member>
<member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled">
</member>
<member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible">
</member>
<member name="hsv_mode" type="bool" setter="set_hsv_mode" getter="is_hsv_mode">
If [code]true[/code], allows to edit color with Hue/Saturation/Value sliders.
[b]Note:[/b] Cannot be enabled if raw mode is on.
</member>
<member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled">
</member>
<member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible">
</member>
<member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode">
If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
[b]Note:[/b] Cannot be enabled if hsv mode is on.

12
doc/classes/String.xml
View File

@ -388,6 +388,18 @@
Converts a string containing a hexadecimal number into an integer.
</description>
</method>
<method name="http_escape">
<return type="String">
</return>
<description>
</description>
</method>
<method name="http_unescape">
<return type="String">
</return>
<description>
</description>
</method>
<method name="insert">
<return type="String">
</return>

6
doc/classes/TextEdit.xml
View File

@ -44,6 +44,12 @@
Returns if the given line is foldable, that is, it has indented lines right below it.
</description>
</method>
<method name="center_viewport_to_cursor">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_colors">
<return type="void">
</return>

8
doc/classes/VisualShaderNodeGroupBase.xml
View File

@ -109,6 +109,14 @@
<description>
</description>
</method>
<method name="is_valid_port_name" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="remove_input_port">
<return type="void">
</return>