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 2017-11-15 20:35:18 +01:00
parent ed2b66f023
commit 11e07d18bd
13 changed files with 261 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/classes/ArrayMesh.xml
View File

@ -199,6 +199,18 @@
Set a [Material] for a given surface. Surface will be rendered using this material.
</description>
</method>
<method name="surface_update_region">
<return type="void">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="NO_INDEX_ARRAY" value="-1" enum="">

16
doc/classes/Engine.xml
View File

@ -39,6 +39,14 @@
Returns the main loop object (see [MainLoop] and [SceneTree]).
</description>
</method>
<method name="get_singleton" qualifiers="const">
<return type="Object">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="get_target_fps" qualifiers="const">
<return type="float">
</return>
@ -67,6 +75,14 @@
"string" - major + minor + patch + status + revision in a single String
</description>
</method>
<method name="has_singleton" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="is_editor_hint" qualifiers="const">
<return type="bool">
</return>

16
doc/classes/ProjectSettings.xml
View File

@ -59,14 +59,6 @@
<description>
</description>
</method>
<method name="get_singleton" qualifiers="const">
<return type="Object">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="globalize_path" qualifiers="const">
<return type="String">
</return>
@ -85,14 +77,6 @@
Return true if a configuration value is present.
</description>
</method>
<method name="has_singleton" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="load_resource_pack">
<return type="bool">
</return>

18
doc/classes/QuadMesh.xml
View File

@ -11,7 +11,25 @@
<demos>
</demos>
<methods>
<method name="get_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="size" type="Vector2" setter="set_size" getter="get_size">
</member>
</members>
<constants>
</constants>
</class>

34
doc/classes/ScriptEditor.xml
View File

@ -9,6 +9,30 @@
<demos>
</demos>
<methods>
<method name="can_drop_data_fw" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="arg0" type="Vector2">
</argument>
<argument index="1" name="arg1" type="Variant">
</argument>
<argument index="2" name="arg2" type="Control">
</argument>
<description>
</description>
</method>
<method name="drop_data_fw">
<return type="void">
</return>
<argument index="0" name="arg0" type="Vector2">
</argument>
<argument index="1" name="arg1" type="Variant">
</argument>
<argument index="2" name="arg2" type="Control">
</argument>
<description>
</description>
</method>
<method name="get_current_script">
<return type="Script">
</return>
@ -16,6 +40,16 @@
Returns a [Script] that is currently active in editor.
</description>
</method>
<method name="get_drag_data_fw">
<return type="Variant">
</return>
<argument index="0" name="arg0" type="Vector2">
</argument>
<argument index="1" name="arg1" type="Control">
</argument>
<description>
</description>
</method>
<method name="get_open_scripts" qualifiers="const">
<return type="Array">
</return>

20
doc/classes/SpatialMaterial.xml
View File

@ -135,6 +135,12 @@
<description>
</description>
</method>
<method name="get_emission_operator" qualifiers="const">
<return type="int" enum="SpatialMaterial.EmissionOperator">
</return>
<description>
</description>
</method>
<method name="get_feature" qualifiers="const">
<return type="bool">
</return>
@ -523,6 +529,14 @@
<description>
</description>
</method>
<method name="set_emission_operator">
<return type="void">
</return>
<argument index="0" name="operator" type="int" enum="SpatialMaterial.EmissionOperator">
</argument>
<description>
</description>
</method>
<method name="set_feature">
<return type="void">
</return>
@ -843,6 +857,8 @@
</member>
<member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy">
</member>
<member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="SpatialMaterial.EmissionOperator">
</member>
<member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture">
</member>
<member name="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag">
@ -1113,5 +1129,9 @@
</constant>
<constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4">
</constant>
<constant name="EMISSION_OP_ADD" value="0">
</constant>
<constant name="EMISSION_OP_MULTIPLY" value="1">
</constant>
</constants>
</class>

16
doc/classes/VideoPlayer.xml
View File

@ -25,6 +25,12 @@
Get the amount of milliseconds to store in buffer while playing.
</description>
</method>
<method name="get_bus" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_stream" qualifiers="const">
<return type="VideoStream">
</return>
@ -129,6 +135,14 @@
Set the amount of milliseconds to buffer during playback.
</description>
</method>
<method name="set_bus">
<return type="void">
</return>
<argument index="0" name="bus" type="String">
</argument>
<description>
</description>
</method>
<method name="set_expand">
<return type="void">
</return>
@ -196,6 +210,8 @@
</member>
<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
</member>
<member name="bus" type="String" setter="set_bus" getter="get_bus">
</member>
<member name="expand" type="bool" setter="set_expand" getter="has_expand">
</member>
<member name="paused" type="bool" setter="set_paused" getter="is_paused">

6
doc/classes/VisualServer.xml
View File

@ -1791,6 +1791,12 @@
</description>
</method>
</methods>
<signals>
<signal name="frame_drawn_in_thread">
<description>
</description>
</signal>
</signals>
<constants>
<constant name="NO_INDEX_ARRAY" value="-1" enum="">
</constant>

54
modules/gdnative/doc_classes/GDNativeLibrary.xml
View File

@ -9,37 +9,51 @@
<demos>
</demos>
<methods>
<method name="get_active_library_path" qualifiers="const">
<method name="get_config_file">
<return type="ConfigFile">
</return>
<description>
</description>
</method>
<method name="get_current_dependencies" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
</description>
</method>
<method name="get_current_library_path" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_library_path" qualifiers="const">
<method name="get_symbol_prefix" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="platform" type="String">
</argument>
<description>
</description>
</method>
<method name="is_singleton_gdnative" qualifiers="const">
<method name="is_current_library_statically_linked" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_library_path">
<method name="is_singleton" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_load_once">
<return type="void">
</return>
<argument index="0" name="platform" type="String">
</argument>
<argument index="1" name="path" type="String">
<argument index="0" name="load_once" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_singleton_gdnative">
<method name="set_singleton">
<return type="void">
</return>
<argument index="0" name="singleton" type="bool">
@ -47,9 +61,27 @@
<description>
</description>
</method>
<method name="set_symbol_prefix">
<return type="void">
</return>
<argument index="0" name="symbol_prefix" type="String">
</argument>
<description>
</description>
</method>
<method name="should_load_once" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="singleton_gdnative" type="bool" setter="set_singleton_gdnative" getter="is_singleton_gdnative">
<member name="load_once" type="bool" setter="set_load_once" getter="should_load_once">
</member>
<member name="singleton" type="bool" setter="set_singleton" getter="is_singleton">
</member>
<member name="symbol_prefix" type="String" setter="set_symbol_prefix" getter="get_symbol_prefix">
</member>
</members>
<constants>

15
modules/theora/doc_classes/ResourceImporterTheora.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterTheora" inherits="ResourceImporter" category="Core" version="3.0-alpha">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

33
modules/theora/doc_classes/VideoStreamTheora.xml Normal file
View File

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamTheora" inherits="VideoStream" category="Core" version="3.0-alpha">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_file">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="file" type="String" setter="set_file" getter="get_file">
</member>
</members>
<constants>
</constants>
</class>

15
modules/webm/doc_classes/ResourceImporterWebm.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterWebm" inherits="ResourceImporter" category="Core" version="3.0-alpha">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

33
modules/webm/doc_classes/VideoStreamWebm.xml Normal file
View File

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamWebm" inherits="VideoStream" category="Core" version="3.0-alpha">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_file">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="file" type="String" setter="set_file" getter="get_file">
</member>
</members>
<constants>
</constants>
</class>