PhysicalBoneSimulator3D
Controls full or partial physical-bone simulation.
PhysicalBoneSimulator3D is a skeleton modifier for physical bones. Place it under Skeleton3D with corresponding PhysicalBone3D children. Check names, GetBoneId, rest pose and joint placement.
PhysicalBonesStartSimulation without a list starts the whole branch. A name list selects bones and descendants, not entity paths. Check simulator and individual-body state during partial startup. Stopping does not implement smooth recovery, animation selection or main CharacterBody placement for you.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
PhysicalBoneSimulator3DConstructor
public PhysicalBoneSimulator3D();Methods5
IsSimulatingPhysicsbool
public bool IsSimulatingPhysics();Simulator state. For partial startup, also check individual PhysicalBone3D IsSimulatingPhysics; a global flag does not mean every bone is dynamic.
boolPhysicalBonesAddCollisionExceptionvoid
public void PhysicalBonesAddCollisionException(Rid exception);Adds a collision exception to the physical bone.
Works just like the RigidBody3D node.
| Name | Type | Default |
|---|---|---|
exception | Rid | — |
PhysicalBonesRemoveCollisionExceptionvoid
public void PhysicalBonesRemoveCollisionException(Rid exception);Removes a collision exception to the physical bone.
Works just like the RigidBody3D node.
| Name | Type | Default |
|---|---|---|
exception | Rid | — |
PhysicalBonesStartSimulationvoid
public void PhysicalBonesStartSimulation(Reckfell.Collections.Array<StringName> bones = null);Starts physical bones. An empty list selects the whole branch; names select matching bones and descendants. These are not EntityPaths. Check bindings, shapes and joints before startup.
| Name | Type | Default |
|---|---|---|
bones | Reckfell.Collections.Array<StringName> | null |
PhysicalBonesStopSimulationvoid
public void PhysicalBonesStopSimulation();Stops physical-bone simulation. Character-control recovery, animation selection/blending and main-body placement are separate tasks.