godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/gltf/doc_classes/GLTFSkeleton.xml

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

59 lines
2.1 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="GLTFSkeleton" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
Link to runtime loading/saving tutorial and improve Image documentation
2023-11-13 13:37:27 +00:00
<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="BoneAttachment3D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="idx" type="int" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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.
2021-07-30 13:28:05 +00:00
<return type="Dictionary" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<description>
GLTF: Document `gltf_skeleton->godot_bone_node` is unused when importing
2023-06-01 03:10:05 +00:00
Returns a [Dictionary] that maps skeleton bone indices to the indices of GLTF nodes. This property is unused during import, and only set during export. In a GLTF file, a bone is a node, so Godot converts skeleton bones to GLTF nodes.
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="Skeleton3D" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<description>
</description>
</method>
<method name="get_unique_names">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="String[]" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00: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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="godot_bone_node" type="Dictionary" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<description>
GLTF: Document `gltf_skeleton->godot_bone_node` is unused when importing
2023-06-01 03:10:05 +00:00
Sets a [Dictionary] that maps skeleton bone indices to the indices of GLTF nodes. This property is unused during import, and only set during export. In a GLTF file, a bone is a node, so Godot converts skeleton bones to GLTF nodes.
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<param index="0" name="unique_names" type="String[]" />
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<description>
</description>
</method>
</methods>
<members>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="joints" type="PackedInt32Array" setter="set_joints" getter="get_joints" default="PackedInt32Array()">
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="roots" type="PackedInt32Array" setter="set_roots" getter="get_roots" default="PackedInt32Array()">
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
</member>
</members>
</class>