godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/SkeletonIK3D.xml

56 lines
2.2 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2018-08-20 22:35:30 +00: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 13:18:53 +00:00
<class name="SkeletonIK3D" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="3D Inverse Kinematics Demo">https://godotengine.org/asset-library/asset/523</link>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</tutorials>
<methods>
<method name="get_parent_skeleton" qualifiers="const">
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
2018-08-20 22:35:30 +00:00
<description>
</description>
</method>
<method name="is_running">
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="bool" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
</description>
</method>
<method name="start">
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="one_time" type="bool" default="false" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
</description>
</method>
<method name="stop">
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" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="interpolation" type="float" setter="set_interpolation" getter="get_interpolation" default="1.0">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="magnet" type="Vector3" setter="set_magnet_position" getter="get_magnet_position" default="Vector3(0, 0, 0)">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="max_iterations" type="int" setter="set_max_iterations" getter="get_max_iterations" default="10">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="min_distance" type="float" setter="set_min_distance" getter="get_min_distance" default="0.01">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="override_tip_basis" type="bool" setter="set_override_tip_basis" getter="is_override_tip_basis" default="true">
doc: Sync classref with current source
2018-11-23 00:06:24 +00:00
</member>
Let var2str display StringName with correct sigil
2021-06-05 19:24:24 +00:00
<member name="root_bone" type="StringName" setter="set_root_bone" getter="get_root_bone" default="&amp;&quot;&quot;">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="target" type="Transform3D" setter="set_target_transform" getter="get_target_transform" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath(&quot;&quot;)">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
Let var2str display StringName with correct sigil
2021-06-05 19:24:24 +00:00
<member name="tip_bone" type="StringName" setter="set_tip_bone" getter="get_tip_bone" default="&amp;&quot;&quot;">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="use_magnet" type="bool" setter="set_use_magnet" getter="is_using_magnet" default="false">
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</member>
</members>
</class>