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 2017-11-27 23:37:47 +01:00
parent 9a406da44e
commit cb4c0c630f
6 changed files with 38 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/classes/EditorPlugin.xml
View file

@ -135,15 +135,20 @@
<description>
</description>
</method>
<method name="forward_draw_over_canvas" qualifiers="virtual">
<method name="forward_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="canvas_xform" type="Transform2D">
</argument>
<argument index="1" name="canvas" type="Control">
<argument index="0" name="overlay" type="Control">
</argument>
<description>
</description>
</method>
<method name="forward_force_draw_over_viewport" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="overlay" type="Control">
</argument>
<description>
This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas].
</description>
</method>
<method name="forward_spatial_gui_input" qualifiers="virtual">
@ -297,6 +302,12 @@
This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources.
</description>
</method>
<method name="set_force_draw_over_forwarding_enabled">
<return type="void">
</return>
<description>
</description>
</method>
<method name="set_input_event_forwarding_always_enabled">
<return type="void">
</return>
@ -322,11 +333,10 @@
Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout].
</description>
</method>
<method name="update_canvas">
<return type="void">
<method name="update_overlays" qualifiers="const">
<return type="int">
</return>
<description>
Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event].
</description>
</method>
</methods>

6
doc/classes/FileDialog.xml
View file

@ -27,6 +27,12 @@
Clear all the added filters in the dialog.
</description>
</method>
<method name="deselect_items">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_current_dir" qualifiers="const">
<return type="String">
</return>

4
doc/classes/ItemList.xml
View file

@ -378,6 +378,10 @@
Fired when a multiple selection is altered on a list allowing multiple selection.
</description>
</signal>
<signal name="nothing_selected">
<description>
</description>
</signal>
<signal name="rmb_clicked">
<argument index="0" name="at_position" type="Vector2">
</argument>

4
doc/classes/Tree.xml
View file

@ -405,6 +405,10 @@
Emitted instead of [code]item_selected[/code] when [code]select_mode[/code] is [code]SELECT_MULTI[/code].
</description>
</signal>
<signal name="nothing_selected">
<description>
</description>
</signal>
</signals>
<constants>
<constant name="SELECT_SINGLE" value="0" enum="SelectMode">

4
doc/classes/VisualServer.xml
View file

@ -817,6 +817,8 @@
<method name="draw">
<return type="void">
</return>
<argument index="0" name="swap_buffers" type="bool" default="true">
</argument>
<description>
</description>
</method>
@ -829,6 +831,8 @@
<method name="force_draw">
<return type="void">
</return>
<argument index="0" name="swap_buffers" type="bool" default="true">
</argument>
<description>
</description>
</method>

4
servers/visual_server.cpp
View file

@ -1481,7 +1481,7 @@ Array VisualServer::_mesh_surface_get_skeleton_aabb_bind(RID p_mesh, int p_surfa
void VisualServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("force_sync"), &VisualServer::sync);
ClassDB::bind_method(D_METHOD("force_draw"), &VisualServer::draw, DEFVAL(true));
ClassDB::bind_method(D_METHOD("force_draw", "swap_buffers"), &VisualServer::draw, DEFVAL(true));
ClassDB::bind_method(D_METHOD("texture_create"), &VisualServer::texture_create);
ClassDB::bind_method(D_METHOD("texture_create_from_image", "image", "flags"), &VisualServer::texture_create_from_image, DEFVAL(TEXTURE_FLAGS_DEFAULT));
@ -1658,7 +1658,7 @@ void VisualServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("free", "rid"), &VisualServer::free);
ClassDB::bind_method(D_METHOD("request_frame_drawn_callback", "where", "method", "userdata"), &VisualServer::request_frame_drawn_callback);
ClassDB::bind_method(D_METHOD("draw"), &VisualServer::draw, DEFVAL(true));
ClassDB::bind_method(D_METHOD("draw", "swap_buffers"), &VisualServer::draw, DEFVAL(true));
ClassDB::bind_method(D_METHOD("sync"), &VisualServer::sync);
ClassDB::bind_method(D_METHOD("has_changed"), &VisualServer::has_changed);
ClassDB::bind_method(D_METHOD("init"), &VisualServer::init);