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

81 lines
3.5 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="ConeTwistJoint" inherits="Joint" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Fix confusing SliderJoint3D brief description (cherry picked from commit 27f964d5380134c6384cd2cc1331f0db7b46d755)
2020-12-24 00:46:56 +00:00
A twist joint between two 3D PhysicsBodies.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint].
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
The twist axis is initiated as the X axis of the [Joint].
Fix confusing SliderJoint3D brief description (cherry picked from commit 27f964d5380134c6384cd2cc1331f0db7b46d755)
2020-12-24 00:46:56 +00:00
Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. See also [Generic6DOFJoint].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
<method name="get_param" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
</argument>
<description>
</description>
</method>
<method name="set_param">
<return type="void">
</return>
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
</argument>
<argument index="1" name="value" type="float">
</argument>
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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="bias" type="float" setter="set_param" getter="get_param" default="0.3">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
The speed with which the swing or twist will take place.
The higher, the faster.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +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="relaxation" type="float" setter="set_param" getter="get_param" default="1.0">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +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="softness" type="float" setter="set_param" getter="get_param" default="0.8">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +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="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span" default="45.0">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 09:10:53 +00:00
The swing span defines, how much rotation will not get corrected along the swing axis.
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Could be defined as looseness in the [ConeTwistJoint].
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
If below 0.05, this behavior is locked.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +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="twist_span" type="float" setter="_set_twist_span" getter="_get_twist_span" default="180.0">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_SWING_SPAN" value="0" enum="Param">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 09:10:53 +00:00
The swing span defines, how much rotation will not get corrected along the swing axis.
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Could be defined as looseness in the [ConeTwistJoint].
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
If below 0.05, this behavior is locked.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_TWIST_SPAN" value="1" enum="Param">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_BIAS" value="2" enum="Param">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
The speed with which the swing or twist will take place.
The higher, the faster.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_SOFTNESS" value="3" enum="Param">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_RELAXATION" value="4" enum="Param">
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint.
2017-10-14 10:19:03 +00:00
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_MAX" value="5" enum="Param">
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 09:10:53 +00:00
Represents the size of the [enum Param] enum.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>