asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/modules/gltf/doc_classes/GLTFState.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

225 lines
6.7 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="GLTFState" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
Make used extensions stored in GLTFState This allows GLTFDocumentExtension classes to add to the used extensions array.
2022-09-18 05:06:23 +02:00
<method name="add_used_extension">
<return type="void" />
<param index="0" name="extension_name" type="String" />
<param index="1" name="required" type="bool" />
<description>
Appends an extension to the list of extensions used by this GLTF file during serialization. If [param required] is true, the extension will also be added to the list of required extensions. Do not run this in [method GLTFDocumentExtension._export_post], as that stage is too late to add extensions. The final list is sorted alphabetically.
</description>
</method>
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<method name="get_accessors">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFAccessor[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_animation_player">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="AnimationPlayer" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="idx" type="int" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_animation_players_count">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="idx" type="int" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_animations">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFAnimation[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_buffer_views">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFBufferView[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_cameras">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFCamera[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_images">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="Texture2D[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_lights">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFLight[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_materials">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="BaseMaterial3D[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_meshes">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFMesh[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_nodes">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFNode[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_scene_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Node" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="idx" type="int" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_skeleton_to_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Dictionary" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_skeletons">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFSkeleton[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_skins">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFSkin[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_textures">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="GLTFTexture[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
doc: Sync classref with current source
2021-03-10 10:54:21 +01:00
<method name="get_unique_animation_names">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="String[]" />
doc: Sync classref with current source
2021-03-10 10:54:21 +01:00
<description>
</description>
</method>
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<method name="get_unique_names">
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<return type="String[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_accessors">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="accessors" type="GLTFAccessor[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_animations">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="animations" type="GLTFAnimation[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_buffer_views">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="buffer_views" type="GLTFBufferView[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_cameras">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="cameras" type="GLTFCamera[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_images">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="images" type="Texture2D[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_lights">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="lights" type="GLTFLight[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_materials">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="materials" type="BaseMaterial3D[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_meshes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="meshes" type="GLTFMesh[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_nodes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="nodes" type="GLTFNode[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_skeleton_to_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="skeleton_to_node" type="Dictionary" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_skeletons">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="skeletons" type="GLTFSkeleton[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_skins">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="skins" type="GLTFSkin[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_textures">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="textures" type="GLTFTexture[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
doc: Sync classref with current source
2021-03-10 10:54:21 +01:00
<method name="set_unique_animation_names">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="unique_animation_names" type="String[]" />
doc: Sync classref with current source
2021-03-10 10:54:21 +01:00
<description>
</description>
</method>
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<method name="set_unique_names">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<param index="0" name="unique_names" type="String[]" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
</methods>
<members>
Improve gltf extension GLTFDocument api.
2022-04-09 11:35:50 +02:00
<member name="base_path" type="String" setter="set_base_path" getter="get_base_path" default="&quot;&quot;">
</member>
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<member name="buffers" type="PackedByteArray[]" setter="set_buffers" getter="get_buffers" default="[]">
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
</member>
Prevent AnimationPlayer from being added on GLTF import if the option is unchecked. Fixes #63954
2022-08-09 19:39:58 +02:00
<member name="create_animations" type="bool" setter="set_create_animations" getter="get_create_animations" default="true">
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="glb_data" type="PackedByteArray" setter="set_glb_data" getter="get_glb_data" default="PackedByteArray()">
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
</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>
Replace Array return types with TypedArray 3
2022-08-08 00:52:20 +02:00
<member name="root_nodes" type="PackedInt32Array" setter="set_root_nodes" getter="get_root_nodes" default="PackedInt32Array()">
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
</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>
</class>
Reference in a new issue Copy permalink