diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AudioEffect.xml | 7 | ||||
| -rw-r--r-- | doc/classes/AudioEffectInstance.xml | 15 | ||||
| -rw-r--r-- | doc/classes/AudioStreamPlaybackResampled.xml | 19 | ||||
| -rw-r--r-- | doc/classes/Material.xml | 22 | ||||
| -rw-r--r-- | doc/classes/Mesh.xml | 83 | ||||
| -rw-r--r-- | doc/classes/PrimitiveMesh.xml | 5 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Range.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Resource.xml | 5 | ||||
| -rw-r--r-- | doc/classes/RigidDynamicBody3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/StyleBox.xml | 31 | ||||
| -rw-r--r-- | doc/classes/Texture2D.xml | 52 | ||||
| -rw-r--r-- | doc/classes/Texture3D.xml | 30 | ||||
| -rw-r--r-- | doc/classes/TextureLayered.xml | 36 | ||||
| -rw-r--r-- | doc/classes/VisualInstance3D.xml | 5 |
15 files changed, 316 insertions, 8 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/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/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=""DEFAULT""> 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/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/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> |