summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/AudioStreamPlayer2D.xml3
-rw-r--r--doc/classes/AudioStreamPlayer3D.xml2
-rw-r--r--doc/classes/KinematicCollision2D.xml6
-rw-r--r--doc/classes/KinematicCollision3D.xml6
-rw-r--r--doc/classes/Label3D.xml6
5 files changed, 18 insertions, 5 deletions
diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml
index 4c3e675c41..ee71651b42 100644
--- a/doc/classes/AudioStreamPlayer2D.xml
+++ b/doc/classes/AudioStreamPlayer2D.xml
@@ -4,7 +4,8 @@
Plays positional sound in 2D space.
</brief_description>
<description>
- Plays audio that dampens with distance from screen center.
+ Plays audio that dampens with distance from a given position.
+ By default, audio is heard from the screen center. This can be changed by adding an [AudioListener2D] node to the scene and enabling it by calling [method AudioListener2D.make_current] on it.
See also [AudioStreamPlayer] to play a sound non-positionally.
[b]Note:[/b] Hiding an [AudioStreamPlayer2D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer2D]'s audio output, set [member volume_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing).
</description>
diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml
index 9b86a93e74..0219562eca 100644
--- a/doc/classes/AudioStreamPlayer3D.xml
+++ b/doc/classes/AudioStreamPlayer3D.xml
@@ -5,7 +5,7 @@
</brief_description>
<description>
Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. For greater realism, a low-pass filter is automatically applied to distant sounds. This can be disabled by setting [member attenuation_filter_cutoff_hz] to [code]20500[/code].
- By default, audio is heard from the camera position. This can be changed by adding a [AudioListener3D] node to the scene and enabling it by calling [method AudioListener3D.make_current] on it.
+ By default, audio is heard from the camera position. This can be changed by adding an [AudioListener3D] node to the scene and enabling it by calling [method AudioListener3D.make_current] on it.
See also [AudioStreamPlayer] to play a sound non-positionally.
[b]Note:[/b] Hiding an [AudioStreamPlayer3D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer3D]'s audio output, set [member unit_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing).
</description>
diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml
index ca6aa05316..045480f17c 100644
--- a/doc/classes/KinematicCollision2D.xml
+++ b/doc/classes/KinematicCollision2D.xml
@@ -53,6 +53,12 @@
Returns the colliding body's velocity.
</description>
</method>
+ <method name="get_depth" qualifiers="const">
+ <return type="float" />
+ <description>
+ Returns the colliding body's length of overlap along the collision normal.
+ </description>
+ </method>
<method name="get_local_shape" qualifiers="const">
<return type="Object" />
<description>
diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml
index 08ceebdf91..31fbbc8d0a 100644
--- a/doc/classes/KinematicCollision3D.xml
+++ b/doc/classes/KinematicCollision3D.xml
@@ -66,6 +66,12 @@
Returns the number of detected collisions.
</description>
</method>
+ <method name="get_depth" qualifiers="const">
+ <return type="float" />
+ <description>
+ Returns the colliding body's length of overlap along the collision normal.
+ </description>
+ </method>
<method name="get_local_shape" qualifiers="const">
<return type="Object" />
<param index="0" name="collision_index" type="int" default="0" />
diff --git a/doc/classes/Label3D.xml b/doc/classes/Label3D.xml
index 56690d484d..e4dc24d0b5 100644
--- a/doc/classes/Label3D.xml
+++ b/doc/classes/Label3D.xml
@@ -53,7 +53,7 @@
<member name="font" type="Font" setter="set_font" getter="get_font">
Font configuration used to display text.
</member>
- <member name="font_size" type="int" setter="set_font_size" getter="get_font_size" default="16">
+ <member name="font_size" type="int" setter="set_font_size" getter="get_font_size" default="32">
Font size of the [Label3D]'s text.
</member>
<member name="horizontal_alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="1">
@@ -82,10 +82,10 @@
[b]Note:[/b] This only applies if [member alpha_cut] is set to [constant ALPHA_CUT_DISABLED] (default value).
[b]Note:[/b] This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
</member>
- <member name="outline_size" type="int" setter="set_outline_size" getter="get_outline_size" default="0">
+ <member name="outline_size" type="int" setter="set_outline_size" getter="get_outline_size" default="12">
Text outline size.
</member>
- <member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size" default="0.01">
+ <member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size" default="0.005">
The size of one pixel's width on the label to scale it in 3D.
</member>
<member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority" default="0">