summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-07-28 01:08:44 +0200
committerRémi Verschelde <rverschelde@gmail.com>2020-07-28 01:08:44 +0200
commit932b75e2477dd97775b5b29639c514e091a83cf2 (patch)
tree3ebaa5e73fc4f8fbe75386c450b8ecc7d46debb9 /doc/classes
parent4e825539e590c6ce06e54fbb05571efce7fb181c (diff)
doc: Sync classref with current source
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/EditorInspector.xml4
-rw-r--r--doc/classes/LineEdit.xml2
-rw-r--r--doc/classes/OS.xml2
-rw-r--r--doc/classes/ProjectSettings.xml30
4 files changed, 18 insertions, 20 deletions
diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml
index 5fbe427f67..6f03165a97 100644
--- a/doc/classes/EditorInspector.xml
+++ b/doc/classes/EditorInspector.xml
@@ -20,9 +20,7 @@
</method>
</methods>
<members>
- <member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" override="true" default="false">
- If [code]true[/code], horizontal scrolling is enabled. An horizontal scroll bar will display at the bottom of the inspector.
- </member>
+ <member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" override="true" default="false" />
</members>
<signals>
<signal name="object_id_selected">
diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml
index feac483fc4..f08a15d873 100644
--- a/doc/classes/LineEdit.xml
+++ b/doc/classes/LineEdit.xml
@@ -122,6 +122,8 @@
<member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed" default="0.65">
Duration (in seconds) of a caret's blinking cycle.
</member>
+ <member name="caret_force_displayed" type="bool" setter="cursor_set_force_displayed" getter="cursor_get_force_displayed" default="false">
+ </member>
<member name="caret_position" type="int" setter="set_cursor_position" getter="get_cursor_position" default="0">
The cursor's position inside the [LineEdit]. When set, the text may scroll to accommodate it.
</member>
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 5b4b5d02fb..26110df335 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -120,7 +120,7 @@
[codeblock]
var arguments = {}
for argument in OS.get_cmdline_args():
- if argument.find("=") > -1:
+ if argument.find("=") &gt; -1:
var key_value = argument.split("=")
arguments[key_value[0].lstrip("--")] = key_value[1]
[/codeblock]
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 733bb559cb..f13dbbae76 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -280,6 +280,10 @@
<member name="debug/gdscript/completion/autocomplete_setters_and_getters" type="bool" setter="" getter="" default="false">
If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards.
</member>
+ <member name="debug/gdscript/warnings/assert_always_false" type="bool" setter="" getter="" default="true">
+ </member>
+ <member name="debug/gdscript/warnings/assert_always_true" type="bool" setter="" getter="" default="true">
+ </member>
<member name="debug/gdscript/warnings/constant_used_as_function" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when a constant is used as a function.
</member>
@@ -292,15 +296,6 @@
<member name="debug/gdscript/warnings/exclude_addons" type="bool" setter="" getter="" default="true">
If [code]true[/code], scripts in the [code]res://addons[/code] folder will not generate warnings.
</member>
- <member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when a function is declared with the same name as a constant.
- </member>
- <member name="debug/gdscript/warnings/function_conflicts_variable" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript.
- </member>
- <member name="debug/gdscript/warnings/function_may_yield" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when a function assigned to a variable may yield and return a function state instead of a value.
- </member>
<member name="debug/gdscript/warnings/function_used_as_property" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when using a function as if it was a property.
</member>
@@ -316,12 +311,16 @@
<member name="debug/gdscript/warnings/property_used_as_function" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when using a property as if it was a function.
</member>
+ <member name="debug/gdscript/warnings/redundant_await" type="bool" setter="" getter="" default="true">
+ </member>
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum.
</member>
<member name="debug/gdscript/warnings/shadowed_variable" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable).
</member>
+ <member name="debug/gdscript/warnings/shadowed_variable_base_class" type="bool" setter="" getter="" default="true">
+ </member>
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
</member>
@@ -340,6 +339,8 @@
<member name="debug/gdscript/warnings/unreachable_code" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when unreachable code is detected (such as after a [code]return[/code] statement that will always be executed).
</member>
+ <member name="debug/gdscript/warnings/unreachable_pattern" type="bool" setter="" getter="" default="true">
+ </member>
<member name="debug/gdscript/warnings/unsafe_call_argument" type="bool" setter="" getter="" default="false">
If [code]true[/code], enables warnings when using an expression whose type may not be compatible with the function parameter expected.
</member>
@@ -352,11 +353,11 @@
<member name="debug/gdscript/warnings/unsafe_property_access" type="bool" setter="" getter="" default="false">
If [code]true[/code], enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class.
</member>
- <member name="debug/gdscript/warnings/unused_argument" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when a function parameter is unused.
+ <member name="debug/gdscript/warnings/unused_local_constant" type="bool" setter="" getter="" default="true">
</member>
- <member name="debug/gdscript/warnings/unused_class_variable" type="bool" setter="" getter="" default="false">
- If [code]true[/code], enables warnings when a member variable is unused.
+ <member name="debug/gdscript/warnings/unused_parameter" type="bool" setter="" getter="" default="true">
+ </member>
+ <member name="debug/gdscript/warnings/unused_private_class_variable" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/gdscript/warnings/unused_signal" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when a signal is unused.
@@ -364,9 +365,6 @@
<member name="debug/gdscript/warnings/unused_variable" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when a local variable is unused.
</member>
- <member name="debug/gdscript/warnings/variable_conflicts_function" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when a variable is declared with the same name as a function. This will turn into an error in a future version when first-class functions become supported in GDScript.
- </member>
<member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable.
</member>