godot/doc/classes/PhysicalBone.xml
Rémi Verschelde f5836b40d4
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 7adf4cc9b5)
2021-08-03 10:20:19 +02:00

77 lines
2.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicalBone" inherits="PhysicsBody" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="apply_central_impulse">
<return type="void" />
<argument index="0" name="impulse" type="Vector3" />
<description>
</description>
</method>
<method name="apply_impulse">
<return type="void" />
<argument index="0" name="position" type="Vector3" />
<argument index="1" name="impulse" type="Vector3" />
<description>
</description>
</method>
<method name="get_bone_id" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_simulate_physics">
<return type="bool" />
<description>
</description>
</method>
<method name="is_simulating_physics">
<return type="bool" />
<description>
</description>
</method>
<method name="is_static_body">
<return type="bool" />
<description>
</description>
</method>
</methods>
<members>
<member name="body_offset" type="Transform" setter="set_body_offset" getter="get_body_offset" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="0.0">
</member>
<member name="friction" type="float" setter="set_friction" getter="get_friction" default="1.0">
</member>
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0">
</member>
<member name="joint_offset" type="Transform" setter="set_joint_offset" getter="get_joint_offset" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
<member name="joint_type" type="int" setter="set_joint_type" getter="get_joint_type" enum="PhysicalBone.JointType" default="0">
</member>
<member name="mass" type="float" setter="set_mass" getter="get_mass" default="1.0">
</member>
<member name="weight" type="float" setter="set_weight" getter="get_weight" default="9.8">
</member>
</members>
<constants>
<constant name="JOINT_TYPE_NONE" value="0" enum="JointType">
</constant>
<constant name="JOINT_TYPE_PIN" value="1" enum="JointType">
</constant>
<constant name="JOINT_TYPE_CONE" value="2" enum="JointType">
</constant>
<constant name="JOINT_TYPE_HINGE" value="3" enum="JointType">
</constant>
<constant name="JOINT_TYPE_SLIDER" value="4" enum="JointType">
</constant>
<constant name="JOINT_TYPE_6DOF" value="5" enum="JointType">
</constant>
</constants>
</class>