Browse Source

Update class documentation xml

Kelly Thomas 6 years ago
parent
commit
b150ceb62c

+ 2 - 0
doc/classes/BaseButton.xml

@@ -106,6 +106,8 @@
 		<constant name="DRAW_DISABLED" value="3" enum="DrawMode">
 		<constant name="DRAW_DISABLED" value="3" enum="DrawMode">
 			The state of buttons are disabled.
 			The state of buttons are disabled.
 		</constant>
 		</constant>
+		<constant name="DRAW_HOVER_PRESSED" value="4" enum="DrawMode">
+		</constant>
 		<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
 		<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
 			Require just a press to consider the button clicked.
 			Require just a press to consider the button clicked.
 		</constant>
 		</constant>

+ 4 - 0
doc/classes/CheckBox.xml

@@ -31,10 +31,14 @@
 		</theme_item>
 		</theme_item>
 		<theme_item name="font_color_hover" type="Color">
 		<theme_item name="font_color_hover" type="Color">
 		</theme_item>
 		</theme_item>
+		<theme_item name="font_color_hover_pressed" type="Color">
+		</theme_item>
 		<theme_item name="font_color_pressed" type="Color">
 		<theme_item name="font_color_pressed" type="Color">
 		</theme_item>
 		</theme_item>
 		<theme_item name="hover" type="StyleBox">
 		<theme_item name="hover" type="StyleBox">
 		</theme_item>
 		</theme_item>
+		<theme_item name="hover_pressed" type="StyleBox">
+		</theme_item>
 		<theme_item name="hseparation" type="int">
 		<theme_item name="hseparation" type="int">
 		</theme_item>
 		</theme_item>
 		<theme_item name="normal" type="StyleBox">
 		<theme_item name="normal" type="StyleBox">

+ 4 - 0
doc/classes/CheckButton.xml

@@ -29,10 +29,14 @@
 		</theme_item>
 		</theme_item>
 		<theme_item name="font_color_hover" type="Color">
 		<theme_item name="font_color_hover" type="Color">
 		</theme_item>
 		</theme_item>
+		<theme_item name="font_color_hover_pressed" type="Color">
+		</theme_item>
 		<theme_item name="font_color_pressed" type="Color">
 		<theme_item name="font_color_pressed" type="Color">
 		</theme_item>
 		</theme_item>
 		<theme_item name="hover" type="StyleBox">
 		<theme_item name="hover" type="StyleBox">
 		</theme_item>
 		</theme_item>
+		<theme_item name="hover_pressed" type="StyleBox">
+		</theme_item>
 		<theme_item name="hseparation" type="int">
 		<theme_item name="hseparation" type="int">
 		</theme_item>
 		</theme_item>
 		<theme_item name="normal" type="StyleBox">
 		<theme_item name="normal" type="StyleBox">

+ 12 - 6
doc/classes/ProjectSettings.xml

@@ -102,7 +102,7 @@
 			<argument index="0" name="name" type="String">
 			<argument index="0" name="name" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
-			  	Returns true if the specified property exists and its initial value differs from the current value.
+				Returns true if the specified property exists and its initial value differs from the current value.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="property_get_revert">
 		<method name="property_get_revert">
@@ -111,14 +111,14 @@
 			<argument index="0" name="name" type="String">
 			<argument index="0" name="name" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
-			  	Returns the initial value of the specified property. Returns null if the property does not exist.
+				Returns the initial value of the specified property. Returns null if the property does not exist.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="save">
 		<method name="save">
 			<return type="int" enum="Error">
 			<return type="int" enum="Error">
 			</return>
 			</return>
 			<description>
 			<description>
-			  	Saves the configuration to the project.godot file.
+				Saves the configuration to the project.godot file.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="save_custom">
 		<method name="save_custom">
@@ -127,7 +127,7 @@
 			<argument index="0" name="file" type="String">
 			<argument index="0" name="file" type="String">
 			</argument>
 			</argument>
 			<description>
 			<description>
-			  	Saves the configuration to a custom file.
+				Saves the configuration to a custom file.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="set_initial_value">
 		<method name="set_initial_value">
@@ -213,8 +213,6 @@
 		<member name="audio/mix_rate" type="int" setter="" getter="">
 		<member name="audio/mix_rate" type="int" setter="" getter="">
 			Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system.
 			Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system.
 		</member>
 		</member>
-		<member name="audio/output_latency" type="int" setter="" getter="">
-		</member>
 		<member name="audio/video_delay_compensation_ms" type="int" setter="" getter="">
 		<member name="audio/video_delay_compensation_ms" type="int" setter="" getter="">
 			Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing.
 			Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing.
 		</member>
 		</member>
@@ -697,6 +695,14 @@
 		</member>
 		</member>
 		<member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter="">
 		<member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter="">
 		</member>
 		</member>
+		<member name="rendering/quality/shading/force_blinn_over_ggx" type="bool" setter="" getter="">
+		</member>
+		<member name="rendering/quality/shading/force_blinn_over_ggx.mobile" type="bool" setter="" getter="">
+		</member>
+		<member name="rendering/quality/shading/force_lambert_over_burley" type="bool" setter="" getter="">
+		</member>
+		<member name="rendering/quality/shading/force_lambert_over_burley.mobile" type="bool" setter="" getter="">
+		</member>
 		<member name="rendering/quality/shading/force_vertex_shading" type="bool" setter="" getter="">
 		<member name="rendering/quality/shading/force_vertex_shading" type="bool" setter="" getter="">
 			Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile.
 			Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile.
 		</member>
 		</member>

+ 13 - 5
doc/classes/RichTextLabel.xml

@@ -166,6 +166,12 @@
 				Adds a meta tag to the tag stack. Similar to the bbcode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types.
 				Adds a meta tag to the tag stack. Similar to the bbcode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="push_strikethrough">
+			<return type="void">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="push_table">
 		<method name="push_table">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
@@ -304,15 +310,17 @@
 		</constant>
 		</constant>
 		<constant name="ITEM_UNDERLINE" value="6" enum="ItemType">
 		<constant name="ITEM_UNDERLINE" value="6" enum="ItemType">
 		</constant>
 		</constant>
-		<constant name="ITEM_ALIGN" value="7" enum="ItemType">
+		<constant name="ITEM_STRIKETHROUGH" value="7" enum="ItemType">
+		</constant>
+		<constant name="ITEM_ALIGN" value="8" enum="ItemType">
 		</constant>
 		</constant>
-		<constant name="ITEM_INDENT" value="8" enum="ItemType">
+		<constant name="ITEM_INDENT" value="9" enum="ItemType">
 		</constant>
 		</constant>
-		<constant name="ITEM_LIST" value="9" enum="ItemType">
+		<constant name="ITEM_LIST" value="10" enum="ItemType">
 		</constant>
 		</constant>
-		<constant name="ITEM_TABLE" value="10" enum="ItemType">
+		<constant name="ITEM_TABLE" value="11" enum="ItemType">
 		</constant>
 		</constant>
-		<constant name="ITEM_META" value="11" enum="ItemType">
+		<constant name="ITEM_META" value="12" enum="ItemType">
 		</constant>
 		</constant>
 	</constants>
 	</constants>
 	<theme_items>
 	<theme_items>

+ 2 - 0
doc/classes/ScriptCreateDialog.xml

@@ -24,6 +24,8 @@
 			</argument>
 			</argument>
 			<argument index="1" name="path" type="String">
 			<argument index="1" name="path" type="String">
 			</argument>
 			</argument>
+			<argument index="2" name="built_in_enabled" type="bool" default="true">
+			</argument>
 			<description>
 			<description>
 				Prefills required fields to configure the ScriptCreateDialog for use.
 				Prefills required fields to configure the ScriptCreateDialog for use.
 			</description>
 			</description>

+ 2 - 0
doc/classes/SpinBox.xml

@@ -19,6 +19,8 @@
 		</method>
 		</method>
 	</methods>
 	</methods>
 	<members>
 	<members>
+		<member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align">
+		</member>
 		<member name="editable" type="bool" setter="set_editable" getter="is_editable">
 		<member name="editable" type="bool" setter="set_editable" getter="is_editable">
 		</member>
 		</member>
 		<member name="prefix" type="String" setter="set_prefix" getter="get_prefix">
 		<member name="prefix" type="String" setter="set_prefix" getter="get_prefix">

+ 2 - 0
doc/classes/StreamPeerSSL.xml

@@ -63,6 +63,8 @@
 		<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
 		<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
 			A status representing a [code]StreamPeerSSL[/code] that is disconnected.
 			A status representing a [code]StreamPeerSSL[/code] that is disconnected.
 		</constant>
 		</constant>
+		<constant name="STATUS_HANDSHAKING" value="1" enum="Status">
+		</constant>
 		<constant name="STATUS_CONNECTED" value="2" enum="Status">
 		<constant name="STATUS_CONNECTED" value="2" enum="Status">
 			A status representing a [code]StreamPeerSSL[/code] that is connected to a host.
 			A status representing a [code]StreamPeerSSL[/code] that is connected to a host.
 		</constant>
 		</constant>

+ 2 - 5
doc/classes/TreeItem.xml

@@ -559,13 +559,10 @@
 		<constant name="CELL_MODE_RANGE" value="2" enum="TreeCellMode">
 		<constant name="CELL_MODE_RANGE" value="2" enum="TreeCellMode">
 			Cell contains a range.
 			Cell contains a range.
 		</constant>
 		</constant>
-		<constant name="CELL_MODE_RANGE_EXPRESSION" value="3" enum="TreeCellMode">
-			Cell contains a range expression.
-		</constant>
-		<constant name="CELL_MODE_ICON" value="4" enum="TreeCellMode">
+		<constant name="CELL_MODE_ICON" value="3" enum="TreeCellMode">
 			Cell contains an icon.
 			Cell contains an icon.
 		</constant>
 		</constant>
-		<constant name="CELL_MODE_CUSTOM" value="5" enum="TreeCellMode">
+		<constant name="CELL_MODE_CUSTOM" value="4" enum="TreeCellMode">
 		</constant>
 		</constant>
 		<constant name="ALIGN_LEFT" value="0" enum="TextAlign">
 		<constant name="ALIGN_LEFT" value="0" enum="TextAlign">
 			Align text to the left. See [code]set_text_align()[/code].
 			Align text to the left. See [code]set_text_align()[/code].

+ 1 - 1
doc/classes/VisualServer.xml

@@ -4380,7 +4380,7 @@
 		</constant>
 		</constant>
 		<constant name="ENV_TONE_MAPPER_LINEAR" value="0" enum="EnvironmentToneMapper">
 		<constant name="ENV_TONE_MAPPER_LINEAR" value="0" enum="EnvironmentToneMapper">
 		</constant>
 		</constant>
-		<constant name="ENV_TONE_MAPPER_REINHARDT" value="1" enum="EnvironmentToneMapper">
+		<constant name="ENV_TONE_MAPPER_REINHARD" value="1" enum="EnvironmentToneMapper">
 		</constant>
 		</constant>
 		<constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper">
 		<constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper">
 		</constant>
 		</constant>

+ 30 - 4
modules/mono/doc_classes/GodotSharp.xml

@@ -23,18 +23,44 @@
 				Detaches the current thread from the mono runtime.
 				Detaches the current thread from the mono runtime.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="is_domain_loaded">
+		<method name="get_domain_id">
+			<return type="int">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="get_scripts_domain_id">
+			<return type="int">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="is_domain_finalizing_for_unload">
+			<return type="bool">
+			</return>
+			<argument index="0" name="domain_id" type="int">
+			</argument>
+			<description>
+				Returns whether the domain is being finalized.
+			</description>
+		</method>
+		<method name="is_runtime_initialized">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="is_runtime_shutting_down">
 			<return type="bool">
 			<return type="bool">
 			</return>
 			</return>
 			<description>
 			<description>
-				Returns whether the scripts domain is loaded.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="is_finalizing_domain">
+		<method name="is_scripts_domain_loaded">
 			<return type="bool">
 			<return type="bool">
 			</return>
 			</return>
 			<description>
 			<description>
-				Returns whether the scripts domain is being finalized.
+				Returns whether the scripts domain is loaded.
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>

+ 0 - 18
modules/opensimplex/doc_classes/NoiseTexture.xml

@@ -12,24 +12,6 @@
 	<demos>
 	<demos>
 	</demos>
 	</demos>
 	<methods>
 	<methods>
-		<method name="set_height">
-			<return type="void">
-			</return>
-			<argument index="0" name="height" type="int">
-			</argument>
-			<description>
-				Set texture height.
-			</description>
-		</method>
-		<method name="set_width">
-			<return type="void">
-			</return>
-			<argument index="0" name="width" type="int">
-			</argument>
-			<description>
-				Set texture width.
-			</description>
-		</method>
 	</methods>
 	</methods>
 	<members>
 	<members>
 		<member name="as_normalmap" type="bool" setter="set_as_normalmap" getter="is_normalmap">
 		<member name="as_normalmap" type="bool" setter="set_as_normalmap" getter="is_normalmap">