summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/AudioEffect.xml7
-rw-r--r--doc/classes/AudioEffectInstance.xml15
-rw-r--r--doc/classes/AudioStreamGenerator.xml2
-rw-r--r--doc/classes/AudioStreamGeneratorPlayback.xml4
-rw-r--r--doc/classes/AudioStreamPlaybackResampled.xml19
-rw-r--r--doc/classes/EditorVCSInterface.xml2
-rw-r--r--doc/classes/Material.xml22
-rw-r--r--doc/classes/Mesh.xml83
-rw-r--r--doc/classes/PrimitiveMesh.xml5
-rw-r--r--doc/classes/ProjectSettings.xml6
-rw-r--r--doc/classes/Range.xml6
-rw-r--r--doc/classes/Resource.xml5
-rw-r--r--doc/classes/RigidDynamicBody3D.xml2
-rw-r--r--doc/classes/StyleBox.xml31
-rw-r--r--doc/classes/TabBar.xml3
-rw-r--r--doc/classes/Texture2D.xml52
-rw-r--r--doc/classes/Texture3D.xml30
-rw-r--r--doc/classes/TextureLayered.xml36
-rw-r--r--doc/classes/Time.xml7
-rw-r--r--doc/classes/Variant.xml1
-rw-r--r--doc/classes/VideoStreamPlayer.xml4
-rw-r--r--doc/classes/VisualInstance3D.xml5
-rw-r--r--doc/classes/XRInterface.xml2
-rw-r--r--doc/classes/XRPositionalTracker.xml9
24 files changed, 342 insertions, 16 deletions
diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml
index 424669eab9..5bfa5be0ca 100644
--- a/doc/classes/AudioEffect.xml
+++ b/doc/classes/AudioEffect.xml
@@ -9,4 +9,11 @@
<tutorials>
<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>
</tutorials>
+ <methods>
+ <method name="_instantiate" qualifiers="virtual">
+ <return type="AudioEffectInstance" />
+ <description>
+ </description>
+ </method>
+ </methods>
</class>
diff --git a/doc/classes/AudioEffectInstance.xml b/doc/classes/AudioEffectInstance.xml
index 369b4130d4..f50246d6ca 100644
--- a/doc/classes/AudioEffectInstance.xml
+++ b/doc/classes/AudioEffectInstance.xml
@@ -6,4 +6,19 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="_process" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="src_buffer" type="const void*" />
+ <argument index="1" name="dst_buffer" type="AudioFrame*" />
+ <argument index="2" name="frame_count" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_process_silence" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ </methods>
</class>
diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml
index 78a1ed7c51..c8f081215d 100644
--- a/doc/classes/AudioStreamGenerator.xml
+++ b/doc/classes/AudioStreamGenerator.xml
@@ -6,7 +6,7 @@
<description>
This audio stream does not play back sounds, but expects a script to generate audio data for it instead. See also [AudioStreamGeneratorPlayback].
See also [AudioEffectSpectrumAnalyzer] for performing real-time audio spectrum analysis.
- [b]Note:[/b] Due to performance constraints, this class is best used from C# or from a compiled language via GDNative. If you still want to use this class from GDScript, consider using a lower [member mix_rate] such as 11,025 Hz or 22,050 Hz.
+ [b]Note:[/b] Due to performance constraints, this class is best used from C# or from a compiled language via GDExtension. If you still want to use this class from GDScript, consider using a lower [member mix_rate] such as 11,025 Hz or 22,050 Hz.
</description>
<tutorials>
<link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link>
diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml
index 1cd82026a0..06c285bff7 100644
--- a/doc/classes/AudioStreamGeneratorPlayback.xml
+++ b/doc/classes/AudioStreamGeneratorPlayback.xml
@@ -39,14 +39,14 @@
<return type="bool" />
<argument index="0" name="frames" type="PackedVector2Array" />
<description>
- Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDNative, but [method push_buffer] may be [i]less[/i] efficient in GDScript.
+ Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDExtension, but [method push_buffer] may be [i]less[/i] efficient in GDScript.
</description>
</method>
<method name="push_frame">
<return type="bool" />
<argument index="0" name="frame" type="Vector2" />
<description>
- Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDNative, but [method push_frame] may be [i]more[/i] efficient in GDScript.
+ Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDExtension, but [method push_frame] may be [i]more[/i] efficient in GDScript.
</description>
</method>
</methods>
diff --git a/doc/classes/AudioStreamPlaybackResampled.xml b/doc/classes/AudioStreamPlaybackResampled.xml
index 228b8c19c0..eb41e4256e 100644
--- a/doc/classes/AudioStreamPlaybackResampled.xml
+++ b/doc/classes/AudioStreamPlaybackResampled.xml
@@ -6,4 +6,23 @@
</description>
<tutorials>
</tutorials>
+ <methods>
+ <method name="_get_stream_sampling_rate" qualifiers="virtual const">
+ <return type="float" />
+ <description>
+ </description>
+ </method>
+ <method name="_mix_resampled" qualifiers="virtual">
+ <return type="int" />
+ <argument index="0" name="dst_buffer" type="AudioFrame*" />
+ <argument index="1" name="frame_count" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="begin_resample">
+ <return type="void" />
+ <description>
+ </description>
+ </method>
+ </methods>
</class>
diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml
index b78b027fa8..0215d81a4e 100644
--- a/doc/classes/EditorVCSInterface.xml
+++ b/doc/classes/EditorVCSInterface.xml
@@ -4,7 +4,7 @@
Version Control System (VCS) interface which reads and writes to the local VCS in use.
</brief_description>
<description>
- Used by the editor to display VCS extracted information in the editor. The implementation of this API is included in VCS addons, which are essentially GDNative plugins that need to be put into the project folder. These VCS addons are scripts which are attached (on demand) to the object instance of [code]EditorVCSInterface[/code]. All the functions listed below, instead of performing the task themselves, they call the internally defined functions in the VCS addons to provide a plug-n-play experience.
+ Used by the editor to display VCS extracted information in the editor. The implementation of this API is included in VCS addons, which are essentially GDExtension plugins that need to be put into the project folder. These VCS addons are scripts which are attached (on demand) to the object instance of [code]EditorVCSInterface[/code]. All the functions listed below, instead of performing the task themselves, they call the internally defined functions in the VCS addons to provide a plug-n-play experience.
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml
index 78dbf8729b..c5d567c1fe 100644
--- a/doc/classes/Material.xml
+++ b/doc/classes/Material.xml
@@ -11,6 +11,26 @@
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
</tutorials>
<methods>
+ <method name="_can_do_next_pass" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_can_use_render_priority" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_shader_mode" qualifiers="virtual const">
+ <return type="int" enum="Shader.Mode" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_shader_rid" qualifiers="virtual const">
+ <return type="RID" />
+ <description>
+ </description>
+ </method>
<method name="inspect_native_shader_code">
<return type="void" />
<description>
@@ -22,7 +42,7 @@
Sets the [Material] to be used for the next pass. This renders the object again using a different material.
[b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial".
</member>
- <member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority" default="0">
+ <member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority">
Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects.
[b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial".
[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).
diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml
index c5bfdcecd2..e4116cddfe 100644
--- a/doc/classes/Mesh.xml
+++ b/doc/classes/Mesh.xml
@@ -13,6 +13,89 @@
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
</tutorials>
<methods>
+ <method name="_get_aabb" qualifiers="virtual const">
+ <return type="AABB" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_blend_shape_count" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_blend_shape_name" qualifiers="virtual const">
+ <return type="StringName" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_surface_count" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_set_blend_shape_name" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="index" type="int" />
+ <argument index="1" name="name" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_array_index_len" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_array_len" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_arrays" qualifiers="virtual const">
+ <return type="Array" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_blend_shape_arrays" qualifiers="virtual const">
+ <return type="Array" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_format" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_lods" qualifiers="virtual const">
+ <return type="Dictionary" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_material" qualifiers="virtual const">
+ <return type="Material" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_get_primitive_type" qualifiers="virtual const">
+ <return type="int" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_surface_set_material" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="index" type="int" />
+ <argument index="1" name="material" type="Material" />
+ <description>
+ </description>
+ </method>
<method name="create_convex_shape" qualifiers="const">
<return type="Shape3D" />
<argument index="0" name="clean" type="bool" default="true" />
diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml
index d0136e389a..329d81342b 100644
--- a/doc/classes/PrimitiveMesh.xml
+++ b/doc/classes/PrimitiveMesh.xml
@@ -9,6 +9,11 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_create_mesh_array" qualifiers="virtual const">
+ <return type="Array" />
+ <description>
+ </description>
+ </method>
<method name="get_mesh_arrays" qualifiers="const">
<return type="Array" />
<description>
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index be2c1ad372..701e947fd1 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -1493,7 +1493,7 @@
</member>
<member name="physics/3d/physics_engine" type="String" setter="" getter="" default="&quot;DEFAULT&quot;">
Sets which physics engine to use for 3D physics.
- "DEFAULT" is currently the [url=https://bulletphysics.org]Bullet[/url] physics engine. The "GodotPhysics3D" engine is still supported as an alternative.
+ "DEFAULT" and "GodotPhysics3D" are the same, as there is currently no alternative 3D physics server implemented.
</member>
<member name="physics/3d/run_on_separate_thread" type="bool" setter="" getter="" default="false">
If [code]true[/code], the 3D physics server runs on a separate thread, making better use of multi-core CPUs. If [code]false[/code], the 3D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process.
@@ -1504,10 +1504,6 @@
<member name="physics/3d/sleep_threshold_linear" type="float" setter="" getter="" default="0.1">
Threshold linear velocity under which a 3D physics body will be considered inactive. See [constant PhysicsServer3D.SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD].
</member>
- <member name="physics/3d/smooth_trimesh_collision" type="bool" setter="" getter="" default="false">
- If [code]true[/code], smooths out collision with trimesh shapes ([ConcavePolygonShape3D]) by telling the Bullet physics engine to generate internal edge information for every trimesh shape created.
- [b]Note:[/b] Only effective if [member physics/3d/physics_engine] is set to [code]Bullet[/code], [i]not[/i] [code]DEFAULT[/code] or [code]GodotPhysics[/code].
- </member>
<member name="physics/3d/solver/contact_max_allowed_penetration" type="float" setter="" getter="" default="0.01">
Maximum distance a shape can penetrate another shape before it is considered a collision. See [constant PhysicsServer3D.SPACE_PARAM_CONTACT_MAX_ALLOWED_PENETRATION].
</member>
diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml
index 70a9912b76..c150198eb1 100644
--- a/doc/classes/Range.xml
+++ b/doc/classes/Range.xml
@@ -9,6 +9,12 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_value_changed" qualifiers="virtual">
+ <return type="void" />
+ <argument index="0" name="" type="float" />
+ <description>
+ </description>
+ </method>
<method name="share">
<return type="void" />
<argument index="0" name="with" type="Node" />
diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml
index 0850d39015..b08b1540ab 100644
--- a/doc/classes/Resource.xml
+++ b/doc/classes/Resource.xml
@@ -12,6 +12,11 @@
<link title="When and how to avoid using nodes for everything">$DOCS_URL/tutorials/best_practices/node_alternatives.html</link>
</tutorials>
<methods>
+ <method name="_get_rid" qualifiers="virtual">
+ <return type="RID" />
+ <description>
+ </description>
+ </method>
<method name="duplicate" qualifiers="const">
<return type="Resource" />
<argument index="0" name="subresources" type="bool" default="false" />
diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml
index 85cdcc7f8f..285176b8b0 100644
--- a/doc/classes/RigidDynamicBody3D.xml
+++ b/doc/classes/RigidDynamicBody3D.xml
@@ -227,7 +227,6 @@
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap].
[code]body_shape_index[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body.shape_find_owner(body_shape_index))[/code].
[code]local_shape_index[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(self.shape_find_owner(local_shape_index))[/code].
- [b]Note:[/b] Bullet physics cannot identify the shape index when using a [ConcavePolygonShape3D]. Don't use multiple [CollisionShape3D]s when using a [ConcavePolygonShape3D] with Bullet physics if you need shape indices.
</description>
</signal>
<signal name="body_shape_exited">
@@ -241,7 +240,6 @@
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap].
[code]body_shape_index[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body.shape_find_owner(body_shape_index))[/code].
[code]local_shape_index[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(self.shape_find_owner(local_shape_index))[/code].
- [b]Note:[/b] Bullet physics cannot identify the shape index when using a [ConcavePolygonShape3D]. Don't use multiple [CollisionShape3D]s when using a [ConcavePolygonShape3D] with Bullet physics if you need shape indices.
</description>
</signal>
<signal name="sleeping_state_changed">
diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml
index f805692f4d..bc2333f26a 100644
--- a/doc/classes/StyleBox.xml
+++ b/doc/classes/StyleBox.xml
@@ -10,6 +10,37 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_draw" qualifiers="virtual const">
+ <return type="void" />
+ <argument index="0" name="to_canvas_item" type="RID" />
+ <argument index="1" name="rect" type="Rect2" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_center_size" qualifiers="virtual const">
+ <return type="Vector2" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_draw_rect" qualifiers="virtual const">
+ <return type="Rect2" />
+ <argument index="0" name="rect" type="Rect2" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_style_margin" qualifiers="virtual const">
+ <return type="float" />
+ <argument index="0" name="side" type="int" enum="Side" />
+ <description>
+ </description>
+ </method>
+ <method name="_test_mask" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="point" type="Vector2" />
+ <argument index="1" name="rect" type="Rect2" />
+ <description>
+ </description>
+ </method>
<method name="draw" qualifiers="const">
<return type="void" />
<argument index="0" name="canvas_item" type="RID" />
diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml
index 6ddcc2044d..698de783c0 100644
--- a/doc/classes/TabBar.xml
+++ b/doc/classes/TabBar.xml
@@ -211,6 +211,9 @@
<member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled" default="false">
If [code]true[/code], tabs can be rearranged with mouse drag.
</member>
+ <member name="max_tab_width" type="int" setter="set_max_tab_width" getter="get_max_tab_width" default="0">
+ Sets the maximum width which all tabs should be limited to. Unlimited if set to [code]0[/code].
+ </member>
<member name="scroll_to_selected" type="bool" setter="set_scroll_to_selected" getter="get_scroll_to_selected" default="true">
If [code]true[/code], the tab offset will be changed to keep the the currently selected tab visible.
</member>
diff --git a/doc/classes/Texture2D.xml b/doc/classes/Texture2D.xml
index de9bbb4b3d..1bbebe085e 100644
--- a/doc/classes/Texture2D.xml
+++ b/doc/classes/Texture2D.xml
@@ -12,6 +12,58 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_draw" qualifiers="virtual const">
+ <return type="void" />
+ <argument index="0" name="to_canvas_item" type="RID" />
+ <argument index="1" name="pos" type="Vector2" />
+ <argument index="2" name="modulate" type="Color" />
+ <argument index="3" name="transpose" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_draw_rect" qualifiers="virtual const">
+ <return type="void" />
+ <argument index="0" name="to_canvas_item" type="RID" />
+ <argument index="1" name="rect" type="Rect2" />
+ <argument index="2" name="tile" type="bool" />
+ <argument index="3" name="modulate" type="Color" />
+ <argument index="4" name="transpose" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_draw_rect_region" qualifiers="virtual const">
+ <return type="void" />
+ <argument index="0" name="tp_canvas_item" type="RID" />
+ <argument index="1" name="rect" type="Rect2" />
+ <argument index="2" name="src_rect" type="Rect2" />
+ <argument index="3" name="modulate" type="Color" />
+ <argument index="4" name="transpose" type="bool" />
+ <argument index="5" name="clip_uv" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_height" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_width" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_alpha" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="_is_pixel_opaque" qualifiers="virtual const">
+ <return type="bool" />
+ <argument index="0" name="x" type="int" />
+ <argument index="1" name="y" type="int" />
+ <description>
+ </description>
+ </method>
<method name="draw" qualifiers="const">
<return type="void" />
<argument index="0" name="canvas_item" type="RID" />
diff --git a/doc/classes/Texture3D.xml b/doc/classes/Texture3D.xml
index bdfa428328..4968f46fe8 100644
--- a/doc/classes/Texture3D.xml
+++ b/doc/classes/Texture3D.xml
@@ -7,6 +7,36 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_get_data" qualifiers="virtual const">
+ <return type="Image[]" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_depth" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_format" qualifiers="virtual const">
+ <return type="int" enum="Image.Format" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_height" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_width" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_mipmaps" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
<method name="get_data" qualifiers="const">
<return type="Image[]" />
<description>
diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml
index 13679908d7..3445329f32 100644
--- a/doc/classes/TextureLayered.xml
+++ b/doc/classes/TextureLayered.xml
@@ -9,6 +9,42 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_get_format" qualifiers="virtual const">
+ <return type="int" enum="Image.Format" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_height" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_layer_data" qualifiers="virtual const">
+ <return type="Image" />
+ <argument index="0" name="layer_index" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_layered_type" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_layers" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_get_width" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="_has_mipmaps" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ </description>
+ </method>
<method name="get_format" qualifiers="const">
<return type="int" enum="Image.Format" />
<description>
diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml
index bb59881db9..dd83fa54ff 100644
--- a/doc/classes/Time.xml
+++ b/doc/classes/Time.xml
@@ -97,6 +97,13 @@
If [code]use_space[/code] is true, use a space instead of the letter T in the middle.
</description>
</method>
+ <method name="get_offset_string_from_offset_minutes" qualifiers="const">
+ <return type="String" />
+ <argument index="0" name="offset_minutes" type="int" />
+ <description>
+ Converts the given timezone offset in minutes to a timezone offset string. For example, -480 returns "-08:00", 345 returns "+05:45", and 0 returns "+00:00".
+ </description>
+ </method>
<method name="get_ticks_msec" qualifiers="const">
<return type="int" />
<description>
diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml
index f2104d77ab..0d6fcd0ef5 100644
--- a/doc/classes/Variant.xml
+++ b/doc/classes/Variant.xml
@@ -25,7 +25,6 @@
- GDScript automatically wrap values in them. It keeps all data in plain Variants by default and then optionally enforces custom static typing rules on variable types.
- VisualScript tracks properties inside Variants as well, but it also uses static typing. The GUI interface enforces that properties have a particular type that doesn't change over time.
- C# is statically typed, but uses the Mono [code]object[/code] type in place of Godot's Variant class when it needs to represent a dynamic value. [code]object[/code] is the Mono runtime's equivalent of the same concept.
- - The statically-typed language NativeScript C++ does not define a built-in Variant-like class. Godot's GDNative bindings provide their own godot::Variant class for users; Any point at which the C++ code starts interacting with the Godot runtime is a place where you might have to start wrapping data inside Variant objects.
The global [method @GlobalScope.typeof] function returns the enumerated value of the Variant type stored in the current variable (see [enum Variant.Type]).
[codeblocks]
[gdscript]
diff --git a/doc/classes/VideoStreamPlayer.xml b/doc/classes/VideoStreamPlayer.xml
index 033e1ecd29..092a754a39 100644
--- a/doc/classes/VideoStreamPlayer.xml
+++ b/doc/classes/VideoStreamPlayer.xml
@@ -5,7 +5,7 @@
</brief_description>
<description>
Control node for playing video streams using [VideoStream] resources.
- Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDNative plugin using [VideoStreamGDNative].
+ Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDExtension plugin.
[b]Note:[/b] Due to a bug, VideoStreamPlayer does not support localization remapping yet.
[b]Warning:[/b] On HTML5, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations.
</description>
@@ -69,7 +69,7 @@
</member>
<member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position">
The current position of the stream, in seconds.
- [b]Note:[/b] Changing this value won't have any effect as seeking is not implemented yet, except in video formats implemented by a GDNative add-on.
+ [b]Note:[/b] Changing this value won't have any effect as seeking is not implemented yet, except in video formats implemented by a GDExtension add-on.
</member>
<member name="volume" type="float" setter="set_volume" getter="get_volume">
Audio volume as a linear value.
diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml
index 1aae85c7e1..7efa1f4df8 100644
--- a/doc/classes/VisualInstance3D.xml
+++ b/doc/classes/VisualInstance3D.xml
@@ -9,6 +9,11 @@
<tutorials>
</tutorials>
<methods>
+ <method name="_get_aabb" qualifiers="virtual const">
+ <return type="AABB" />
+ <description>
+ </description>
+ </method>
<method name="get_aabb" qualifiers="const">
<return type="AABB" />
<description>
diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml
index 623e4f5fbc..0f4159cbbf 100644
--- a/doc/classes/XRInterface.xml
+++ b/doc/classes/XRInterface.xml
@@ -4,7 +4,7 @@
Base class for an XR interface implementation.
</brief_description>
<description>
- This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDNative modules (note that for GDNative the subclass XRScriptInterface should be used). Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform.
+ This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDExtension modules. Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform.
Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through [XRServer].
</description>
<tutorials>
diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml
index da378759d8..d15558c9e8 100644
--- a/doc/classes/XRPositionalTracker.xml
+++ b/doc/classes/XRPositionalTracker.xml
@@ -72,6 +72,9 @@
- [code]left_hand[/code] identifies the controller held in the players left hand
- [code]right_hand[/code] identifies the controller held in the players right hand
</member>
+ <member name="profile" type="String" setter="set_tracker_profile" getter="get_tracker_profile" default="&quot;&quot;">
+ The profile associated with this tracker, interface dependent but will indicate the type of controller being tracked.
+ </member>
<member name="type" type="int" setter="set_tracker_type" getter="get_tracker_type" enum="XRServer.TrackerType" default="128">
The type of tracker.
</member>
@@ -109,6 +112,12 @@
Emitted when the state of a pose tracked by this tracker changes.
</description>
</signal>
+ <signal name="profile_changed">
+ <argument index="0" name="role" type="String" />
+ <description>
+ Emitted when the profile of our tracker changes.
+ </description>
+ </signal>
</signals>
<constants>
<constant name="TRACKER_HAND_UNKNOWN" value="0" enum="TrackerHand">