From fb93c042264fe5081eb8a72aa4c774f9b52e1d94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 1 Mar 2023 14:39:39 +0100 Subject: [PATCH] classref: Sync with 4.0-stable --- classes/class_editorexportplugin.rst | 14 +++- classes/class_editorpaths.rst | 2 +- classes/class_gltfstate.rst | 32 --------- classes/class_mesh.rst | 56 ++++------------ classes/class_meshinstance3d.rst | 26 +++----- classes/class_scriptlanguageextension.rst | 80 ----------------------- classes/class_tween.rst | 4 ++ classes/class_vehiclebody3d.rst | 4 +- 8 files changed, 44 insertions(+), 174 deletions(-) diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index bfa42f92f..8cdf4241c 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -94,7 +94,9 @@ Method Descriptions :ref:`bool` **_begin_customize_resources** **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| -Return true if this plugin will customize resources based on the platform and features used. +Return ``true`` if this plugin will customize resources based on the platform and features used. + +When enabled, :ref:`_get_customization_configuration_hash`, :ref:`_customize_resource` and :ref:`_customize_scene` will be called and must be implemented. .. rst-class:: classref-item-separator @@ -122,6 +124,8 @@ Customize a resource. If changes are made to it, return the same or a new resour The *path* argument is only used when customizing an actual file, otherwise this means that this resource is part of another one and it will be empty. +Implementing this method is required if :ref:`_begin_customize_resources` returns ``true``. + .. rst-class:: classref-item-separator ---- @@ -134,6 +138,8 @@ The *path* argument is only used when customizing an actual file, otherwise this Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return ``null``. If a new scene is returned, it is up to you to dispose of the old one. +Implementing this method is required if :ref:`_begin_customize_resources` returns ``true``. + .. rst-class:: classref-item-separator ---- @@ -208,6 +214,8 @@ Calling :ref:`skip` inside this callback w Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations. +Implementing this method is required if :ref:`_begin_customize_resources` returns ``true``. + .. rst-class:: classref-item-separator ---- @@ -230,7 +238,9 @@ Return a :ref:`PackedStringArray` of additional feature :ref:`String` **_get_name** **(** **)** |virtual| |const| -Return the name identifier of this plugin (for future identification by the exporter). +Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting. + +Implementing this method is required. .. rst-class:: classref-item-separator diff --git a/classes/class_editorpaths.rst b/classes/class_editorpaths.rst index f23fe30ee..49406fec2 100644 --- a/classes/class_editorpaths.rst +++ b/classes/class_editorpaths.rst @@ -30,7 +30,7 @@ This editor-only singleton returns OS-specific paths to various data folders and Tutorials --------- -- `File paths in Godot projects `__ +- :doc:`File paths in Godot projects <../tutorials/io/data_paths>` .. rst-class:: classref-reftable-group diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 82962260e..f30b19535 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -85,8 +85,6 @@ Methods +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_scene_node` **(** :ref:`int` idx **)** | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_skeleton_to_node` **(** **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GLTFSkeleton[]` | :ref:`get_skeletons` **(** **)** | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GLTFSkin[]` | :ref:`get_skins` **(** **)** | @@ -121,8 +119,6 @@ Methods +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_nodes` **(** :ref:`GLTFNode[]` nodes **)** | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_skeleton_to_node` **(** :ref:`Dictionary` skeleton_to_node **)** | - +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_skeletons` **(** :ref:`GLTFSkeleton[]` skeletons **)** | +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_skins` **(** :ref:`GLTFSkin[]` skins **)** | @@ -589,20 +585,6 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_skeleton_to_node** **(** **)** - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - .. _class_GLTFState_method_get_skeletons: .. rst-class:: classref-method @@ -839,20 +821,6 @@ void **set_nodes** **(** :ref:`GLTFNode[]` nodes **)** ---- -.. _class_GLTFState_method_set_skeleton_to_node: - -.. rst-class:: classref-method - -void **set_skeleton_to_node** **(** :ref:`Dictionary` skeleton_to_node **)** - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - .. _class_GLTFState_method_set_skeletons: .. rst-class:: classref-method diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index b3d5f813e..0385cf53c 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -652,9 +652,7 @@ Method Descriptions :ref:`AABB` **_get_aabb** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the :ref:`AABB` for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -666,9 +664,7 @@ Method Descriptions :ref:`int` **_get_blend_shape_count** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the number of blend shapes for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -680,9 +676,7 @@ Method Descriptions :ref:`StringName` **_get_blend_shape_name** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the retrieval of blend shape names for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -694,9 +688,7 @@ Method Descriptions :ref:`int` **_get_surface_count** **(** **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface count for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -708,9 +700,7 @@ Method Descriptions void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringName` name **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the names of blend shapes for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -722,9 +712,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`int` **_surface_get_array_index_len** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface array index length for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -736,9 +724,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`int` **_surface_get_array_len** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface array length for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -750,9 +736,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`Array` **_surface_get_arrays** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface arrays for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -764,9 +748,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`Array[]` **_surface_get_blend_shape_arrays** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the blend shape arrays for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -778,9 +760,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`int` **_surface_get_format** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface format for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -792,9 +772,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`Dictionary` **_surface_get_lods** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface LODs for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -806,9 +784,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`Material` **_surface_get_material** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface material for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -820,9 +796,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa :ref:`int` **_surface_get_primitive_type** **(** :ref:`int` index **)** |virtual| |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the surface primitive type for a custom class extending **Mesh**. .. rst-class:: classref-item-separator @@ -834,9 +808,7 @@ void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringNa void **_surface_set_material** **(** :ref:`int` index, :ref:`Material` material **)** |virtual| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Virtual method to override the setting of a ``material`` at the given ``index`` for a custom class extending **Mesh**. .. rst-class:: classref-item-separator diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index 5aeeadae6..2d6740744 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -140,7 +140,7 @@ The :ref:`Mesh` resource for the instance. - void **set_skin** **(** :ref:`Skin` value **)** - :ref:`Skin` **get_skin** **(** **)** -Sets the skin to be used by this instance. +The :ref:`Skin` to be used by this instance. .. rst-class:: classref-section-separator @@ -209,9 +209,7 @@ This helper creates a :ref:`StaticBody3D` child node with a :ref:`int` **find_blend_shape_by_name** **(** :ref:`StringName` name **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the index of the blend shape with the given ``name``. Returns ``-1`` if no blend shape with this name exists, including when :ref:`mesh` is ``null``. .. rst-class:: classref-item-separator @@ -223,7 +221,9 @@ This helper creates a :ref:`StaticBody3D` child node with a :ref:`Material` **get_active_material** **(** :ref:`int` surface **)** |const| -Returns the :ref:`Material` that will be used by the :ref:`Mesh` when drawing. This can return the :ref:`GeometryInstance3D.material_override`, the surface override :ref:`Material` defined in this **MeshInstance3D**, or the surface :ref:`Material` defined in the :ref:`Mesh`. For example, if :ref:`GeometryInstance3D.material_override` is used, all surfaces will return the override material. +Returns the :ref:`Material` that will be used by the :ref:`Mesh` when drawing. This can return the :ref:`GeometryInstance3D.material_override`, the surface override :ref:`Material` defined in this **MeshInstance3D**, or the surface :ref:`Material` defined in the :ref:`mesh`. For example, if :ref:`GeometryInstance3D.material_override` is used, all surfaces will return the override material. + +Returns ``null`` if no material is active, including when :ref:`mesh` is ``null``. .. rst-class:: classref-item-separator @@ -235,9 +235,7 @@ Returns the :ref:`Material` that will be used by the :ref:`Mesh< :ref:`int` **get_blend_shape_count** **(** **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the number of blend shapes available. Produces an error if :ref:`mesh` is ``null``. .. rst-class:: classref-item-separator @@ -249,9 +247,7 @@ Returns the :ref:`Material` that will be used by the :ref:`Mesh< :ref:`float` **get_blend_shape_value** **(** :ref:`int` blend_shape_idx **)** |const| -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns the value of the blend shape at the given ``blend_shape_idx``. Returns ``0.0`` and produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. .. rst-class:: classref-item-separator @@ -263,7 +259,7 @@ Returns the :ref:`Material` that will be used by the :ref:`Mesh< :ref:`Material` **get_surface_override_material** **(** :ref:`int` surface **)** |const| -Returns the override :ref:`Material` for the specified surface of the :ref:`Mesh` resource. +Returns the override :ref:`Material` for the specified ``surface`` of the :ref:`Mesh` resource. .. rst-class:: classref-item-separator @@ -287,9 +283,7 @@ Returns the number of surface override materials. This is equivalent to :ref:`Me void **set_blend_shape_value** **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Sets the value of the blend shape at ``blend_shape_idx`` to ``value``. Produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. .. rst-class:: classref-item-separator @@ -301,7 +295,7 @@ void **set_blend_shape_value** **(** :ref:`int` blend_shape_idx, :ref void **set_surface_override_material** **(** :ref:`int` surface, :ref:`Material` material **)** -Sets the override :ref:`Material` for the specified surface of the :ref:`Mesh` resource. This material is associated with this **MeshInstance3D** rather than with the :ref:`Mesh` resource. +Sets the override ``material`` for the specified ``surface`` of the :ref:`Mesh` resource. This material is associated with this **MeshInstance3D** rather than with :ref:`mesh`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 90e4bc5b7..8cf5669e1 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -29,8 +29,6 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_add_named_global_constant` **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void* | :ref:`_alloc_instance_binding_data` **(** :ref:`Object` object **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_auto_indent_code` **(** :ref:`String` code, :ref:`int` from_line, :ref:`int` to_line **)** |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_can_inherit_from_file` **(** **)** |virtual| |const| | @@ -59,16 +57,12 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_debug_parse_stack_level_expression` **(** :ref:`int` level, :ref:`String` expression, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`_execute_file` **(** :ref:`String` path **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_find_function` **(** :ref:`String` class_name, :ref:`String` function_name **)** |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_finish` **(** **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_frame` **(** **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_free_instance_binding_data` **(** void* data **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`_get_built_in_templates` **(** :ref:`StringName` object **)** |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_comment_delimiters` **(** **)** |virtual| |const| | @@ -121,10 +115,6 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_profiling_stop` **(** **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_refcount_decremented_instance_binding` **(** :ref:`Object` object **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_refcount_incremented_instance_binding` **(** :ref:`Object` object **)** |virtual| | - +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_reload_all_scripts` **(** **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_reload_tool_script` **(** :ref:`Script` script, :ref:`bool` soft_reload **)** |virtual| | @@ -416,20 +406,6 @@ void **_add_named_global_constant** **(** :ref:`StringName` na ---- -.. _class_ScriptLanguageExtension_method__alloc_instance_binding_data: - -.. rst-class:: classref-method - -void* **_alloc_instance_binding_data** **(** :ref:`Object` object **)** |virtual| - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - .. _class_ScriptLanguageExtension_method__auto_indent_code: .. rst-class:: classref-method @@ -626,20 +602,6 @@ void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)* ---- -.. _class_ScriptLanguageExtension_method__execute_file: - -.. rst-class:: classref-method - -:ref:`Error` **_execute_file** **(** :ref:`String` path **)** |virtual| - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - .. _class_ScriptLanguageExtension_method__find_function: .. rst-class:: classref-method @@ -682,20 +644,6 @@ void **_frame** **(** **)** |virtual| ---- -.. _class_ScriptLanguageExtension_method__free_instance_binding_data: - -.. rst-class:: classref-method - -void **_free_instance_binding_data** **(** void* data **)** |virtual| - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - .. _class_ScriptLanguageExtension_method__get_built_in_templates: .. rst-class:: classref-method @@ -1060,34 +1008,6 @@ void **_profiling_stop** **(** **)** |virtual| ---- -.. _class_ScriptLanguageExtension_method__refcount_decremented_instance_binding: - -.. rst-class:: classref-method - -:ref:`bool` **_refcount_decremented_instance_binding** **(** :ref:`Object` object **)** |virtual| - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - -.. _class_ScriptLanguageExtension_method__refcount_incremented_instance_binding: - -.. rst-class:: classref-method - -void **_refcount_incremented_instance_binding** **(** :ref:`Object` object **)** |virtual| - -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! - -.. rst-class:: classref-item-separator - ----- - .. _class_ScriptLanguageExtension_method__reload_all_scripts: .. rst-class:: classref-method diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 0724dacb0..cc7d2259b 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -660,6 +660,8 @@ Resumes a paused or stopped **Tween**. Sets the default ease type for :ref:`PropertyTweener`\ s and :ref:`MethodTweener`\ s animated by this **Tween**. +If not specified, the default value is :ref:`EASE_IN_OUT`. + .. rst-class:: classref-item-separator ---- @@ -740,6 +742,8 @@ Scales the speed of tweening. This affects all :ref:`Tweener`\ s Sets the default transition type for :ref:`PropertyTweener`\ s and :ref:`MethodTweener`\ s animated by this **Tween**. +If not specified, the default value is :ref:`TRANS_LINEAR`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_vehiclebody3d.rst b/classes/class_vehiclebody3d.rst index 09cb66a95..54b51cad3 100644 --- a/classes/class_vehiclebody3d.rst +++ b/classes/class_vehiclebody3d.rst @@ -110,7 +110,9 @@ A negative value will result in the vehicle reversing. - void **set_steering** **(** :ref:`float` value **)** - :ref:`float` **get_steering** **(** **)** -The steering angle for the vehicle, in radians. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel3D.use_as_steering` set to ``true`` will automatically be rotated. +The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel3D.use_as_steering` set to ``true`` will automatically be rotated. + +\ **Note:** This property is edited in the inspector in degrees. In code the property is set in radians. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`