Browse Source

doc: Sync classref with current source

Rémi Verschelde 7 years ago
parent
commit
11e07d18bd

+ 12 - 0
doc/classes/ArrayMesh.xml

@@ -199,6 +199,18 @@
 				Set a [Material] for a given surface. Surface will be rendered using this material.
 				Set a [Material] for a given surface. Surface will be rendered using this material.
 			</description>
 			</description>
 		</method>
 		</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>
 	</methods>
 	<constants>
 	<constants>
 		<constant name="NO_INDEX_ARRAY" value="-1" enum="">
 		<constant name="NO_INDEX_ARRAY" value="-1" enum="">

+ 16 - 0
doc/classes/Engine.xml

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

+ 0 - 16
doc/classes/ProjectSettings.xml

@@ -59,14 +59,6 @@
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</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">
 		<method name="globalize_path" qualifiers="const">
 			<return type="String">
 			<return type="String">
 			</return>
 			</return>
@@ -85,14 +77,6 @@
 				Return true if a configuration value is present.
 				Return true if a configuration value is present.
 			</description>
 			</description>
 		</method>
 		</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">
 		<method name="load_resource_pack">
 			<return type="bool">
 			<return type="bool">
 			</return>
 			</return>

+ 18 - 0
doc/classes/QuadMesh.xml

@@ -11,7 +11,25 @@
 	<demos>
 	<demos>
 	</demos>
 	</demos>
 	<methods>
 	<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>
 	</methods>
+	<members>
+		<member name="size" type="Vector2" setter="set_size" getter="get_size">
+		</member>
+	</members>
 	<constants>
 	<constants>
 	</constants>
 	</constants>
 </class>
 </class>

+ 34 - 0
doc/classes/ScriptEditor.xml

@@ -9,6 +9,30 @@
 	<demos>
 	<demos>
 	</demos>
 	</demos>
 	<methods>
 	<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">
 		<method name="get_current_script">
 			<return type="Script">
 			<return type="Script">
 			</return>
 			</return>
@@ -16,6 +40,16 @@
 				Returns a [Script] that is currently active in editor.
 				Returns a [Script] that is currently active in editor.
 			</description>
 			</description>
 		</method>
 		</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">
 		<method name="get_open_scripts" qualifiers="const">
 			<return type="Array">
 			<return type="Array">
 			</return>
 			</return>

+ 20 - 0
doc/classes/SpatialMaterial.xml

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

+ 16 - 0
doc/classes/VideoPlayer.xml

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

+ 6 - 0
doc/classes/VisualServer.xml

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

+ 43 - 11
modules/gdnative/doc_classes/GDNativeLibrary.xml

@@ -9,37 +9,51 @@
 	<demos>
 	<demos>
 	</demos>
 	</demos>
 	<methods>
 	<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 type="String">
 			</return>
 			</return>
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="get_library_path" qualifiers="const">
+		<method name="get_symbol_prefix" qualifiers="const">
 			<return type="String">
 			<return type="String">
 			</return>
 			</return>
-			<argument index="0" name="platform" type="String">
-			</argument>
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</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="is_singleton" qualifiers="const">
 			<return type="bool">
 			<return type="bool">
 			</return>
 			</return>
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="set_library_path">
+		<method name="set_load_once">
 			<return type="void">
 			<return type="void">
 			</return>
 			</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>
 			</argument>
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="set_singleton_gdnative">
+		<method name="set_singleton">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
 			<argument index="0" name="singleton" type="bool">
 			<argument index="0" name="singleton" type="bool">
@@ -47,9 +61,27 @@
 			<description>
 			<description>
 			</description>
 			</description>
 		</method>
 		</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>
 	</methods>
 	<members>
 	<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>
 		</member>
 	</members>
 	</members>
 	<constants>
 	<constants>

+ 15 - 0
modules/theora/doc_classes/ResourceImporterTheora.xml

@@ -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 - 0
modules/theora/doc_classes/VideoStreamTheora.xml

@@ -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 - 0
modules/webm/doc_classes/ResourceImporterWebm.xml

@@ -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 - 0
modules/webm/doc_classes/VideoStreamWebm.xml

@@ -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>