summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorKelly Thomas <kelly.thomas@hotmail.com.au>2018-10-07 21:52:07 +0800
committerKelly Thomas <kelly.thomas@hotmail.com.au>2018-10-07 21:57:26 +0800
commitb150ceb62cfd91f11b62f823f3dd5517a640cbc3 (patch)
treebd513756a7b58e864966141b6adae6c1480bc442 /doc/classes
parent215db9ff71c2c2fb3fe670fb8ea9109fca5b5a6a (diff)
Update class documentation xml
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/BaseButton.xml2
-rw-r--r--doc/classes/CheckBox.xml4
-rw-r--r--doc/classes/CheckButton.xml4
-rw-r--r--doc/classes/ProjectSettings.xml18
-rw-r--r--doc/classes/RichTextLabel.xml18
-rw-r--r--doc/classes/ScriptCreateDialog.xml2
-rw-r--r--doc/classes/SpinBox.xml2
-rw-r--r--doc/classes/StreamPeerSSL.xml2
-rw-r--r--doc/classes/TreeItem.xml7
-rw-r--r--doc/classes/VisualServer.xml2
10 files changed, 44 insertions, 17 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml
index 3ff8634010..3364770280 100644
--- a/doc/classes/BaseButton.xml
+++ b/doc/classes/BaseButton.xml
@@ -106,6 +106,8 @@
<constant name="DRAW_DISABLED" value="3" enum="DrawMode">
The state of buttons are disabled.
</constant>
+ <constant name="DRAW_HOVER_PRESSED" value="4" enum="DrawMode">
+ </constant>
<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
Require just a press to consider the button clicked.
</constant>
diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml
index fb2cf64d98..a2a7cf85e8 100644
--- a/doc/classes/CheckBox.xml
+++ b/doc/classes/CheckBox.xml
@@ -31,10 +31,14 @@
</theme_item>
<theme_item name="font_color_hover" type="Color">
</theme_item>
+ <theme_item name="font_color_hover_pressed" type="Color">
+ </theme_item>
<theme_item name="font_color_pressed" type="Color">
</theme_item>
<theme_item name="hover" type="StyleBox">
</theme_item>
+ <theme_item name="hover_pressed" type="StyleBox">
+ </theme_item>
<theme_item name="hseparation" type="int">
</theme_item>
<theme_item name="normal" type="StyleBox">
diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml
index deba9a17b6..24875017fe 100644
--- a/doc/classes/CheckButton.xml
+++ b/doc/classes/CheckButton.xml
@@ -29,10 +29,14 @@
</theme_item>
<theme_item name="font_color_hover" type="Color">
</theme_item>
+ <theme_item name="font_color_hover_pressed" type="Color">
+ </theme_item>
<theme_item name="font_color_pressed" type="Color">
</theme_item>
<theme_item name="hover" type="StyleBox">
</theme_item>
+ <theme_item name="hover_pressed" type="StyleBox">
+ </theme_item>
<theme_item name="hseparation" type="int">
</theme_item>
<theme_item name="normal" type="StyleBox">
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 0b7c0a63ad..4516fc522a 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -102,7 +102,7 @@
<argument index="0" name="name" type="String">
</argument>
<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>
</method>
<method name="property_get_revert">
@@ -111,14 +111,14 @@
<argument index="0" name="name" type="String">
</argument>
<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>
</method>
<method name="save">
<return type="int" enum="Error">
</return>
<description>
- Saves the configuration to the project.godot file.
+ Saves the configuration to the project.godot file.
</description>
</method>
<method name="save_custom">
@@ -127,7 +127,7 @@
<argument index="0" name="file" type="String">
</argument>
<description>
- Saves the configuration to a custom file.
+ Saves the configuration to a custom file.
</description>
</method>
<method name="set_initial_value">
@@ -213,8 +213,6 @@
<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.
</member>
- <member name="audio/output_latency" type="int" setter="" getter="">
- </member>
<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.
</member>
@@ -697,6 +695,14 @@
</member>
<member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter="">
</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="">
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>
diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml
index 618f2f42b2..357d2e7a15 100644
--- a/doc/classes/RichTextLabel.xml
+++ b/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.
</description>
</method>
+ <method name="push_strikethrough">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="push_table">
<return type="void">
</return>
@@ -304,15 +310,17 @@
</constant>
<constant name="ITEM_UNDERLINE" value="6" enum="ItemType">
</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 name="ITEM_INDENT" value="8" enum="ItemType">
+ <constant name="ITEM_INDENT" value="9" enum="ItemType">
</constant>
- <constant name="ITEM_LIST" value="9" enum="ItemType">
+ <constant name="ITEM_LIST" value="10" enum="ItemType">
</constant>
- <constant name="ITEM_TABLE" value="10" enum="ItemType">
+ <constant name="ITEM_TABLE" value="11" enum="ItemType">
</constant>
- <constant name="ITEM_META" value="11" enum="ItemType">
+ <constant name="ITEM_META" value="12" enum="ItemType">
</constant>
</constants>
<theme_items>
diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml
index 3de068dbcb..67ce9a8e87 100644
--- a/doc/classes/ScriptCreateDialog.xml
+++ b/doc/classes/ScriptCreateDialog.xml
@@ -24,6 +24,8 @@
</argument>
<argument index="1" name="path" type="String">
</argument>
+ <argument index="2" name="built_in_enabled" type="bool" default="true">
+ </argument>
<description>
Prefills required fields to configure the ScriptCreateDialog for use.
</description>
diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml
index 0fcd5bbaf5..5087cf355a 100644
--- a/doc/classes/SpinBox.xml
+++ b/doc/classes/SpinBox.xml
@@ -19,6 +19,8 @@
</method>
</methods>
<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>
<member name="prefix" type="String" setter="set_prefix" getter="get_prefix">
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml
index cf8769d22b..33948df509 100644
--- a/doc/classes/StreamPeerSSL.xml
+++ b/doc/classes/StreamPeerSSL.xml
@@ -63,6 +63,8 @@
<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
A status representing a [code]StreamPeerSSL[/code] that is disconnected.
</constant>
+ <constant name="STATUS_HANDSHAKING" value="1" enum="Status">
+ </constant>
<constant name="STATUS_CONNECTED" value="2" enum="Status">
A status representing a [code]StreamPeerSSL[/code] that is connected to a host.
</constant>
diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml
index c5a63b1acb..a7c5c3f28c 100644
--- a/doc/classes/TreeItem.xml
+++ b/doc/classes/TreeItem.xml
@@ -559,13 +559,10 @@
<constant name="CELL_MODE_RANGE" value="2" enum="TreeCellMode">
Cell contains a range.
</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.
</constant>
- <constant name="CELL_MODE_CUSTOM" value="5" enum="TreeCellMode">
+ <constant name="CELL_MODE_CUSTOM" value="4" enum="TreeCellMode">
</constant>
<constant name="ALIGN_LEFT" value="0" enum="TextAlign">
Align text to the left. See [code]set_text_align()[/code].
diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml
index 58b3d33cdb..225a1f2bba 100644
--- a/doc/classes/VisualServer.xml
+++ b/doc/classes/VisualServer.xml
@@ -4380,7 +4380,7 @@
</constant>
<constant name="ENV_TONE_MAPPER_LINEAR" value="0" enum="EnvironmentToneMapper">
</constant>
- <constant name="ENV_TONE_MAPPER_REINHARDT" value="1" enum="EnvironmentToneMapper">
+ <constant name="ENV_TONE_MAPPER_REINHARD" value="1" enum="EnvironmentToneMapper">
</constant>
<constant name="ENV_TONE_MAPPER_FILMIC" value="2" enum="EnvironmentToneMapper">
</constant>