GLTFState

float bake_fps = 30.0

The baking fps of the animation for either import or export.

String base_path = ""

The folder path associated with this glTF data. This is used to find other files the glTF file references, like images or binary buffers. This will be set during import when appending from a file, and will be set during export when writing to a file.

PackedByteArray[] buffers = []

String copyright = ""

The copyright string in the asset header of the glTF file. This is set during import if present and export if non-empty. See the glTF asset header documentation for more information.

bool create_animations = true

String filename = ""

The file name associated with this glTF data. If it ends with .gltf, this is text-based glTF, otherwise this is binary GLB. This will be set during import when appending from a file, and will be set during export when writing to a file. If writing to a buffer, this will be an empty string.

PackedByteArray glb_data = PackedByteArray()

The binary buffer attached to a .glb file.

bool import_as_skeleton_bones = false

If true, forces all GLTFNodes in the document to be bones of a single Skeleton3D Redot node.

Dictionary json = {}

The original raw JSON document corresponding to this GLTFState.

int major_version = 0

int minor_version = 0

PackedInt32Array root_nodes = PackedInt32Array()

The root nodes of the glTF file. Typically, a glTF file will only have one scene, and therefore one root node. However, a glTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Redot scene.

String scene_name = ""

The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the glTF file.

bool use_named_skin_binds = false

void add_used_extension(String extension_name, bool required)

Appends an extension to the list of extensions used by this glTF file during serialization. If required is true, the extension will also be added to the list of required extensions. Do not run this in GLTFDocumentExtension._export_post(), as that stage is too late to add extensions. The final list is sorted alphabetically.

int append_data_to_buffers(PackedByteArray data, bool deduplication)

Appends the given byte array data to the buffers and creates a GLTFBufferView for it. The index of the destination GLTFBufferView is returned. If deduplication is true, the buffers are first searched for duplicate data, otherwise new bytes are always appended.

int append_gltf_node(GLTFNode gltf_node, Node godot_scene_node, int parent_node_index)

Appends the given GLTFNode to the state, and returns its new index. This can be used to export one Redot node as multiple glTF nodes, or inject new glTF nodes at import time. On import, this must be called before GLTFDocumentExtension._generate_scene_node() finishes for the parent node. On export, this must be called before GLTFDocumentExtension._export_node() runs for the parent node. The godot_scene_node parameter is the Redot scene node that corresponds to this glTF node. This is highly recommended to be set to a valid node, but may be null if there is no corresponding Redot scene node. One Redot scene node may be used for multiple glTF nodes, so if exporting multiple glTF nodes for one Redot scene node, use the same Redot scene node for each. The parent_node_index parameter is the index of the parent GLTFNode in the state. If -1, the node will be a root node, otherwise the new node will be added to the parent's list of children. The index will also be written to the GLTFNode.parent property of the new node.

GLTFAccessor[] get_accessors()

Variant get_additional_data(StringName extension_name)

Gets additional arbitrary data in this GLTFState instance. This can be used to keep per-file state data in GLTFDocumentExtension classes, which is important because they are stateless. The argument should be the GLTFDocumentExtension name (does not have to match the extension name in the glTF file), and the return value can be anything you set. If nothing was set, the return value is null.

AnimationPlayer get_animation_player(int idx)

Returns the AnimationPlayer node with the given index. These nodes are only used during the export process when converting Redot AnimationPlayer nodes to glTF animations.

int get_animation_players_count(int idx)

Returns the number of AnimationPlayer nodes in this GLTFState. These nodes are only used during the export process when converting Redot AnimationPlayer nodes to glTF animations.

GLTFAnimation[] get_animations()

Returns an array of all GLTFAnimations in the glTF file. When importing, these will be generated as animations in an AnimationPlayer node. When exporting, these will be generated from Redot AnimationPlayer nodes.

GLTFBufferView[] get_buffer_views()

GLTFCamera[] get_cameras()

Returns an array of all GLTFCameras in the glTF file. These are the cameras that the GLTFNode.camera index refers to.

int get_handle_binary_image()

Texture2D[] get_images()

Gets the images of the glTF file as an array of Texture2Ds. These are the images that the GLTFTexture.src_image index refers to.

GLTFLight[] get_lights()

Returns an array of all GLTFLights in the glTF file. These are the lights that the GLTFNode.light index refers to.

Material[] get_materials()

GLTFMesh[] get_meshes()

Returns an array of all GLTFMeshes in the glTF file. These are the meshes that the GLTFNode.mesh index refers to.

int get_node_index(Node scene_node)

Returns the index of the GLTFNode corresponding to this Redot scene node. This is the inverse of get_scene_node(). Useful during the export process. Note: Not every Redot scene node will have a corresponding GLTFNode, and not every GLTFNode will have a scene node generated. If there is no GLTFNode index for this scene node, -1 is returned.

GLTFNode[] get_nodes()

Returns an array of all GLTFNodes in the glTF file. These are the nodes that GLTFNode.children and root_nodes refer to. This includes nodes that may not be generated in the Redot scene, or nodes that may generate multiple Redot scene nodes.

Node get_scene_node(int idx)

Returns the Redot scene node that corresponds to the same index as the GLTFNode it was generated from. This is the inverse of get_node_index(). Useful during the import process. Note: Not every GLTFNode will have a scene node generated, and not every generated scene node will have a corresponding GLTFNode. If there is no scene node for this GLTFNode index, null is returned.

GLTFSkeleton[] get_skeletons()

Returns an array of all GLTFSkeletons in the glTF file. These are the skeletons that the GLTFNode.skeleton index refers to.

GLTFSkin[] get_skins()

Returns an array of all GLTFSkins in the glTF file. These are the skins that the GLTFNode.skin index refers to.

GLTFTextureSampler[] get_texture_samplers()

Retrieves the array of texture samplers that are used by the textures contained in the glTF.

GLTFTexture[] get_textures()

String[] get_unique_animation_names()

Returns an array of unique animation names. This is only used during the import process.

String[] get_unique_names()

Returns an array of unique node names. This is used in both the import process and export process.

void set_accessors(GLTFAccessor[] accessors)

void set_additional_data(StringName extension_name, Variant additional_data)

Sets additional arbitrary data in this GLTFState instance. This can be used to keep per-file state data in GLTFDocumentExtension classes, which is important because they are stateless. The first argument should be the GLTFDocumentExtension name (does not have to match the extension name in the glTF file), and the second argument can be anything you want.

void set_animations(GLTFAnimation[] animations)

Sets the GLTFAnimations in the state. When importing, these will be generated as animations in an AnimationPlayer node. When exporting, these will be generated from Redot AnimationPlayer nodes.

void set_buffer_views(GLTFBufferView[] buffer_views)

void set_cameras(GLTFCamera[] cameras)

Sets the GLTFCameras in the state. These are the cameras that the GLTFNode.camera index refers to.

void set_handle_binary_image(int method)

void set_images(Texture2D[] images)

Sets the images in the state stored as an array of Texture2Ds. This can be used during export. These are the images that the GLTFTexture.src_image index refers to.

void set_lights(GLTFLight[] lights)

Sets the GLTFLights in the state. These are the lights that the GLTFNode.light index refers to.

void set_materials(Material[] materials)

void set_meshes(GLTFMesh[] meshes)

Sets the GLTFMeshes in the state. These are the meshes that the GLTFNode.mesh index refers to.

void set_nodes(GLTFNode[] nodes)

Sets the GLTFNodes in the state. These are the nodes that GLTFNode.children and root_nodes refer to. Some of the nodes set here may not be generated in the Redot scene, or may generate multiple Redot scene nodes.

void set_skeletons(GLTFSkeleton[] skeletons)

Sets the GLTFSkeletons in the state. These are the skeletons that the GLTFNode.skeleton index refers to.

void set_skins(GLTFSkin[] skins)

Sets the GLTFSkins in the state. These are the skins that the GLTFNode.skin index refers to.

void set_texture_samplers(GLTFTextureSampler[] texture_samplers)

Sets the array of texture samplers that are used by the textures contained in the glTF.

void set_textures(GLTFTexture[] textures)

void set_unique_animation_names(String[] unique_animation_names)

Sets the unique animation names in the state. This is only used during the import process.

void set_unique_names(String[] unique_names)

Sets the unique node names in the state. This is used in both the import process and export process.

HANDLE_BINARY_DISCARD_TEXTURES = 0

Discards all embedded textures and uses untextured materials.

HANDLE_BINARY_EXTRACT_TEXTURES = 1

Extracts embedded textures to be reimported and compressed. Editor only. Acts as uncompressed at runtime.

HANDLE_BINARY_EMBED_AS_BASISU = 2

Embeds textures VRAM compressed with Basis Universal into the generated scene.

HANDLE_BINARY_EMBED_AS_UNCOMPRESSED = 3

Embeds textures compressed losslessly into the generated scene, matching old behavior.