summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Control.xml2
-rw-r--r--doc/classes/KinematicBody.xml2
-rw-r--r--doc/classes/Node.xml6
-rw-r--r--doc/classes/PhysicsMaterial.xml4
-rw-r--r--doc/classes/ProjectSettings.xml3
-rw-r--r--doc/classes/Vector2.xml12
-rw-r--r--doc/classes/Vector3.xml14
-rw-r--r--doc/classes/VideoStream.xml1
-rw-r--r--doc/classes/ViewportContainer.xml3
-rw-r--r--doc/classes/WindowDialog.xml2
10 files changed, 38 insertions, 11 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index 4301102e4a..8575a1f498 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -38,7 +38,7 @@
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
- The node's parent forwards input events to this method. Use it to process and accept inputs on UI elements. See [method accept_event].
+ Use this method to process and accept inputs on UI elements. See [method accept_event].
Replaces Godot 2's [code]_input_event[/code].
</description>
</method>
diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml
index 0c66319ae7..17310ab4dc 100644
--- a/doc/classes/KinematicBody.xml
+++ b/doc/classes/KinematicBody.xml
@@ -115,6 +115,8 @@
<argument index="6" name="floor_max_angle" type="float" default="0.785398">
</argument>
<description>
+ Moves the body while keeping it attached to slopes. Similar to [method move_and_slide].
+ As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0, 0)[/code] or by using [method move_and_slide] instead.
</description>
</method>
<method name="test_move">
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index d02e3dfdfa..dd496e79dd 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -50,7 +50,7 @@
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
- Called when there is an input event. The input event propagates through the node tree until a node consumes it.
+ Called when there is an input event. The input event propagates up through the node tree until a node consumes it.
It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input].
To consume the input event and stop it propagating further to other nodes, [method SceneTree.set_input_as_handled] can be called.
For gameplay input, [method _unhandled_input] and [method _unhandled_key_input] are usually a better fit as they allow the GUI to intercept the events first.
@@ -93,7 +93,7 @@
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
- Propagated to all nodes when the previous [InputEvent] is not consumed by any nodes.
+ Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI. The input event propagates up through the node tree until a node consumes it.
It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input].
To consume the input event and stop it propagating further to other nodes, [method SceneTree.set_input_as_handled] can be called.
For gameplay input, this and [method _unhandled_key_input] are usually a better fit than [method _input] as they allow the GUI to intercept the events first.
@@ -105,7 +105,7 @@
<argument index="0" name="event" type="InputEventKey">
</argument>
<description>
- Propagated to all nodes when the previous [InputEventKey] is not consumed by any nodes.
+ Called when an [InputEventKey] hasn't been consumed by [method _input] or any GUI. The input event propagates up through the node tree until a node consumes it.
It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input].
To consume the input event and stop it propagating further to other nodes, [method SceneTree.set_input_as_handled] can be called.
For gameplay input, this and [method _unhandled_input] are usually a better fit than [method _input] as they allow the GUI to intercept the events first.
diff --git a/doc/classes/PhysicsMaterial.xml b/doc/classes/PhysicsMaterial.xml
index bfebb472a5..3eebcc57a1 100644
--- a/doc/classes/PhysicsMaterial.xml
+++ b/doc/classes/PhysicsMaterial.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsMaterial" inherits="Resource" category="Core" version="3.1">
<brief_description>
+ A material for physics properties.
</brief_description>
<description>
+ Provides a means of modifying the collision properties of a [PhysicsBody].
</description>
<tutorials>
</tutorials>
@@ -14,8 +16,10 @@
<member name="absorbent" type="bool" setter="set_absorbent" getter="is_absorbent">
</member>
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
+ The body's bounciness. Default value: [code]0[/code].
</member>
<member name="friction" type="float" setter="set_friction" getter="get_friction">
+ The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Default value: [code]1[/code].
</member>
<member name="rough" type="bool" setter="set_rough" getter="is_rough">
</member>
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 358b7292a5..5f828550b9 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -658,6 +658,9 @@
</member>
<member name="rendering/quality/driver/driver_name" type="String" setter="" getter="">
</member>
+ <member name="rendering/quality/driver/driver_fallback" type="String" setter="" getter="">
+ Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function.
+ </member>
<member name="rendering/quality/filters/anisotropic_filter_level" type="int" setter="" getter="">
Maximum Anisotropic filter level used for textures when anisotropy enabled.
</member>
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index 4bc18b926e..a721ef50c5 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -109,7 +109,7 @@
<argument index="3" name="t" type="float">
</argument>
<description>
- Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], or a percentage of how far along the interpolation is.
+ Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
</description>
</method>
<method name="distance_squared_to">
@@ -175,7 +175,7 @@
<argument index="1" name="t" type="float">
</argument>
<description>
- Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is.
+ Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
</description>
</method>
<method name="normalized">
@@ -227,7 +227,7 @@
<argument index="1" name="t" type="float">
</argument>
<description>
- Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
+ Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
Both vectors need to be normalized.
</description>
</method>
@@ -267,16 +267,22 @@
</members>
<constants>
<constant name="ZERO" value="Vector2( 0, 0 )">
+ Null vector.
</constant>
<constant name="INF" value="Vector2( inf, inf )">
+ Infinite vector.
</constant>
<constant name="LEFT" value="Vector2( -1, 0 )">
+ Left unit vector.
</constant>
<constant name="RIGHT" value="Vector2( 1, 0 )">
+ Right unit vector.
</constant>
<constant name="UP" value="Vector2( 0, -1 )">
+ Up unit vector.
</constant>
<constant name="DOWN" value="Vector2( 0, 1 )">
+ Down unit vector.
</constant>
</constants>
</class>
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index b4dcc6c6aa..4211c34d8e 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -78,7 +78,7 @@
<argument index="3" name="t" type="float">
</argument>
<description>
- Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
+ Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
</description>
</method>
<method name="distance_squared_to">
@@ -151,7 +151,7 @@
<argument index="1" name="t" type="float">
</argument>
<description>
- Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is.
+ Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation..
</description>
</method>
<method name="max_axis">
@@ -228,7 +228,7 @@
<argument index="1" name="t" type="float">
</argument>
<description>
- Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
+ Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.
Both vectors need to be normalized.
</description>
</method>
@@ -280,20 +280,28 @@
Enumerated value for the Z axis.
</constant>
<constant name="ZERO" value="Vector3( 0, 0, 0 )">
+ Null vector.
</constant>
<constant name="INF" value="Vector3( inf, inf, inf )">
+ Infinite vector.
</constant>
<constant name="LEFT" value="Vector3( -1, 0, 0 )">
+ Left unit vector.
</constant>
<constant name="RIGHT" value="Vector3( 1, 0, 0 )">
+ Right unit vector.
</constant>
<constant name="UP" value="Vector3( 0, 1, 0 )">
+ Up unit vector.
</constant>
<constant name="DOWN" value="Vector3( 0, -1, 0 )">
+ Down unit vector.
</constant>
<constant name="FORWARD" value="Vector3( 0, 0, -1 )">
+ Forward unit vector.
</constant>
<constant name="BACK" value="Vector3( 0, 0, 1 )">
+ Back unit vector.
</constant>
</constants>
</class>
diff --git a/doc/classes/VideoStream.xml b/doc/classes/VideoStream.xml
index 6bfa48511b..9f2655ed1b 100644
--- a/doc/classes/VideoStream.xml
+++ b/doc/classes/VideoStream.xml
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStream" inherits="Resource" category="Core" version="3.1">
<brief_description>
+ Base resource for video streams.
</brief_description>
<description>
</description>
diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml
index 8c60fb473d..dde429440d 100644
--- a/doc/classes/ViewportContainer.xml
+++ b/doc/classes/ViewportContainer.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ViewportContainer" inherits="Container" category="Core" version="3.1">
<brief_description>
+ Control for holding [Viewport]s.
</brief_description>
<description>
+ A [Container] node that holds a [Viewport], automatically setting its size.
</description>
<tutorials>
</tutorials>
@@ -12,6 +14,7 @@
</methods>
<members>
<member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled">
+ If [code]true[/code] the viewport will be scaled to the control's size. Default value:[code]false[/code].
</member>
<member name="stretch_shrink" type="int" setter="set_stretch_shrink" getter="get_stretch_shrink">
</member>
diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml
index 39487f5020..f7f2d10fcd 100644
--- a/doc/classes/WindowDialog.xml
+++ b/doc/classes/WindowDialog.xml
@@ -24,7 +24,7 @@
If [code]true[/code] the user can resize the window. Default value: [code]false[/code].
</member>
<member name="window_title" type="String" setter="set_title" getter="get_title">
- The text displayed in the window's title bar. Default value: "Save a File".
+ The text displayed in the window's title bar.
</member>
</members>
<constants>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 22:47:24 +0000