maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update classref and docs, fix missing parameters' name

Browse source
This commit is contained in:
Poommetee Ketson 2018-03-24 00:57:58 +07:00
parent 0f6fdb77c5
commit 72aa87758a
No known key found for this signature in database
GPG key ID: A96C7CF5B077909D
11 changed files with 21 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/bind/core_bind.cpp
View file

@ -1032,9 +1032,9 @@ void _OS::_bind_methods() {
//ClassDB::bind_method(D_METHOD("get_fullscreen_mode_list","screen"),&_OS::get_fullscreen_mode_list,DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_video_driver_count"), &_OS::get_video_driver_count);
ClassDB::bind_method(D_METHOD("get_video_driver_name"), &_OS::get_video_driver_name);
ClassDB::bind_method(D_METHOD("get_video_driver_name", "driver"), &_OS::get_video_driver_name);
ClassDB::bind_method(D_METHOD("get_audio_driver_count"), &_OS::get_audio_driver_count);
ClassDB::bind_method(D_METHOD("get_audio_driver_name"), &_OS::get_audio_driver_name);
ClassDB::bind_method(D_METHOD("get_audio_driver_name", "driver"), &_OS::get_audio_driver_name);
ClassDB::bind_method(D_METHOD("get_screen_count"), &_OS::get_screen_count);
ClassDB::bind_method(D_METHOD("get_current_screen"), &_OS::get_current_screen);

18
doc/classes/ARVRServer.xml
View file

@ -40,6 +40,7 @@
<return type="Transform">
</return>
<description>
Returns the primary interface's transformation.
</description>
</method>
<method name="get_interface" qualifiers="const">
@ -83,12 +84,6 @@
<description>
</description>
</method>
<method name="get_primary_interface" qualifiers="const">
<return type="ARVRInterface">
</return>
<description>
</description>
</method>
<method name="get_reference_frame" qualifiers="const">
<return type="Transform">
</return>
@ -112,17 +107,10 @@
Get the number of trackers currently registered.
</description>
</method>
<method name="set_primary_interface">
<return type="void">
</return>
<argument index="0" name="interface" type="ARVRInterface">
</argument>
<description>
Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces.
</description>
</method>
</methods>
<members>
<member name="primary_interface" type="ARVRInterface" setter="set_primary_interface" getter="get_primary_interface">
</member>
<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale">
Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.
</member>

2
doc/classes/Camera.xml
View file

@ -17,7 +17,7 @@
<argument index="0" name="enable_next" type="bool" default="true">
</argument>
<description>
If this is the current Camera, remove it from being current. If it is inside the node tree and [code]enabled_next[/code] is [code]true[/true], request to make the next Camera current, if any.
If this is the current Camera, remove it from being current. If [code]enable_next[/code] is true, request to make the next Camera current, if any.
</description>
</method>
<method name="get_camera_transform" qualifiers="const">

2
doc/classes/EditorPlugin.xml
View file

@ -114,6 +114,7 @@
<argument index="3" name="ud" type="Variant" default="null">
</argument>
<description>
Adds a custom menu to 'Project > Tools' as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it.
</description>
</method>
<method name="add_tool_submenu_item">
@ -367,6 +368,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Removes a menu [code]name[/code] from 'Project > Tools'.
</description>
</method>
<method name="save_external_data" qualifiers="virtual">

7
doc/classes/ItemList.xml
View file

@ -148,6 +148,7 @@
<return type="bool">
</return>
<description>
Returns [code]true[/code] if one or more items are selected.
</description>
</method>
<method name="is_item_disabled" qualifiers="const">
@ -189,11 +190,12 @@
<method name="move_item">
<return type="void">
</return>
<argument index="0" name="p_from_idx" type="int">
<argument index="0" name="from_idx" type="int">
</argument>
<argument index="1" name="p_to_idx" type="int">
<argument index="1" name="to_idx" type="int">
</argument>
<description>
Moves item at index [code]from_idx[/code] to [code]to_idx[/code].
</description>
</method>
<method name="remove_item">
@ -346,6 +348,7 @@
<return type="void">
</return>
<description>
Ensure there are no items selected.
</description>
</method>
</methods>

4
doc/classes/OS.xml
View file

@ -127,7 +127,7 @@
<method name="get_audio_driver_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="arg0" type="int">
<argument index="0" name="driver" type="int">
</argument>
<description>
Returns the audio driver name for the given index.
@ -418,7 +418,7 @@
<method name="get_video_driver_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="arg0" type="int">
<argument index="0" name="driver" type="int">
</argument>
<description>
</description>

1
doc/classes/OptionButton.xml
View file

@ -198,6 +198,7 @@
<argument index="0" name="ID" type="int">
</argument>
<description>
This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
</description>
</signal>
<signal name="item_selected">

1
doc/classes/PopupMenu.xml
View file

@ -495,6 +495,7 @@
<argument index="0" name="ID" type="int">
</argument>
<description>
This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action.
</description>
</signal>
<signal name="id_pressed">

2
doc/classes/Vector2.xml
View file

@ -87,7 +87,7 @@
<argument index="0" name="with" type="Vector2">
</argument>
<description>
Returns the 2-dimensional analog of the cross product with [code]b[/code].
Returns the 2-dimensional analog of the cross product with the given Vector2.
</description>
</method>
<method name="cubic_interpolate">

2
scene/gui/item_list.cpp
View file

@ -1434,7 +1434,7 @@ void ItemList::_bind_methods() {
ClassDB::bind_method(D_METHOD("is_selected", "idx"), &ItemList::is_selected);
ClassDB::bind_method(D_METHOD("get_selected_items"), &ItemList::get_selected_items);
ClassDB::bind_method(D_METHOD("move_item", "p_from_idx", "p_to_idx"), &ItemList::move_item);
ClassDB::bind_method(D_METHOD("move_item", "from_idx", "to_idx"), &ItemList::move_item);
ClassDB::bind_method(D_METHOD("get_item_count"), &ItemList::get_item_count);
ClassDB::bind_method(D_METHOD("remove_item", "idx"), &ItemList::remove_item);

2
servers/arvr_server.cpp
View file

@ -58,6 +58,8 @@ void ARVRServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_primary_interface"), &ARVRServer::get_primary_interface);
ClassDB::bind_method(D_METHOD("set_primary_interface", "interface"), &ARVRServer::set_primary_interface);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "primary_interface"), "set_primary_interface", "get_primary_interface");
ClassDB::bind_method(D_METHOD("get_last_process_usec"), &ARVRServer::get_last_process_usec);
ClassDB::bind_method(D_METHOD("get_last_commit_usec"), &ARVRServer::get_last_commit_usec);
ClassDB::bind_method(D_METHOD("get_last_frame_usec"), &ARVRServer::get_last_frame_usec);