Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

GLTFState¶

Inherits: Resource < RefCounted < Object

There is currently no description for this class. Please help us by contributing one!

Properties¶

String	base_path	`""`
PackedByteArray[]	buffers	`[]`
bool	create_animations	`true`
PackedByteArray	glb_data	`PackedByteArray()`
Dictionary	json	`{}`
int	major_version	`0`
int	minor_version	`0`
PackedInt32Array	root_nodes	`PackedInt32Array()`
String	scene_name	`""`
bool	use_named_skin_binds	`false`

Methods¶

void	add_used_extension ( String extension_name, bool required )
GLTFAccessor[]	get_accessors ( )
Variant	get_additional_data ( StringName extension_name )
AnimationPlayer	get_animation_player ( int idx )
int	get_animation_players_count ( int idx )
GLTFAnimation[]	get_animations ( )
GLTFBufferView[]	get_buffer_views ( )
GLTFCamera[]	get_cameras ( )
int	get_handle_binary_image ( )
Texture2D[]	get_images ( )
GLTFLight[]	get_lights ( )
Material[]	get_materials ( )
GLTFMesh[]	get_meshes ( )
GLTFNode[]	get_nodes ( )
Node	get_scene_node ( int idx )
GLTFSkeleton[]	get_skeletons ( )
GLTFSkin[]	get_skins ( )
GLTFTextureSampler[]	get_texture_samplers ( )
GLTFTexture[]	get_textures ( )
String[]	get_unique_animation_names ( )
String[]	get_unique_names ( )
void	set_accessors ( GLTFAccessor[] accessors )
void	set_additional_data ( StringName extension_name, Variant additional_data )
void	set_animations ( GLTFAnimation[] animations )
void	set_buffer_views ( GLTFBufferView[] buffer_views )
void	set_cameras ( GLTFCamera[] cameras )
void	set_handle_binary_image ( int method )
void	set_images ( Texture2D[] images )
void	set_lights ( GLTFLight[] lights )
void	set_materials ( Material[] materials )
void	set_meshes ( GLTFMesh[] meshes )
void	set_nodes ( GLTFNode[] nodes )
void	set_skeletons ( GLTFSkeleton[] skeletons )
void	set_skins ( GLTFSkin[] skins )
void	set_texture_samplers ( GLTFTextureSampler[] texture_samplers )
void	set_textures ( GLTFTexture[] textures )
void	set_unique_animation_names ( String[] unique_animation_names )
void	set_unique_names ( String[] unique_names )

Constants¶

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.

Property Descriptions¶

String base_path = ""

void set_base_path ( String value )
String get_base_path ( )

There is currently no description for this property. Please help us by contributing one!

PackedByteArray[] buffers = []

void set_buffers ( PackedByteArray[] value )
PackedByteArray[] get_buffers ( )

There is currently no description for this property. Please help us by contributing one!

bool create_animations = true

void set_create_animations ( bool value )
bool get_create_animations ( )

There is currently no description for this property. Please help us by contributing one!

PackedByteArray glb_data = PackedByteArray()

void set_glb_data ( PackedByteArray value )
PackedByteArray get_glb_data ( )

There is currently no description for this property. Please help us by contributing one!

Dictionary json = {}

void set_json ( Dictionary value )
Dictionary get_json ( )

There is currently no description for this property. Please help us by contributing one!

int major_version = 0

void set_major_version ( int value )
int get_major_version ( )

There is currently no description for this property. Please help us by contributing one!

int minor_version = 0

void set_minor_version ( int value )
int get_minor_version ( )

There is currently no description for this property. Please help us by contributing one!

PackedInt32Array root_nodes = PackedInt32Array()

void set_root_nodes ( PackedInt32Array value )
PackedInt32Array get_root_nodes ( )

There is currently no description for this property. Please help us by contributing one!

String scene_name = ""

void set_scene_name ( String value )
String get_scene_name ( )

There is currently no description for this property. Please help us by contributing one!

bool use_named_skin_binds = false

void set_use_named_skin_binds ( bool value )
bool get_use_named_skin_binds ( )

There is currently no description for this property. Please help us by contributing one!

Method Descriptions¶

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.

GLTFAccessor[] get_accessors ( )