|
| 1 | +.. _doc_breaking_changes_4.1: |
| 2 | + |
| 3 | +Breaking changes in Godot 4.1 |
| 4 | +================================= |
| 5 | + |
| 6 | +If you are migrating from 4.0 to 4.1, the breaking changes listed here might |
| 7 | +affect you. Changes are grouped by areas/systems. |
| 8 | + |
| 9 | +This article indicates whether each breaking change is *binary compatible* or |
| 10 | +*source compatible*: |
| 11 | + |
| 12 | +- **Binary compatible** - Existing binaries will load and execute successfully without |
| 13 | + recompilation, and the run-time behavior won't change. |
| 14 | +- **Source compatible** - Source code will compile successfully without changes when |
| 15 | + upgrading Godot. |
| 16 | + |
| 17 | +Core |
| 18 | +--- |
| 19 | + |
| 20 | +======================================================================================================================== ================= ================= ============ ================== |
| 21 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 22 | +======================================================================================================================== ================= ================= ============ ================== |
| 23 | +**UndoRedo** |
| 24 | +Method ``create_action`` adds a new ``backward_undo_ops`` optional parameter ❌ ✔️ `GH-76688`_ -- |
| 25 | +======================================================================================================================== ================= ================= ============ ================== |
| 26 | + |
| 27 | +Animation |
| 28 | +--------- |
| 29 | + |
| 30 | +======================================================================================================================== ================= ================= ============ ================== |
| 31 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 32 | +======================================================================================================================== ================= ================= ============ ================== |
| 33 | +**AnimationNode** |
| 34 | +Method ``_process`` adds a new ``test_only`` parameter ❌ ❌ `GH-75759`_ GDScript, C# |
| 35 | +Method ``blend_input`` adds a new ``test_only`` optional parameter ❌ ✔️ `GH-75759`_ -- |
| 36 | +Method ``blend_node`` adds a new ``test_only`` optional parameter ❌ ✔️ `GH-75759`_ -- |
| 37 | +======================================================================================================================== ================= ================= ============ ================== |
| 38 | + |
| 39 | +2D nodes |
| 40 | +-------- |
| 41 | + |
| 42 | +======================================================================================================================== ================= ================= ============ ================== |
| 43 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 44 | +======================================================================================================================== ================= ================= ============ ================== |
| 45 | +**PathFollow2D** |
| 46 | +Property ``lookahead`` removed ❌ ❌ `GH-72842`_ GDScript, C# |
| 47 | +======================================================================================================================== ================= ================= ============ ================== |
| 48 | + |
| 49 | +3D nodes |
| 50 | +-------- |
| 51 | + |
| 52 | +======================================================================================================================== ================= ================= ============ ================== |
| 53 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 54 | +======================================================================================================================== ================= ================= ============ ================== |
| 55 | +**Geometry3D** |
| 56 | +Method ``segment_intersects_convex`` changes ``planes`` parameter type from untyped ``Array`` to ``Array[Plane]`` ❌ ❌ `GH-76418`_ -- |
| 57 | +**MeshInstance3D** |
| 58 | +Method ``create_multiple_convex_collisions`` adds a new ``settings`` optional parameter ❌ ✔️ `GH-72152`_ -- |
| 59 | +**Node3D** |
| 60 | +Method ``look_at`` adds a new ``use_model_front`` optional parameter ❌ ✔️ `GH-76082`_ -- |
| 61 | +Method ``look_at_from_position`` adds a new ``use_model_front`` optional parameter ❌ ✔️ `GH-76082`_ -- |
| 62 | +======================================================================================================================== ================= ================= ============ ================== |
| 63 | + |
| 64 | +GUI nodes |
| 65 | +--------- |
| 66 | + |
| 67 | +======================================================================================================================== ================= ================= ============ ================== |
| 68 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 69 | +======================================================================================================================== ================= ================= ============ ================== |
| 70 | +**CodeEdit** |
| 71 | +Method ``add_code_completion_option`` adds a new ``location`` optional parameter ❌ ✔️ `GH-75746`_ -- |
| 72 | +**RichTextLabel** |
| 73 | +Method ``push_list`` adds a new ``bullet`` optional parameter ❌ ✔️ `GH-75017`_ -- |
| 74 | +Method ``push_paragraph`` adds a new ``justification_flags`` optional parameter ❌ ✔️ `GH-75250`_ -- |
| 75 | +Method ``push_paragraph`` adds a new ``tab_stops`` optional parameter ❌ ✔️ `GH-76401`_ -- |
| 76 | +**Tree** |
| 77 | +Method ``edit_selected`` adds a new ``force_edit`` optional parameter ❌ ✔️ `GH-76794`_ -- |
| 78 | +======================================================================================================================== ================= ================= ============ ================== |
| 79 | + |
| 80 | +Rendering |
| 81 | +--------- |
| 82 | + |
| 83 | +======================================================================================================================== ================= ================= ============ ================== |
| 84 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 85 | +======================================================================================================================== ================= ================= ============ ================== |
| 86 | +**RenderingDevice** |
| 87 | +Method ``draw_list_begin`` changes ``storage_textures`` parameter type from untyped ``Array`` to ``Array[RID]`` ❌ ❌ `GH-76418`_ -- |
| 88 | +**SurfaceTool** |
| 89 | +Method ``add_triangle_fan`` changes ``tangents`` parameter type from untyped ``Array`` to ``Array[Plane]`` ❌ ❌ `GH-76418`_ -- |
| 90 | +======================================================================================================================== ================= ================= ============ ================== |
| 91 | + |
| 92 | +Navigation |
| 93 | +---------- |
| 94 | + |
| 95 | +======================================================================================================================== ================= ================= ============ ================== |
| 96 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 97 | +======================================================================================================================== ================= ================= ============ ================== |
| 98 | +**NavigationAgent2D** |
| 99 | +Method ``set_velocity`` replaced with ``velocity`` property ❌ ❌ `GH-69988`_ GDScript, C# |
| 100 | +Property ``time_horizon`` split into ``time_horizon_agents`` and ``time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 101 | +**NavigationAgent3D** |
| 102 | +Property ``agent_height_offset`` renamed to ``path_height_offset`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 103 | +Property ``ignore_y`` removed ❌ ❌ `GH-69988`_ GDScript, C# |
| 104 | +Method ``set_velocity`` replaced with ``velocity`` property ❌ ❌ `GH-69988`_ GDScript, C# |
| 105 | +Property ``time_horizon`` split into ``time_horizon_agents`` and ``time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 106 | +**NavigationObstacle2D** |
| 107 | +Property ``estimate_radius`` removed ❌ ❌ `GH-69988`_ GDScript, C# |
| 108 | +Method ``get_rid`` renamed to ``get_agent_rid`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 109 | +**NavigationObstacle3D** |
| 110 | +Property ``estimate_radius`` removed ❌ ❌ `GH-69988`_ GDScript, C# |
| 111 | +Method ``get_rid`` renamed to ``get_agent_rid`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 112 | +**NavigationServer2D** |
| 113 | +Method ``agent_set_callback`` renamed to ``agent_set_avoidance_callback`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 114 | +Method ``agent_set_target_velocity`` removed ❌ ❌ `GH-69988`_ GDScript, C# |
| 115 | +Method ``agent_set_time_horizon`` split into ``agent_set_time_horizon_agents`` and ``agent_set_time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 116 | +**NavigationServer3D** |
| 117 | +Method ``agent_set_callback`` renamed to ``agent_set_avoidance_callback`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 118 | +Method ``agent_set_target_velocity`` removed ❌ ❌ `GH-69988`_ GDScript, C# |
| 119 | +Method ``agent_set_time_horizon`` split into ``agent_set_time_horizon_agents`` and ``agent_set_time_horizon_obstacles`` ❌ ❌ `GH-69988`_ GDScript, C# |
| 120 | +======================================================================================================================== ================= ================= ============ ================== |
| 121 | + |
| 122 | +Editor plugins |
| 123 | +-------------- |
| 124 | + |
| 125 | +======================================================================================================================== ================= ================= ============ ================== |
| 126 | +Change Binary Compatible Source Compatible Introduced Languages affected |
| 127 | +======================================================================================================================== ================= ================= ============ ================== |
| 128 | +**AnimationTrackEditPlugin** |
| 129 | +Type ``AnimationTrackEditPlugin`` removed ❌ ❌ `GH-76413`_ GDScript, C# |
| 130 | +**EditorInterface** |
| 131 | +Type ``EditorInterface`` changes inheritance from ``Node`` to ``Object`` ❌ ❌ `GH-76176`_ C# |
| 132 | +Method ``set_movie_maker_enabled`` replaced with ``movie_maker_enabled`` property ❌ ❌ `GH-76176`_ C# |
| 133 | +Method ``is_movie_maker_enabled`` replaced with ``movie_maker_enabled`` property ❌ ❌ `GH-76176`_ C# |
| 134 | +**EditorResourcePreviewGenerator** |
| 135 | +Method ``_generate`` adds a new ``metadata`` parameter ❌ ❌ `GH-64628`_ GDScript, C# |
| 136 | +Method ``_generate_from_path`` adds a new ``metadata`` parameter ❌ ❌ `GH-64628`_ GDScript, C# |
| 137 | +**EditorUndoRedoManager** |
| 138 | +Method ``create_action`` adds a new ``backward_undo_ops`` optional parameter ❌ ✔️ `GH-76688`_ -- |
| 139 | +======================================================================================================================== ================= ================= ============ ================== |
| 140 | + |
| 141 | + |
| 142 | +.. _GH-64628: https://github.com/godotengine/godot/pull/64628 |
| 143 | +.. _GH-69988: https://github.com/godotengine/godot/pull/69988 |
| 144 | +.. _GH-72152: https://github.com/godotengine/godot/pull/72152 |
| 145 | +.. _GH-72842: https://github.com/godotengine/godot/pull/72842 |
| 146 | +.. _GH-75017: https://github.com/godotengine/godot/pull/75017 |
| 147 | +.. _GH-75250: https://github.com/godotengine/godot/pull/75250 |
| 148 | +.. _GH-75746: https://github.com/godotengine/godot/pull/75746 |
| 149 | +.. _GH-75759: https://github.com/godotengine/godot/pull/75759 |
| 150 | +.. _GH-76082: https://github.com/godotengine/godot/pull/76082 |
| 151 | +.. _GH-76176: https://github.com/godotengine/godot/pull/76176 |
| 152 | +.. _GH-76401: https://github.com/godotengine/godot/pull/76401 |
| 153 | +.. _GH-76413: https://github.com/godotengine/godot/pull/76413 |
| 154 | +.. _GH-76418: https://github.com/godotengine/godot/pull/76418 |
| 155 | +.. _GH-76688: https://github.com/godotengine/godot/pull/76688 |
| 156 | +.. _GH-76794: https://github.com/godotengine/godot/pull/76794 |
0 commit comments