Upgrading from Redot 4.2 to Redot 4.3

For most games and apps made with 4.2 it should be relatively safe to migrate to 4.3. This page intends to cover everything you need to pay attention to when migrating your project.

Breaking changes

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

This article indicates whether each breaking change affects GDScript and whether the C# breaking change is binary compatible or source compatible:

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

GDExtension

Since it was basically impossible to use these methods in any useful way, these methods have been removed. Use GDExtensionManager::load_extension and GDExtensionManager::unload_extension instead to correctly load and unload a GDExtension.

Animation

======================================================================================================================== =================== ==================== ==================== =========== Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced ======================================================================================================================== =================== ==================== ==================== =========== Animation Method position_track_interpolate adds a new backward optional parameter |✔️| |✔️ with compat| |✔️| GH-86629 Method rotation_track_interpolate adds a new backward optional parameter |✔️| |✔️ with compat| |✔️| GH-86629 Method scale_track_interpolate adds a new backward optional parameter |✔️| |✔️ with compat| |✔️| GH-86629 Method blend_shape_track_interpolate adds a new backward optional parameter |✔️| |✔️ with compat| |✔️| GH-86629 Method value_track_interpolate adds a new backward optional parameter |✔️| |✔️ with compat| |✔️| GH-86629 Method track_find_key adds a new limit optional parameter |✔️| |✔️ with compat| |✔️| GH-86661 Method track_find_key adds a new backward optional parameter |✔️| |✔️ with compat| |✔️| GH-92861 AnimationMixer Method _post_process_key_value changes object parameter type from Object to uint64 |✔️| |❌| |❌| GH-86687 Skeleton3D Method add_bone changes return type from void to int32 |✔️| |❌| |✔️| GH-88791 Signal bone_pose_changed replaced by skeleton_updated |❌| |❌| |❌| GH-90575 BoneAttachment3D Method on_bone_pose_update replaced by on_skeleton_update |✔️| |✔️ with compat| |✔️ with compat| GH-90575 ======================================================================================================================== =================== ==================== ==================== ===========

GUI nodes

Physics

NOTE

In C#, the enum PhysicsServer3D.G6DofJointAxisFlag breaks compatibility because of the way the bindings generator detects the enum prefix. New members were added in GH-89851 to the enum that caused the enum members to be renamed.

Rendering

===================================================================================== Change ===================================================================================== RenderingDevice Enum field FinalAction.FINAL_ACTION_CONTINUE changes value from Enum field InitialAction.INITIAL_ACTION_CLEAR changes value from Enum field InitialAction.INITIAL_ACTION_CLEAR_REGION_CONTINUE changes Enum field InitialAction.INITIAL_ACTION_CONTINUE changes value Enum field InitialAction.INITIAL_ACTION_DROP changes value from Enum field InitialAction.INITIAL_ACTION_KEEP changes value from Method buffer_clear removes post_barrier parameter Method buffer_update removes post_barrier parameter Method compute_list_begin removes allow_draw_overlap parameter Method compute_list_end removes post_barrier parameter Method draw_list_begin removes storage_textures parameter Method draw_list_end removes post_barrier parameter Method texture_clear removes post_barrier parameter Method texture_copy removes post_barrier parameter Method texture_resolve_multisample removes post_barrier parameter Method texture_update removes post_barrier parameter RenderingServer Method environment_set_fog adds a new fog_mode optional parameter RenderSceneBuffersRD Method get_color_layer adds a new msaa optional parameter Method get_depth_layer adds a new msaa optional parameter Method get_velocity_layer adds a new msaa optional parameter Method get_color_texture adds a new msaa optional parameter Method get_depth_texture adds a new msaa optional parameter Method get_velocity_texture adds a new msaa optional parameter ===================================================================================== =================================== =================== ==================== ==================== =========== GDScript Compatible C# Binary Compatible C# Source Compatible Introduced =================================== =================== ==================== ==================== =========== 2 to 0 |✔️| |❌| |❌| GH-84976 0 to 1 |✔️| |❌| |❌| GH-84976 value from 2 to 1 |✔️| |❌| |❌| GH-84976 from 5 to 0 |✔️| |❌| |❌| GH-84976 4 to 2 |✔️| |❌| |❌| GH-84976 3 to 0 |✔️| |❌| |❌| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️ with compat| GH-84976 |✔️| |✔️ with compat| |✔️| GH-84792 |✔️| |✔️ with compat| |✔️| GH-80214 |✔️| |✔️ with compat| |✔️| GH-80214 |✔️| |✔️ with compat| |✔️| GH-80214 |✔️| |✔️ with compat| |✔️| GH-80214 |✔️| |✔️ with compat| |✔️| GH-80214 |✔️| |✔️ with compat| |✔️| GH-80214 =================================== =================== ==================== ==================== ===========

NOTE

While the values of the enum fields in RenderingDevice.InitialAction and RenderingDevice.FinalAction changed, the only method that consumed them (draw_list_begin) added a compatibility method which supports the old values. So in practice it doesn't break compatibility.

NOTE

In C#, the enum RenderingDevice.DriverResource breaks compatibility because of the way the bindings generator detects the enum prefix. New members were added in GH-83452 to the enum that caused the enum members to be renamed.

Text

Audio

======================================================================================================================== =================== ==================== ==================== =========== Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced ======================================================================================================================== =================== ==================== ==================== =========== AStar2D Method get_id_path adds new allow_partial_path optional parameter |✔️| |✔️ with compat| |✔️| GH-88047 Method get_point_path adds new allow_partial_path optional parameter |✔️| |✔️ with compat| |✔️| GH-88047 AStar3D Method get_id_path adds new allow_partial_path optional parameter |✔️| |✔️ with compat| |✔️| GH-88047 Method get_point_path adds new allow_partial_path optional parameter |✔️| |✔️ with compat| |✔️| GH-88047 AStarGrid2D Method get_id_path adds new allow_partial_path optional parameter |✔️| |✔️ with compat| |✔️| GH-88047 Method get_point_path adds new allow_partial_path optional parameter |✔️| |✔️ with compat| |✔️| GH-88047 NavigationRegion2D Property avoidance_layers removed |❌| |❌| |❌| GH-90747 Property constrain_avoidance removed |❌| |❌| |❌| GH-90747 Method get_avoidance_layer_value removed |❌| |❌| |❌| GH-90747 Method set_avoidance_layer_value removed |❌| |❌| |❌| GH-90747 ======================================================================================================================== =================== ==================== ==================== ===========

NOTE

The constrain avoidance feature in NavigationRegion2D was experimental and has been discontinued with no replacement.

TileMap

XR

Editor plugins

Behavior changes

In 4.3 some behavior changes have been introduced, which might require you to adjust your project.

Core

NOTE

Binary serialization was modified to fix some issues with the serialization of scripted Objects and typed Arrays (GH-78219). This breaks compat with script encoding/decoding.

NOTE

PackedByteArray is now able to use a more compact base64 encoding for storage. But the trade-off is that it breaks compatibility, meaning that older versions of Redot may not be able to open resources saved by 4.3 (GH-89186).

To maximize compatibility, this new storage format will only be enabled for resources and scenes that contain large PackedByteArrays for now. Support for this new format will also be added in patch updates for older versions of Redot. Once all supported Redot versions are able to read the new format, we will gradually retire the compatibility measures and have all resources and scenes use the new storage format.

NOTE

In C#, the Transform3D.InterpolateWith implementation was fixed to use the right order of operations, applying the rotation before the scale (GH-89843).

NOTE

In C#, the Aabb.GetSupport implementation was fixed to properly return the support vector (GH-88919).

NOTE

In C#, the Variant types' ToString implementation now defaults to using the InvariantCulture (GH-89547) which means Vector2(1.2, 3.4) is formatted using . as the decimal separator independently of the language of the operating system that the program is running on.

Animation

NOTE

AnimationMixer replaced its Capture mode with a new Capture feature that works much better than the old one, this replaces the existing cache (GH-86715).

NOTE

AnimationNode has a reworked process for retrieving the semantic time info. This ensures that time-related behavior works as expected, but changes the blending behavior. Implementors of the _process virtual method should also note that this method is now deprecated and will be replaced by a new one in the future (GH-87171).

More information about the changes to Animation can be found in the Migrating Animations from Redot 4.0 to 4.3 article.

GUI nodes

NOTE

The default font outline color was changed from white to black (GH-54641).

NOTE

The auto_translate property is deprecated in favor of the auto_translate_mode property which is now in Node (GH-87530). The default value for auto_translate_mode is AUTO_TRANSLATE_INHERIT, which means nodes inherit the auto_translate_mode value from their parent. This means, existing nodes with the auto_translate property set to true may no longer be translated if they are children of a node with the auto_translate property set to false.

Multiplayer

NOTE

The SceneMultiplayer caching protocol was changed to send the received ID instead of the Node path when sending a node removal confirmation packet (GH-90027).

This is a breaking change for the high-level multiplayer protocol making it incompatible with previous Redot versions. Upgrade both your server and client versions to Redot 4.3 to handle this change gracefully.

Note that high-level multiplayer facilities are only ever meant to be compatible with server and client using the same Redot version. It is recommended to implement some kind of version checking.

Rendering

NOTE

Decals now convert the modulate color from an sRGB color to a linear color, like all other inputs, to ensure proper blending (GH-89849). Existing projects that were using the decal's modulate property will notice a change in their visuals.

NOTE

The reverse Z depth buffer technique is now implemented. This may break compatibility for some shaders. Read the Introducing Reverse Z (AKA I'm sorry for breaking your shader) article for more information and guidance on how to fix common scenarios.

TileMap

NOTE

TileMap layers were moved to individual nodes (GH-87379 and GH-89179).

Android

NOTE

Android permissions are no longer requested automatically because it goes against the recommended best practices (GH-87080). Use the request_permission method in OS and the on_request_permissions_result signal on MainLoop to request permissions and wait for the user response.