asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-04-19 11:21:09 +02:00
parent 6af69f851a
commit 268b520703
8 changed files with 148 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/classes/AudioEffectSpectrumAnalyzer.xml
View file

@ -17,5 +17,17 @@
</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>

6
doc/classes/Input.xml
View file

@ -66,6 +66,12 @@
Returns an [Array] containing the device IDs of all currently connected joypads.
</description>
</method>
<method name="get_current_cursor_shape" qualifiers="const">
<return type="int" enum="Input.CursorShape">
</return>
<description>
</description>
</method>
<method name="get_gravity" qualifiers="const">
<return type="Vector3">
</return>

2
doc/classes/ProjectSettings.xml
View file

@ -268,6 +268,8 @@
</member>
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/shadowed_variable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter="">

8
doc/classes/Slider.xml
View file

@ -12,18 +12,18 @@
</methods>
<members>
<member name="editable" type="bool" setter="set_editable" getter="is_editable">
If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.
If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode">
</member>
<member name="scrollable" type="bool" setter="set_scrollable" getter="is_scrollable">
If [code]true[/code], the value can be changed using the mouse wheel.
If [code]true[/code], the value can be changed using the mouse wheel.
</member>
<member name="tick_count" type="int" setter="set_ticks" getter="get_ticks">
Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
</member>
<member name="ticks_on_borders" type="bool" setter="set_ticks_on_borders" getter="get_ticks_on_borders">
If [code]true[/code], the slider will display ticks for minimum and maximum values.
If [code]true[/code], the slider will display ticks for minimum and maximum values.
</member>
</members>
<constants>

3
editor/doc/doc_data.cpp
View file

@ -982,8 +982,7 @@ Error DocData::save_classes(const String &p_default_path, const Map<String, Stri
FileAccessRef f = FileAccess::open(save_file, FileAccess::WRITE, &err);
if (err) {
ERR_EXPLAIN("Can't write doc file: " + save_file);
ERR_FAIL_V(err);
ERR_CONTINUE(err);
}
_write_string(f, 0, "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>");

1
modules/gdnative/config.py
View file

@ -16,6 +16,7 @@ def get_doc_classes():
"ResourceFormatLoaderVideoStreamGDNative",
"StreamPeerGDNative",
"VideoStreamGDNative",
"WebRTCPeerGDNative",
]
def get_doc_path():

13
modules/gdnative/doc_classes/WebRTCPeerGDNative.xml Normal file
View file

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

109
modules/webrtc/doc_classes/WebRTCPeer.xml Normal file
View file

@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebRTCPeer" inherits="PacketPeer" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_ice_candidate">
<return type="int" enum="Error">
</return>
<argument index="0" name="media" type="String">
</argument>
<argument index="1" name="index" type="int">
</argument>
<argument index="2" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="create_offer">
<return type="int" enum="Error">
</return>
<description>
</description>
</method>
<method name="get_connection_state" qualifiers="const">
<return type="int" enum="WebRTCPeer.ConnectionState">
</return>
<description>
</description>
</method>
<method name="poll">
<return type="int" enum="Error">
</return>
<description>
</description>
</method>
<method name="set_local_description">
<return type="int" enum="Error">
</return>
<argument index="0" name="type" type="String">
</argument>
<argument index="1" name="sdp" type="String">
</argument>
<description>
</description>
</method>
<method name="set_remote_description">
<return type="int" enum="Error">
</return>
<argument index="0" name="type" type="String">
</argument>
<argument index="1" name="sdp" type="String">
</argument>
<description>
</description>
</method>
<method name="was_string_packet" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="write_mode" type="int" setter="set_write_mode" getter="get_write_mode" enum="WebRTCPeer.WriteMode">
</member>
</members>
<signals>
<signal name="new_ice_candidate">
<argument index="0" name="media" type="String">
</argument>
<argument index="1" name="index" type="int">
</argument>
<argument index="2" name="name" type="String">
</argument>
<description>
</description>
</signal>
<signal name="offer_created">
<argument index="0" name="type" type="String">
</argument>
<argument index="1" name="sdp" type="String">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
<constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode">
</constant>
<constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode">
</constant>
<constant name="STATE_NEW" value="0" enum="ConnectionState">
</constant>
<constant name="STATE_CONNECTING" value="1" enum="ConnectionState">
</constant>
<constant name="STATE_CONNECTED" value="2" enum="ConnectionState">
</constant>
<constant name="STATE_DISCONNECTED" value="3" enum="ConnectionState">
</constant>
<constant name="STATE_FAILED" value="4" enum="ConnectionState">
</constant>
<constant name="STATE_CLOSED" value="5" enum="ConnectionState">
</constant>
</constants>
</class>