diff options
| author | Silc Lizard (Tokage) Renew <61938263+TokageItLab@users.noreply.github.com> | 2024-01-28 09:11:43 +0900 |
|---|---|---|
| committer | Silc Lizard (Tokage) Renew <61938263+TokageItLab@users.noreply.github.com> | 2024-04-05 01:28:26 +0900 |
| commit | 04dd299cbac614c0ff2306b8d3cd60dcd86abd8e (patch) | |
| tree | a15f30a85087519284a9d6daea8b7621b5b34496 /doc/classes/PhysicalBoneSimulator3D.xml | |
| parent | f6a78f83aa4b74aa5cb80ca2e3419448b1998e4f (diff) | |
| download | redot-engine-04dd299cbac614c0ff2306b8d3cd60dcd86abd8e.tar.gz | |
Skeleton3D: Add SkeletonModifier / Deprecate Override / Separate PB
Diffstat (limited to 'doc/classes/PhysicalBoneSimulator3D.xml')
| -rw-r--r-- | doc/classes/PhysicalBoneSimulator3D.xml | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/classes/PhysicalBoneSimulator3D.xml b/doc/classes/PhysicalBoneSimulator3D.xml new file mode 100644 index 0000000000..149993e1e2 --- /dev/null +++ b/doc/classes/PhysicalBoneSimulator3D.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicalBoneSimulator3D" inherits="SkeletonModifier3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + Node that can be the parent of [PhysicalBone3D] and can apply the simulation results to [Skeleton3D]. + </brief_description> + <description> + Node that can be the parent of [PhysicalBone3D] and can apply the simulation results to [Skeleton3D]. + </description> + <tutorials> + </tutorials> + <methods> + <method name="is_simulating_physics" qualifiers="const"> + <return type="bool" /> + <description> + Returns a boolean that indicates whether the [PhysicalBoneSimulator3D] is running and simulating. + </description> + </method> + <method name="physical_bones_add_collision_exception"> + <return type="void" /> + <param index="0" name="exception" type="RID" /> + <description> + Adds a collision exception to the physical bone. + Works just like the [RigidBody3D] node. + </description> + </method> + <method name="physical_bones_remove_collision_exception"> + <return type="void" /> + <param index="0" name="exception" type="RID" /> + <description> + Removes a collision exception to the physical bone. + Works just like the [RigidBody3D] node. + </description> + </method> + <method name="physical_bones_start_simulation"> + <return type="void" /> + <param index="0" name="bones" type="StringName[]" default="[]" /> + <description> + Tells the [PhysicalBone3D] nodes in the Skeleton to start simulating and reacting to the physics world. + Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated. + </description> + </method> + <method name="physical_bones_stop_simulation"> + <return type="void" /> + <description> + Tells the [PhysicalBone3D] nodes in the Skeleton to stop simulating. + </description> + </method> + </methods> +</class> |