Skip to content

Add behavior change note for @export_file annotation in Godot 4.4 #11075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tutorials/migrating/upgrading_to_godot_4.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,28 @@ Method ``post`` adds a new ``count`` optional parameter
Method ``standardize_locale`` adds a new ``add_defaults`` optional parameter |✔️| |✔️ with compat| |✔️ with compat| `GH-98972`_
======================================================================================================================== =================== ==================== ==================== ============

**Export annotations**

.. warning::

The behavior of ``@export_file`` changed in Godot 4.4. When assigning a new value
from the Inspector, the path is now stored and returned as a ``uid://`` reference
instead of the traditional ``res://`` path. This is a **breaking change** and may
cause issues if you're expecting ``res://``-based paths in scripts or serialized
files. This change was introduced in
`PR #105414 <https://github.com/godotengine/godot/pull/105414>`_.

For example, exported arrays of files may now contain a mix of ``uid://`` and
``res://`` paths, especially if they were partially edited in the Inspector.

In 4.4, the only way to retain the ``res://`` format is to **manually edit** the
`.tscn` or `.tres` files in a text editor. Starting in Godot 4.5, a new annotation
``@export_file_path`` can be used to explicitly retain the old behavior and export
raw ``res://`` paths.

.. [#f1] Default buffer size in 4.3 is ``1024``.


GUI nodes
~~~~~~~~~

Expand Down
Loading