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

103 lines
5.5 KiB
XML
Raw Normal View History

Sync classref with current source
2018-05-12 07:38:00 +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="PhysicalBone3D" inherits="PhysicsBody3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Sync classref with current source
2018-05-12 07:38:00 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref with current source
2019-12-17 10:43:07 +00:00
<method name="apply_central_impulse">
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" />
<argument index="0" name="impulse" type="Vector3" />
doc: Sync classref with current source
2019-12-17 10:43:07 +00:00
<description>
</description>
</method>
<method name="apply_impulse">
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" />
<argument index="0" name="impulse" type="Vector3" />
<argument index="1" name="position" type="Vector3" default="Vector3(0, 0, 0)" />
doc: Sync classref with current source
2019-12-17 10:43:07 +00:00
<description>
</description>
</method>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<method name="get_bone_id" 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="int" />
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<description>
</description>
</method>
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00:00
<method name="get_simulate_physics">
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" />
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00:00
<description>
</description>
</method>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<method name="is_simulating_physics">
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" />
Sync classref with current source
2018-05-12 07:38:00 +00:00
<description>
</description>
</method>
</methods>
<members>
Improved RigidDynamicBody linear/angular damping override Damping values are now non-negative. Add new properties linear_damp_mode and angular_damp_mode to set the way RigidDynamicBody and PhysicalBone (2D & 3D) use damping values. It can now be Combine (default) to add to the default/areas, or Replace to override the value completely (current behavior).
2020-04-14 17:59:53 +00:00
<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0">
Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project &gt; Project Settings &gt; Physics &gt; 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value.
See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping.
</member>
<member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="PhysicalBone3D.DampMode" default="0">
Defines how [member angular_damp] is applied. See [enum DampMode] for possible values.
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="body_offset" type="Transform3D" setter="set_body_offset" getter="get_body_offset" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
Sets the body's transform.
Sync classref with current source
2018-05-12 07:38:00 +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="bounce" type="float" setter="set_bounce" getter="get_bounce" default="0.0">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness).
</member>
<member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true">
class reference proofreading
2021-03-18 11:04:28 +00:00
If [code]true[/code], the body is deactivated when there is no movement, so it will not take part in the simulation until it is awakened by an external force.
Sync classref with current source
2018-05-12 07:38:00 +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="friction" type="float" setter="set_friction" getter="get_friction" default="1.0">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
The body's friction, from [code]0[/code] (frictionless) to [code]1[/code] (max friction).
Sync classref with current source
2018-05-12 07:38:00 +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="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
This is multiplied by the global 3D gravity setting found in [b]Project &gt; Project Settings &gt; Physics &gt; 3d[/b] to produce the body's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object.
Sync classref with current source
2018-05-12 07:38:00 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="joint_offset" type="Transform3D" setter="set_joint_offset" getter="get_joint_offset" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
Sets the joint's transform.
</member>
Fix editor suffixes and degrees conversion * Functions to convert to/from degrees are all gone. Conversion is done by the editor. * Use PROPERTY_HINT_ANGLE instead of PROPERTY_HINT_RANGE to edit radian angles in degrees. * Added possibility to add suffixes to range properties, use "min,max[,step][,suffix:<something>]" example "0,100,1,suffix:m" * In general, can add suffixes for EditorSpinSlider Not covered by this PR, will have to be addressed by future ones: * Ability to switch radians/degrees in the inspector for angle properties (if actually wanted). * Animations previously made will most likely break, need to add a way to make old ones compatible. * Only added a "px" suffix to 2D position and a "m" one to 3D position, someone needs to go through the rest of the engine and add all remaining suffixes. * Likely also need to track down usage of EditorSpinSlider outside properties to add suffixes to it too.
2021-06-29 19:42:12 +00:00
<member name="joint_rotation" type="Vector3" setter="set_joint_rotation" getter="get_joint_rotation" default="Vector3(0, 0, 0)">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
Sets the joint's rotation in radians.
</member>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 16:22:57 +00:00
<member name="joint_type" type="int" setter="set_joint_type" getter="get_joint_type" enum="PhysicalBone3D.JointType" default="0">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
Sets the joint type. See [enum JointType] for possible values.
</member>
Improved RigidDynamicBody linear/angular damping override Damping values are now non-negative. Add new properties linear_damp_mode and angular_damp_mode to set the way RigidDynamicBody and PhysicalBone (2D & 3D) use damping values. It can now be Combine (default) to add to the default/areas, or Replace to override the value completely (current behavior).
2020-04-14 17:59:53 +00:00
<member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0">
Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project &gt; Project Settings &gt; Physics &gt; 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value.
See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping.
</member>
<member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="PhysicalBone3D.DampMode" default="0">
Defines how [member linear_damp] is applied. See [enum DampMode] for possible values.
Sync classref with current source
2018-05-12 07:38:00 +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="mass" type="float" setter="set_mass" getter="get_mass" default="1.0">
Add PhysicalBone rotation, damping, axis lock & can sleep
2020-03-26 11:59:21 +00:00
The body's mass.
Sync classref with current source
2018-05-12 07:38:00 +00:00
</member>
</members>
<constants>
Improved RigidDynamicBody linear/angular damping override Damping values are now non-negative. Add new properties linear_damp_mode and angular_damp_mode to set the way RigidDynamicBody and PhysicalBone (2D & 3D) use damping values. It can now be Combine (default) to add to the default/areas, or Replace to override the value completely (current behavior).
2020-04-14 17:59:53 +00:00
<constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode">
In this mode, the body's damping value is added to any value set in areas or the default value.
</constant>
<constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode">
In this mode, the body's damping value replaces any value set in areas or the default value.
</constant>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<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>