summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/CanvasItem.xml2
-rw-r--r--doc/classes/Dictionary.xml2
-rw-r--r--doc/classes/Geometry2D.xml4
-rw-r--r--doc/classes/Geometry3D.xml4
-rw-r--r--doc/classes/GraphEdit.xml15
-rw-r--r--doc/classes/GraphNode.xml14
-rw-r--r--doc/classes/NavigationAgent3D.xml2
-rw-r--r--doc/classes/NavigationServer2D.xml4
-rw-r--r--doc/classes/NavigationServer3D.xml4
-rw-r--r--doc/classes/Node.xml4
-rw-r--r--doc/classes/ProjectSettings.xml118
-rw-r--r--doc/classes/StreamPeerSSL.xml6
12 files changed, 105 insertions, 74 deletions
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml
index 6cd2da520f..98a498d719 100644
--- a/doc/classes/CanvasItem.xml
+++ b/doc/classes/CanvasItem.xml
@@ -67,7 +67,7 @@
<argument index="1" name="radius" type="float" />
<argument index="2" name="color" type="Color" />
<description>
- Draws a colored, unfilled circle. See also [method draw_arc], [method draw_polyline] and [method draw_polygon].
+ Draws a colored, filled circle. See also [method draw_arc], [method draw_polyline] and [method draw_polygon].
</description>
</method>
<method name="draw_colored_polygon">
diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml
index 8ee09ba8f8..b46719c758 100644
--- a/doc/classes/Dictionary.xml
+++ b/doc/classes/Dictionary.xml
@@ -43,7 +43,7 @@
You can access a dictionary's values by referencing the appropriate key. In the above example, [code]points_dict["White"][/code] will return [code]50[/code]. You can also write [code]points_dict.White[/code], which is equivalent. However, you'll have to use the bracket syntax if the key you're accessing the dictionary with isn't a fixed string (such as a number or variable).
[codeblocks]
[gdscript]
- export(string, "White", "Yellow", "Orange") var my_color
+ export(String, "White", "Yellow", "Orange") var my_color
var points_dict = {"White": 50, "Yellow": 75, "Orange": 100}
func _ready():
# We can't use dot syntax here as `my_color` is a variable.
diff --git a/doc/classes/Geometry2D.xml b/doc/classes/Geometry2D.xml
index cbd83e8d7d..b84e221d1c 100644
--- a/doc/classes/Geometry2D.xml
+++ b/doc/classes/Geometry2D.xml
@@ -118,7 +118,7 @@
<argument index="2" name="from_b" type="Vector2" />
<argument index="3" name="dir_b" type="Vector2" />
<description>
- Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant].
+ Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns [code]null[/code].
[b]Note:[/b] The lines are specified using direction vectors, not end points.
</description>
</method>
@@ -195,7 +195,7 @@
<argument index="2" name="from_b" type="Vector2" />
<argument index="3" name="to_b" type="Vector2" />
<description>
- Checks if the two segments ([code]from_a[/code], [code]to_a[/code]) and ([code]from_b[/code], [code]to_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant].
+ Checks if the two segments ([code]from_a[/code], [code]to_a[/code]) and ([code]from_b[/code], [code]to_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns [code]null[/code].
</description>
</method>
<method name="triangulate_delaunay">
diff --git a/doc/classes/Geometry3D.xml b/doc/classes/Geometry3D.xml
index 0bf6f880c2..c05d7df53f 100644
--- a/doc/classes/Geometry3D.xml
+++ b/doc/classes/Geometry3D.xml
@@ -81,7 +81,7 @@
<argument index="3" name="b" type="Vector3" />
<argument index="4" name="c" type="Vector3" />
<description>
- Tests if the 3D ray starting at [code]from[/code] with the direction of [code]dir[/code] intersects the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned.
+ Tests if the 3D ray starting at [code]from[/code] with the direction of [code]dir[/code] intersects the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, returns [code]null[/code].
</description>
</method>
<method name="segment_intersects_convex">
@@ -121,7 +121,7 @@
<argument index="3" name="b" type="Vector3" />
<argument index="4" name="c" type="Vector3" />
<description>
- Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned.
+ Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, returns [code]null[/code].
</description>
</method>
</methods>
diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml
index 02352ca808..965dbe7449 100644
--- a/doc/classes/GraphEdit.xml
+++ b/doc/classes/GraphEdit.xml
@@ -202,6 +202,9 @@
<member name="connection_lines_antialiased" type="bool" setter="set_connection_lines_antialiased" getter="is_connection_lines_antialiased" default="true">
If [code]true[/code], the lines between nodes will use antialiasing.
</member>
+ <member name="connection_lines_curvature" type="float" setter="set_connection_lines_curvature" getter="get_connection_lines_curvature" default="0.5">
+ The curvature of the lines between the nodes. 0 results in straight lines.
+ </member>
<member name="connection_lines_thickness" type="float" setter="set_connection_lines_thickness" getter="get_connection_lines_thickness" default="2.0">
The thickness of the lines between the nodes.
</member>
@@ -372,15 +375,11 @@
<theme_item name="selection_stroke" data_type="color" type="Color" default="Color(1, 1, 1, 0.8)">
The outline color of the selection rectangle.
</theme_item>
- <theme_item name="bezier_len_neg" data_type="constant" type="int" default="160">
- </theme_item>
- <theme_item name="bezier_len_pos" data_type="constant" type="int" default="80">
- </theme_item>
- <theme_item name="port_grab_distance_horizontal" data_type="constant" type="int" default="24">
- The horizontal range within which a port can be grabbed (on both sides).
+ <theme_item name="port_hotzone_inner_extent" data_type="constant" type="int" default="22">
+ The horizontal range within which a port can be grabbed (inner side).
</theme_item>
- <theme_item name="port_grab_distance_vertical" data_type="constant" type="int" default="26">
- The vertical range within which a port can be grabbed (on both sides).
+ <theme_item name="port_hotzone_outer_extent" data_type="constant" type="int" default="26">
+ The horizontal range within which a port can be grabbed (outer side).
</theme_item>
<theme_item name="layout" data_type="icon" type="Texture2D">
</theme_item>
diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml
index 5f0dca0402..f261da8413 100644
--- a/doc/classes/GraphNode.xml
+++ b/doc/classes/GraphNode.xml
@@ -43,6 +43,13 @@
Returns the number of enabled input slots (connections) to the GraphNode.
</description>
</method>
+ <method name="get_connection_input_height">
+ <return type="int" />
+ <argument index="0" name="idx" type="int" />
+ <description>
+ Returns the height of the input connection [code]idx[/code].
+ </description>
+ </method>
<method name="get_connection_input_position">
<return type="Vector2" />
<argument index="0" name="idx" type="int" />
@@ -70,6 +77,13 @@
Returns the number of enabled output slots (connections) of the GraphNode.
</description>
</method>
+ <method name="get_connection_output_height">
+ <return type="int" />
+ <argument index="0" name="idx" type="int" />
+ <description>
+ Returns the height of the output connection [code]idx[/code].
+ </description>
+ </method>
<method name="get_connection_output_position">
<return type="Vector2" />
<argument index="0" name="idx" type="int" />
diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml
index 445fac55fe..db2210b6e3 100644
--- a/doc/classes/NavigationAgent3D.xml
+++ b/doc/classes/NavigationAgent3D.xml
@@ -86,7 +86,7 @@
</methods>
<members>
<member name="agent_height_offset" type="float" setter="set_agent_height_offset" getter="get_agent_height_offset" default="0.0">
- The agent height offset to match the navigation mesh height.
+ The NavigationAgent height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents.
</member>
<member name="avoidance_enabled" type="bool" setter="set_avoidance_enabled" getter="get_avoidance_enabled" default="false">
If [code]true[/code] the agent is registered for an RVO avoidance callback on the [NavigationServer3D]. When [method NavigationAgent3D.set_velocity] is used and the processing is completed a [code]safe_velocity[/code] Vector3 is received with a signal connection to [signal velocity_computed]. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it.
diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml
index 928834101f..1994a7a4c4 100644
--- a/doc/classes/NavigationServer2D.xml
+++ b/doc/classes/NavigationServer2D.xml
@@ -5,7 +5,9 @@
</brief_description>
<description>
NavigationServer2D is the server responsible for all 2D navigation. It handles several objects, namely maps, regions and agents.
- Maps are made up of regions, which are made of navigation polygons. Together, they define the navigable areas in the 2D world. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
+ Maps are made up of regions, which are made of navigation polygons. Together, they define the navigable areas in the 2D world.
+ [b]Note:[/b] Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts.
+ For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
You may assign navigation layers to regions with [method NavigationServer2D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This allows allowing or forbidding some areas to 2D objects.
To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
[b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.
diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml
index 8c83fe5485..2a729e7108 100644
--- a/doc/classes/NavigationServer3D.xml
+++ b/doc/classes/NavigationServer3D.xml
@@ -5,7 +5,9 @@
</brief_description>
<description>
NavigationServer3D is the server responsible for all 3D navigation. It handles several objects, namely maps, regions and agents.
- Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D world. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
+ Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D world.
+ [b]Note:[/b] Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts.
+ For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
You may assign navigation layers to regions with [method NavigationServer3D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. This allows allowing or forbidding some areas to 3D objects.
To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
[b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 06bb86385f..966e24c537 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -625,7 +625,7 @@
<return type="void" />
<argument index="0" name="method" type="StringName" />
<description>
- Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. Returns an empty [Variant].
+ Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. Returns [code]null[/code].
[b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [MultiplayerAPI]. You also need to keep track of the connection state, either by the [MultiplayerAPI] signals like [code]server_disconnected[/code] or by checking [code]get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED[/code].
</description>
</method>
@@ -645,7 +645,7 @@
<argument index="0" name="peer_id" type="int" />
<argument index="1" name="method" type="StringName" />
<description>
- Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). Returns an empty [Variant].
+ Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). Returns [code]null[/code].
</description>
</method>
<method name="set_display_folded">
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 1e169b150a..98205e0e16 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -334,18 +334,20 @@
<member name="debug/file_logging/max_log_files" type="int" setter="" getter="" default="5">
Specifies the maximum amount of log files allowed (used for rotation).
</member>
- <member name="debug/gdscript/warnings/assert_always_false" type="bool" setter="" getter="" default="true">
+ <member name="debug/gdscript/warnings/assert_always_false" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when an [code]assert[/code] call always returns false.
</member>
- <member name="debug/gdscript/warnings/assert_always_true" type="bool" setter="" getter="" default="true">
+ <member name="debug/gdscript/warnings/assert_always_true" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when an [code]assert[/code] call always returns 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 name="debug/gdscript/warnings/constant_used_as_function" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a constant is used as a function.
</member>
- <member name="debug/gdscript/warnings/deprecated_keyword" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when deprecated keywords are used.
+ <member name="debug/gdscript/warnings/deprecated_keyword" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when deprecated keywords are used.
</member>
- <member name="debug/gdscript/warnings/empty_file" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when an empty file is parsed.
+ <member name="debug/gdscript/warnings/empty_file" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when an empty file is parsed.
</member>
<member name="debug/gdscript/warnings/enable" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings.
@@ -353,82 +355,88 @@
<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_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 name="debug/gdscript/warnings/function_used_as_property" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when using a function as if it was a property.
</member>
- <member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when a ternary operator may emit values with incompatible types.
+ <member name="debug/gdscript/warnings/incompatible_ternary" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a ternary operator may emit values with incompatible types.
</member>
- <member name="debug/gdscript/warnings/int_assigned_to_enum" type="bool" setter="" getter="" default="true">
+ <member name="debug/gdscript/warnings/int_assigned_to_enum" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when trying to assign an integer to a variable that expects an enum value.
</member>
- <member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when dividing an integer by another integer (the decimal part will be discarded).
+ <member name="debug/gdscript/warnings/integer_division" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when dividing an integer by another integer (the decimal part will be discarded).
</member>
- <member name="debug/gdscript/warnings/narrowing_conversion" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision).
+ <member name="debug/gdscript/warnings/narrowing_conversion" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when passing a floating-point value to a function that expects an integer (it will be converted and lose precision).
</member>
- <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 name="debug/gdscript/warnings/property_used_as_function" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error 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 name="debug/gdscript/warnings/redundant_await" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a function that is not a coroutine is called with await.
</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 name="debug/gdscript/warnings/return_value_discarded" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error 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_global_identifier" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when defining a local or subclass member variable, signal, or enum that would have the same name as a built-in function or global class name, which possibly shadow it.
+ <member name="debug/gdscript/warnings/shadowed_global_identifier" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when defining a local or subclass member variable, signal, or enum that would have the same name as a built-in function or global class name, which possibly shadow it.
</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 name="debug/gdscript/warnings/shadowed_variable" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error 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 name="debug/gdscript/warnings/shadowed_variable_base_class" type="int" setter="" getter="" default="1">
</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 name="debug/gdscript/warnings/standalone_expression" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
</member>
- <member name="debug/gdscript/warnings/standalone_ternary" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when calling a ternary expression that has no effect on the surrounding code, such as writing [code]42 if active else 0[/code] as a statement.
+ <member name="debug/gdscript/warnings/standalone_ternary" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when calling a ternary expression that has no effect on the surrounding code, such as writing [code]42 if active else 0[/code] as a statement.
</member>
<member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter="" default="false">
If [code]true[/code], all warnings will be reported as if they were errors.
</member>
- <member name="debug/gdscript/warnings/unassigned_variable" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when using a variable that wasn't previously assigned.
+ <member name="debug/gdscript/warnings/unassigned_variable" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when using a variable that wasn't previously assigned.
</member>
- <member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter="" default="true">
- If [code]true[/code], enables warnings when assigning a variable using an assignment operator like [code]+=[/code] if the variable wasn't previously assigned.
+ <member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when assigning a variable using an assignment operator like [code]+=[/code] if the variable wasn't previously assigned.
</member>
- <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 name="debug/gdscript/warnings/unreachable_code" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error 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 name="debug/gdscript/warnings/unreachable_pattern" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when an unreachable [code]match[/code] pattern is detected.
</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 name="debug/gdscript/warnings/unsafe_call_argument" type="int" setter="" getter="" default="0">
+ If [code]enabled[/code], prints a warning or an error when using an expression whose type may not be compatible with the function parameter expected.
</member>
- <member name="debug/gdscript/warnings/unsafe_cast" type="bool" setter="" getter="" default="false">
- If [code]true[/code], enables warnings when performing an unsafe cast.
+ <member name="debug/gdscript/warnings/unsafe_cast" type="int" setter="" getter="" default="0">
+ If [code]enabled[/code], prints a warning or an error when performing an unsafe cast.
</member>
- <member name="debug/gdscript/warnings/unsafe_method_access" type="bool" setter="" getter="" default="false">
- If [code]true[/code], enables warnings when calling a method whose presence is not guaranteed at compile-time in the class.
+ <member name="debug/gdscript/warnings/unsafe_method_access" type="int" setter="" getter="" default="0">
+ If [code]enabled[/code], prints a warning or an error when calling a method whose presence is not guaranteed at compile-time in the class.
</member>
- <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 name="debug/gdscript/warnings/unsafe_property_access" type="int" setter="" getter="" default="0">
+ If [code]enabled[/code], prints a warning or an error when accessing a property whose presence is not guaranteed at compile-time in the class.
</member>
- <member name="debug/gdscript/warnings/unused_local_constant" type="bool" setter="" getter="" default="true">
+ <member name="debug/gdscript/warnings/unused_local_constant" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a local constant is never used.
</member>
- <member name="debug/gdscript/warnings/unused_parameter" type="bool" setter="" getter="" default="true">
+ <member name="debug/gdscript/warnings/unused_parameter" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a function parameter is never used.
</member>
- <member name="debug/gdscript/warnings/unused_private_class_variable" type="bool" setter="" getter="" default="true">
+ <member name="debug/gdscript/warnings/unused_private_class_variable" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a class variable is never used.
</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.
+ <member name="debug/gdscript/warnings/unused_signal" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a signal is unused.
</member>
- <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 name="debug/gdscript/warnings/unused_variable" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when a local variable is unused.
</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 name="debug/gdscript/warnings/void_assignment" type="int" setter="" getter="" default="1">
+ If [code]enabled[/code], prints a warning or an error when assigning the result of a function that returns [code]void[/code] to a variable.
</member>
<member name="debug/settings/crash_handler/message" type="String" setter="" getter="" default="&quot;Please include this when reporting the bug on https://github.com/godotengine/godot/issues&quot;">
Message to be displayed before the backtrace when the engine crashes.
diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml
index 3aede347a0..70762cbf6c 100644
--- a/doc/classes/StreamPeerSSL.xml
+++ b/doc/classes/StreamPeerSSL.xml
@@ -44,6 +44,12 @@
Returns the status of the connection. See [enum Status] for values.
</description>
</method>
+ <method name="get_stream" qualifiers="const">
+ <return type="StreamPeer" />
+ <description>
+ Returns the underlying [StreamPeer] connection, used in [method accept_stream] or [method connect_to_stream].
+ </description>
+ </method>
<method name="poll">
<return type="void" />
<description>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-05 13:53:37 +0000