Skip to content

Document glTF base path in Runtime file loading and saving #8436

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 9, 2023
Merged

Document glTF base path in Runtime file loading and saving #8436

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions tutorials/io/runtime_file_loading_and_saving.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,20 @@ Example of loading a glTF scene and appending its root node to the scene:
# `GLTFDocument.generate_buffer()` is also available for saving to memory.
gltf_document_save.write_to_filesystem(gltf_state_save, path)

.. note::

When loading a glTF scene, a *base path* must be set so that external
resources like textures can be loaded correctly. When loading from a file,
the base path is automatically set to the folder containing the file. When
loading from a buffer, this base path must be manually set as there is no
way for Godot to infer this path.

To set the base path, set
:ref:`GLTFState.base_path <class_GLTFState_property_base_path>` on your
GLTFState instance *before* calling
:ref:`GLTFDocument.append_from_buffer <class_GLTFDocument_method_append_from_buffer>`
or :ref:`GLTFDocument.append_from_file <class_GLTFDocument_method_append_from_file>`.

.. _doc_runtime_file_loading_and_saving_fonts:

Fonts
Expand Down