virtualx-engine/modules/gltf/doc_classes/GLTFState.xml
Hugo Locurcio 3a8104289d
Document that glTF classes are only usable in editor builds
Run-time glTF saving/loading is only available in Godot 4.0,
not Godot 3.x.
2022-04-22 19:08:37 +02:00

215 lines
6 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFState" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
</brief_description>
<description>
[b]Note:[/b] This class is only compiled in editor builds. Run-time glTF loading and saving is [i]not[/i] available in exported projects. References to [GLTFState] within a script will cause an error in an exported project.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_accessors">
<return type="Array" />
<description>
</description>
</method>
<method name="get_animation_player">
<return type="AnimationPlayer" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_animation_players_count">
<return type="int" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_animations">
<return type="Array" />
<description>
</description>
</method>
<method name="get_buffer_views">
<return type="Array" />
<description>
</description>
</method>
<method name="get_cameras">
<return type="Array" />
<description>
</description>
</method>
<method name="get_images">
<return type="Array" />
<description>
</description>
</method>
<method name="get_lights">
<return type="Array" />
<description>
</description>
</method>
<method name="get_materials">
<return type="Array" />
<description>
</description>
</method>
<method name="get_meshes">
<return type="Array" />
<description>
</description>
</method>
<method name="get_nodes">
<return type="Array" />
<description>
</description>
</method>
<method name="get_scene_node">
<return type="Node" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="get_skeleton_to_node">
<return type="Dictionary" />
<description>
</description>
</method>
<method name="get_skeletons">
<return type="Array" />
<description>
</description>
</method>
<method name="get_skins">
<return type="Array" />
<description>
</description>
</method>
<method name="get_textures">
<return type="Array" />
<description>
</description>
</method>
<method name="get_unique_animation_names">
<return type="Array" />
<description>
</description>
</method>
<method name="get_unique_names">
<return type="Array" />
<description>
</description>
</method>
<method name="set_accessors">
<return type="void" />
<argument index="0" name="accessors" type="Array" />
<description>
</description>
</method>
<method name="set_animations">
<return type="void" />
<argument index="0" name="animations" type="Array" />
<description>
</description>
</method>
<method name="set_buffer_views">
<return type="void" />
<argument index="0" name="buffer_views" type="Array" />
<description>
</description>
</method>
<method name="set_cameras">
<return type="void" />
<argument index="0" name="cameras" type="Array" />
<description>
</description>
</method>
<method name="set_images">
<return type="void" />
<argument index="0" name="images" type="Array" />
<description>
</description>
</method>
<method name="set_lights">
<return type="void" />
<argument index="0" name="lights" type="Array" />
<description>
</description>
</method>
<method name="set_materials">
<return type="void" />
<argument index="0" name="materials" type="Array" />
<description>
</description>
</method>
<method name="set_meshes">
<return type="void" />
<argument index="0" name="meshes" type="Array" />
<description>
</description>
</method>
<method name="set_nodes">
<return type="void" />
<argument index="0" name="nodes" type="Array" />
<description>
</description>
</method>
<method name="set_skeleton_to_node">
<return type="void" />
<argument index="0" name="skeleton_to_node" type="Dictionary" />
<description>
</description>
</method>
<method name="set_skeletons">
<return type="void" />
<argument index="0" name="skeletons" type="Array" />
<description>
</description>
</method>
<method name="set_skins">
<return type="void" />
<argument index="0" name="skins" type="Array" />
<description>
</description>
</method>
<method name="set_textures">
<return type="void" />
<argument index="0" name="textures" type="Array" />
<description>
</description>
</method>
<method name="set_unique_animation_names">
<return type="void" />
<argument index="0" name="unique_animation_names" type="Array" />
<description>
</description>
</method>
<method name="set_unique_names">
<return type="void" />
<argument index="0" name="unique_names" type="Array" />
<description>
</description>
</method>
</methods>
<members>
<member name="buffers" type="Array" setter="set_buffers" getter="get_buffers" default="[ ]">
</member>
<member name="glb_data" type="PoolByteArray" setter="set_glb_data" getter="get_glb_data" default="PoolByteArray( )">
</member>
<member name="json" type="Dictionary" setter="set_json" getter="get_json" default="{}">
</member>
<member name="major_version" type="int" setter="set_major_version" getter="get_major_version" default="0">
</member>
<member name="minor_version" type="int" setter="set_minor_version" getter="get_minor_version" default="0">
</member>
<member name="root_nodes" type="Array" setter="set_root_nodes" getter="get_root_nodes" default="[ ]">
</member>
<member name="scene_name" type="String" setter="set_scene_name" getter="get_scene_name" default="&quot;&quot;">
</member>
<member name="use_named_skin_binds" type="bool" setter="set_use_named_skin_binds" getter="get_use_named_skin_binds" default="false">
</member>
</members>
<constants>
</constants>
</class>