Skip to content

Commit

Permalink
Add "Breaking changes in Godot 4.1" page
Browse files Browse the repository at this point in the history
  • Loading branch information
@raulsntos
raulsntos committed Jul 5, 2023
1 parent c780bee commit f302e65
Show file tree
Hide file tree
Showing 2 changed files with 157 additions and 0 deletions.
156 changes: 156 additions & 0 deletions tutorials/migrating/breaking_changes_4.1.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
.. _doc_breaking_changes_4.1:

Breaking changes in Godot 4.1
=================================

If you are migrating from 4.0 to 4.1, the breaking changes listed here might
affect you. Changes are grouped by areas/systems.

This article indicates whether each breaking change is *binary compatible* or
*source compatible*:

- **Binary compatible** - Existing binaries will load and execute successfully without
recompilation, and the run-time behavior won't change.
- **Source compatible** - Source code will compile successfully without changes when
upgrading Godot.

Core
---

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**UndoRedo**
Method ``create_action`` adds a new ``backward_undo_ops`` optional parameter ❌ ✔️ `GH-76688`_ --
======================================================================================================================== ================= ================= ============ ==================

Animation
---------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**AnimationNode**
Method ``_process`` adds a new ``test_only`` parameter ❌ ❌ `GH-75759`_ GDScript, C#
Method ``blend_input`` adds a new ``test_only`` optional parameter ❌ ✔️ `GH-75759`_ --
Method ``blend_node`` adds a new ``test_only`` optional parameter ❌ ✔️ `GH-75759`_ --
======================================================================================================================== ================= ================= ============ ==================

2D nodes
--------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**PathFollow2D**
Property ``lookahead`` removed ❌ ❌ `GH-72842`_ GDScript, C#
======================================================================================================================== ================= ================= ============ ==================

3D nodes
--------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**Geometry3D**
Method ``segment_intersects_convex`` changes ``planes`` parameter type from untyped ``Array`` to ``Array[Plane]`` ❌ ❌ `GH-76418`_ --
**MeshInstance3D**
Method ``create_multiple_convex_collisions`` adds a new ``settings`` optional parameter ❌ ✔️ `GH-72152`_ --
**Node3D**
Method ``look_at`` adds a new ``use_model_front`` optional parameter ❌ ✔️ `GH-76082`_ --
Method ``look_at_from_position`` adds a new ``use_model_front`` optional parameter ❌ ✔️ `GH-76082`_ --
======================================================================================================================== ================= ================= ============ ==================

GUI nodes
---------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**CodeEdit**
Method ``add_code_completion_option`` adds a new ``location`` optional parameter ❌ ✔️ `GH-75746`_ --
**RichTextLabel**
Method ``push_list`` adds a new ``bullet`` optional parameter ❌ ✔️ `GH-75017`_ --
Method ``push_paragraph`` adds a new ``justification_flags`` optional parameter ❌ ✔️ `GH-75250`_ --
Method ``push_paragraph`` adds a new ``tab_stops`` optional parameter ❌ ✔️ `GH-76401`_ --
**Tree**
Method ``edit_selected`` adds a new ``force_edit`` optional parameter ❌ ✔️ `GH-76794`_ --
======================================================================================================================== ================= ================= ============ ==================

Rendering
---------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**RenderingDevice**
Method ``draw_list_begin`` changes ``storage_textures`` parameter type from untyped ``Array`` to ``Array[RID]`` ❌ ❌ `GH-76418`_ --
**SurfaceTool**
Method ``add_triangle_fan`` changes ``tangents`` parameter type from untyped ``Array`` to ``Array[Plane]`` ❌ ❌ `GH-76418`_ --
======================================================================================================================== ================= ================= ============ ==================

Navigation
----------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**NavigationAgent2D**
Method ``set_velocity`` replaced with ``velocity`` property ❌ ❌ `GH-69988`_ GDScript, C#
Property ``time_horizon`` split into ``time_horizon_agents`` and ``time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C#
**NavigationAgent3D**
Property ``agent_height_offset`` renamed to ``path_height_offset`` ❌ ❌ `GH-69988`_ GDScript, C#
Property ``ignore_y`` removed ❌ ❌ `GH-69988`_ GDScript, C#
Method ``set_velocity`` replaced with ``velocity`` property ❌ ❌ `GH-69988`_ GDScript, C#
Property ``time_horizon`` split into ``time_horizon_agents`` and ``time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C#
**NavigationObstacle2D**
Property ``estimate_radius`` removed ❌ ❌ `GH-69988`_ GDScript, C#
Method ``get_rid`` renamed to ``get_agent_rid`` ❌ ❌ `GH-69988`_ GDScript, C#
**NavigationObstacle3D**
Property ``estimate_radius`` removed ❌ ❌ `GH-69988`_ GDScript, C#
Method ``get_rid`` renamed to ``get_agent_rid`` ❌ ❌ `GH-69988`_ GDScript, C#
**NavigationServer2D**
Method ``agent_set_callback`` renamed to ``agent_set_avoidance_callback`` ❌ ❌ `GH-69988`_ GDScript, C#
Method ``agent_set_target_velocity`` removed ❌ ❌ `GH-69988`_ GDScript, C#
Method ``agent_set_time_horizon`` split into ``agent_set_time_horizon_agents`` and ``agent_set_time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C#
**NavigationServer3D**
Method ``agent_set_callback`` renamed to ``agent_set_avoidance_callback`` ❌ ❌ `GH-69988`_ GDScript, C#
Method ``agent_set_target_velocity`` removed ❌ ❌ `GH-69988`_ GDScript, C#
Method ``agent_set_time_horizon`` split into ``agent_set_time_horizon_agents`` and ``agent_set_time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C#
======================================================================================================================== ================= ================= ============ ==================

Editor plugins
--------------

======================================================================================================================== ================= ================= ============ ==================
Change Binary Compatible Source Compatible Introduced Languages affected
======================================================================================================================== ================= ================= ============ ==================
**AnimationTrackEditPlugin**
Type ``AnimationTrackEditPlugin`` removed ❌ ❌ `GH-76413`_ GDScript, C#
**EditorInterface**
Type ``EditorInterface`` changes inheritance from ``Node`` to ``Object`` ❌ ❌ `GH-76176`_ C#
Method ``set_movie_maker_enabled`` replaced with ``movie_maker_enabled`` property ❌ ❌ `GH-76176`_ C#
Method ``is_movie_maker_enabled`` replaced with ``movie_maker_enabled`` property ❌ ❌ `GH-76176`_ C#
**EditorResourcePreviewGenerator**
Method ``_generate`` adds a new ``metadata`` parameter ❌ ❌ `GH-64628`_ GDScript, C#
Method ``_generate_from_path`` adds a new ``metadata`` parameter ❌ ❌ `GH-64628`_ GDScript, C#
**EditorUndoRedoManager**
Method ``create_action`` adds a new ``backward_undo_ops`` optional parameter ❌ ✔️ `GH-76688`_ --
======================================================================================================================== ================= ================= ============ ==================


.. _GH-64628: https://github.com/godotengine/godot/pull/64628
.. _GH-69988: https://github.com/godotengine/godot/pull/69988
.. _GH-72152: https://github.com/godotengine/godot/pull/72152
.. _GH-72842: https://github.com/godotengine/godot/pull/72842
.. _GH-75017: https://github.com/godotengine/godot/pull/75017
.. _GH-75250: https://github.com/godotengine/godot/pull/75250
.. _GH-75746: https://github.com/godotengine/godot/pull/75746
.. _GH-75759: https://github.com/godotengine/godot/pull/75759
.. _GH-76082: https://github.com/godotengine/godot/pull/76082
.. _GH-76176: https://github.com/godotengine/godot/pull/76176
.. _GH-76401: https://github.com/godotengine/godot/pull/76401
.. _GH-76413: https://github.com/godotengine/godot/pull/76413
.. _GH-76418: https://github.com/godotengine/godot/pull/76418
.. _GH-76688: https://github.com/godotengine/godot/pull/76688
.. _GH-76794: https://github.com/godotengine/godot/pull/76794
1 change: 1 addition & 0 deletions tutorials/migrating/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ path.
:name: toc-migrating

upgrading_to_godot_4
breaking_changes_4.1

0 comments on commit f302e65

Please sign in to comment.