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

59 lines
1.8 KiB
XML
Raw Permalink Normal View History

Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 18:51:38 +02:00
<class name="GLTFSkeleton" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<brief_description>
</brief_description>
<description>
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:07:23 +02:00
[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 [GLTFSkeleton] within a script will cause an error in an exported project.
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_bone_attachment">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="BoneAttachment" />
<argument index="0" name="idx" type="int" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
<method name="get_bone_attachment_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
<method name="get_godot_bone_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Dictionary" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
<method name="get_godot_skeleton">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Skeleton" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
<method name="get_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
<method name="set_godot_bone_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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="godot_bone_node" type="Dictionary" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="unique_names" type="Array" />
Backport gltf2 module from master.
2021-03-03 05:20:20 +01:00
<description>
</description>
</method>
</methods>
<members>
<member name="joints" type="PoolIntArray" setter="set_joints" getter="get_joints" default="PoolIntArray( )">
</member>
<member name="roots" type="PoolIntArray" setter="set_roots" getter="get_roots" default="PoolIntArray( )">
</member>
</members>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink