Root Motion PuppetMaster

http://root-motion.com/puppetmasterdox/html/
Admin
Root Motion PuppetMaster is a physics-based character animation system that enables animated...
Tokens:164,153
Snippets:1,403
Trust Score:5.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### BipedReferences Setup Verification

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_aa2172a99066ae42fa4183477ccc1af43.html

Verifies the setup of BipedReferences for potential problems.

```APIDOC
## static bool SetupError

### Description
Checks the setup for definite problems.

### Method
static

### Endpoint
N/A (This is a static method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (bool)
- **true** (bool) - Indicates a setup error was found.
- **false** (bool) - Indicates no setup errors were found.

#### Response Example
```json
{
  "example": "true"
}
```

### Error Handling
- **errorMessage** (ref string) - If an error is found, this output parameter will contain a detailed error message.
```

--------------------------------

### BipedReferences SetupWarning

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_a4c793b5bfc0ffc72dbba18ae0c523073.html

Provides information on checking the setup of BipedReferences for potential problems.

```APIDOC
## static bool SetupWarning BipedReferences

### Description
Checks the setup for possible problems.

### Method
static bool

### Endpoint
N/A (This is a static method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **bool** (bool) - True if there are setup warnings, false otherwise.

#### Response Example
```json
{
  "warningMessage": "Example warning message if setup is not optimal."
}
```

### Error Handling
None specified.
```

--------------------------------

### PuppetMaster SetUp API

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_abc0b6fa9fef989865a33c4b177558dd0.html

This section details the static SetUp method of the PuppetMaster class, used to initialize a Puppet with a ragdoll character.

```APIDOC
## static PuppetMaster SetUp

### Description
Sets up a Puppet using a single ragdoll character. This will duplicate the ragdoll character, remove the ragdoll components from the original and use it as the animated target.

### Method
static

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (This is a static method that modifies internal state)

#### Response Example
N/A
```

--------------------------------

### PuppetMaster Setup API

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_ab5e97759485c0fd7f79eb01c3d596ddd.html

API documentation for setting up the PuppetMaster.

```APIDOC
## static PuppetMaster SetUp

### Description
Sets up a Puppet from the specified ragdoll and target characters.

### Method
static

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None (This is a static setup method)

#### Response Example
None
```

--------------------------------

### PuppetMaster Static Setup Methods

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master.html

Static methods for initializing and configuring PuppetMaster instances.

```APIDOC
## static PuppetMaster SetUp (Transform target, Transform ragdoll, int characterControllerLayer, int ragdollLayer)

### Description
Sets up a Puppet from the specified ragdoll and target characters.

### Method
static PuppetMaster

### Endpoint
N/A (Static Method)

### Parameters
- **target** (Transform) - Required - The target character transform.
- **ragdoll** (Transform) - Required - The ragdoll character transform.
- **characterControllerLayer** (int) - Required - The layer for the character controller.
- **ragdollLayer** (int) - Required - The layer for the ragdoll.

### Request Example
None

### Response
- **PuppetMaster** (PuppetMaster) - The initialized PuppetMaster instance.
```

```APIDOC
## static PuppetMaster SetUp (Transform target, int characterControllerLayer, int ragdollLayer)

### Description
Sets up a Puppet using a single ragdoll character. This will duplicate the ragdoll character, remove the ragdoll components from the original and use it as the animated target.

### Method
static PuppetMaster

### Endpoint
N/A (Static Method)

### Parameters
- **target** (Transform) - Required - The target character transform.
- **characterControllerLayer** (int) - Required - The layer for the character controller.
- **ragdollLayer** (int) - Required - The layer for the ragdoll.

### Request Example
None

### Response
- **PuppetMaster** (PuppetMaster) - The initialized PuppetMaster instance.
```

--------------------------------

### Realtime Mode Baking Example

Source: http://root-motion.com/puppetmasterdox/html/page12.html

Use Realtime mode for baking arbitrary animation ranges like ragdoll simulations or interactions. Ensure the Baker component is assigned and start the baking process with a defined duration.

```csharp
using RootMotion;
public class MyBakingTool {
public Baker baker;
public float bakeDuration = 5f;
void Start()
{
baker.mode = Baker.Mode.Realtime;
StartCoroutine(BakeDuration(bakeDuration));
}
private IEnumerator BakeDuration(float duration) 
{
baker.StartBaking();
yield return new WaitForSeconds(duration);
baker.StopBaking();
}
}
```

--------------------------------

### Hierarchy and Setup

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master.html

Methods for checking hierarchy, setting up the ragdoll as a puppet, and checking for joint existence.

```APIDOC
## HierarchyIsFlat

### Description
Checks if all the muscles are parented to the PuppetMaster Transform.

### Method
bool

### Endpoint
N/A (Method within a class)

## SetUpTo

### Description
Sets up the ragdoll as a Puppet. Assigns the specified layers to the animated target and the ragdoll. If setUpTo is the same Transform as the PuppetMaster's, the character will be duplicated and the duplicate will be used as the animated target.

### Method
void

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
- **setUpTo** (Transform) - Required - The transform to set up the puppet to.
- **characterControllerLayer** (int) - Required - The layer for the character controller.
- **ragdollLayer** (int) - Required - The layer for the ragdoll.

## ContainsJoint

### Description
Checks if the PuppetMaster has a muscle for the specified joint.

### Method
bool

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
- **joint** (ConfigurableJoint) - Required - The joint to check for.
```

--------------------------------

### Initialize Props Object

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_muscle_a1b0d380c5b01eeab074f48319cd9ed9c.html

Initializes the main properties of a muscle. This is a common setup for muscle-related configurations.

```csharp
Props props = new Props()
```

--------------------------------

### RootMotion Class Overview

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_aa10d2e2fc7366a18ade823db24860ce3.html

Provides an overview of the RootMotion class and its key properties related to humanoid character setup.

```APIDOC
## RootMotion Class

### Description
Represents the root motion component for character animation, managing humanoid references and setup.

### Properties
- **pelvis** (Transform) - The pelvis (hip) bone.
- **AssignHumanoidReferences** (Method) - Assigns humanoid references.
- **AutoDetectReferences** (Method) - Automatically detects humanoid references.
- **Contains** (Method) - Checks if a reference is contained.
- **DetectReferencesByNaming** (Method) - Detects references by naming convention.
- **eyes** (Transform) - The eyes bone.
- **head** (Transform) - The head bone.
- **isEmpty** (Method) - Checks if the references are empty.
- **IsEmpty** (Method) - Checks if the references are empty.
- **isFilled** (Method) - Checks if the references are filled.
- **leftCalf** (Transform) - The left calf bone.
- **leftFoot** (Transform) - The left foot bone.
- **leftForearm** (Transform) - The left forearm bone.
- **leftHand** (Transform) - The left hand bone.
- **leftThigh** (Transform) - The left thigh bone.
- **leftUpperArm** (Transform) - The left upper arm bone.
- **pelvis** (Transform) - The pelvis (hip) bone.
- **rightCalf** (Transform) - The right calf bone.
- **rightFoot** (Transform) - The right foot bone.
- **rightForearm** (Transform) - The right forearm bone.
- **rightHand** (Transform) - The right hand bone.
- **rightThigh** (Transform) - The right thigh bone.
- **rightUpperArm** (Transform) - The right upper arm bone.
- **root** (Transform) - The root bone.
- **SetupError** (Enum) - Represents a setup error.
- **SetupWarning** (Enum) - Represents a setup warning.
- **spine** (Transform) - The spine bone.
```

--------------------------------

### RootMotion Class Properties

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_a85d6147b0dfd6e704be80d49e40d9ab6.html

This section details the properties available within the RootMotion class, such as references to body parts and setup information.

```APIDOC
## RootMotion Class Properties

### Description
Properties related to humanoid references and setup within the RootMotion system.

### Properties
- **AssignHumanoidReferences** (Method) - Assigns humanoid references.
- **AutoDetectReferences** (Method) - Automatically detects references.
- **Contains** (Method) - Checks if a reference is contained.
- **DetectReferencesByNaming** (Method) - Detects references by naming convention.
- **eyes** (Transform[]) - The eyes.
- **head** (Transform) - The head.
- **isEmpty** (Method) - Checks if the references are empty.
- **IsEmpty** (Method) - Checks if the references are empty.
- **isFilled** (Method) - Checks if the references are filled.
- **leftCalf** (Transform) - The left calf.
- **leftFoot** (Transform) - The left foot.
- **leftForearm** (Transform) - The left forearm.
- **leftHand** (Transform) - The left hand.
- **leftThigh** (Transform) - The left thigh.
- **leftUpperArm** (Transform) - The left upper arm.
- **pelvis** (Transform) - The pelvis.
- **rightCalf** (Transform) - The right calf.
- **rightFoot** (Transform) - The right foot.
- **rightForearm** (Transform) - The right forearm.
- **rightHand** (Transform) - The right hand.
- **rightThigh** (Transform) - The right thigh.
- **rightUpperArm** (Transform) - The right upper arm.
- **root** (Transform) - The root transform.
- **SetupError** (string) - Information about setup errors.
- **SetupWarning** (string) - Information about setup warnings.
- **spine** (Transform) - The spine.
```

--------------------------------

### SetUpTo Method

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_aa57e9f85683219b230f102c7fe195a6e.html

Configures the ragdoll as a Puppet by assigning specified layers to the animated target and the ragdoll. If the setUpTo transform is the same as the PuppetMaster's, a duplicate of the character will be used as the animated target.

```APIDOC
## void SetUpTo

### Description
Sets the ragdoll up as a Puppet. Assigns the specified layers to the animated target and the ragdoll. If setUpTo is the same Transform as the PuppetMaster's, the character will be duplicated and the duplicate will be used as the animated target.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
None

### Parameters
- **_setUpTo** (Transform) - Description of the transform to set up to.
- **_characterControllerLayer** (int) - The layer for the character controller.
- **_ragdollLayer** (int) - The layer for the ragdoll.
```

--------------------------------

### Reconnect Muscle Recursive

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master.html

Reconnects all muscles starting from the specified index.

```APIDOC
## ReconnectMuscleRecursive

### Description
Reconnects all muscles starting from the specified index.

### Method
void

### Endpoint
N/A (This is a method call)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (void method)

#### Response Example
N/A
```

--------------------------------

### UpdateMode API

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_aeaebc65279a1ae2cb5f20295dbc07a4b.html

Details on how to get and set the update mode for the PuppetMaster.

```APIDOC
## GET /api/puppetmaster/updatemode

### Description
Gets the current update mode of the PuppetMaster.

### Method
GET

### Endpoint
/api/puppetmaster/updatemode

### Parameters
None

### Response
#### Success Response (200)
- **mode** (string) - The current update mode of the PuppetMaster.

#### Response Example
{
  "mode": "active"
}

## SET /api/puppetmaster/updatemode

### Description
Sets the update mode for the PuppetMaster.

### Method
POST

### Endpoint
/api/puppetmaster/updatemode

### Parameters
#### Request Body
- **mode** (string) - Required - The desired update mode (e.g., "active", "disabled", "kinematic").

### Request Example
{
  "mode": "kinematic"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the update mode has been changed.

#### Response Example
{
  "message": "Update mode set to kinematic."
}
```

--------------------------------

### BipedReferences Class Functions

Source: http://root-motion.com/puppetmasterdox/html/functions_func.html

Functions related to BipedReferences for character setup and validation.

```APIDOC
## BipedReferences Class Functions

### Description
Functions for managing and validating bipedal character references.

### Functions
- AssignHumanoidReferences()
- Contains()
- DetectReferencesByNaming()
- IsEmpty()
- SetupError()
- SetupWarning()
```

--------------------------------

### RootMotion.Dynamics.Weight Constructor

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_weight_a808b688c2db5a4b18d4f5c07aba6c90b.html

Initializes a new instance of the RootMotion.Dynamics.Weight class.

```APIDOC
## RootMotion.Dynamics.Weight Constructor

### Description
Initializes a new instance of the RootMotion.Dynamics.Weight class.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### RootMotion Class Overview

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_ad50ac28558ad86b9bfed821ddb25d31b.html

Provides an overview of the RootMotion class, its properties, and methods.

```APIDOC
## RootMotion Class

### Description
Represents the root motion component for character animation, handling references and setup.

### Properties
- **AssignHumanoidReferences**: Assigns humanoid references.
- **AutoDetectReferences**: Automatically detects references.
- **Contains**: Checks if a reference is contained.
- **DetectReferencesByNaming**: Detects references by naming convention.
- **eyes**: Reference to the eyes.
- **head**: Reference to the head.
- **leftCalf**: Reference to the left calf.
- **leftFoot**: Reference to the left foot.
- **leftForearm**: Reference to the left forearm.
- **leftHand**: Reference to the left hand.
- **leftThigh**: Reference to the left thigh.
- **leftUpperArm**: Reference to the left upper arm.
- **pelvis**: Reference to the pelvis.
- **rightCalf**: Reference to the right calf.
- **rightFoot**: Reference to the right foot.
- **rightForearm**: Reference to the right forearm.
- **rightHand**: Reference to the right hand.
- **rightThigh**: Reference to the right thigh.
- **rightUpperArm**: Reference to the right upper arm.
- **root**: Reference to the root bone.
- **spine**: Reference to the spine bones.

### Methods
- **isEmpty**: Checks if the root motion is empty.
- **IsEmpty**: Checks if the root motion is empty.
- **isFilled**: Checks if the root motion is filled.
- **SetupError**: Handles setup errors.
- **SetupWarning**: Handles setup warnings.

### Virtual Methods
- **virtual bool isFilled**: Checks if the root motion is filled.
  - **get**: Retrieves the filled status.
```

--------------------------------

### PuppetEvent onGetUpSupine

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_behaviour_puppet_aa486f082626a5d8d9d9256e633c3d1ce.html

Event triggered when the character begins getting up from a supine pose.

```APIDOC
## PuppetEvent onGetUpSupine

### Description
Called when the character starts getting up from a supine pose (facing up) or from the left side when 'Is Quadruped' is enabled.

### Event
- **onGetUpSupine** (PuppetEvent)
```

--------------------------------

### Update Delegate: OnPostInitiate

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_a1b2577118b6195c595fc850338bb9f72.html

Callback function executed after the puppet has been initiated.

```APIDOC
## Update Delegate: OnPostInitiate

### Description
Called after the puppet has initiated.

### Method
Update Delegate

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

### Error Handling
None
```

--------------------------------

### groundLayers Property

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_behaviour_puppet_a596ef77248a9ff7ef0395d46d6d353c8.html

Details about the groundLayers property, specifying which layers the target will be grounded to when getting up.

```APIDOC
## groundLayers

### Description
Will ground the target to those layers when getting up.

### Type
LayerMask

```

--------------------------------

### Create Ragdoll at Runtime

Source: http://root-motion.com/puppetmasterdox/html/page1.html

Instantiates a character prefab, automatically detects humanoid bones, configures ragdoll options, and creates the ragdoll. Use this to set up ragdoll physics programmatically.

```csharp
using UnityEngine;

public class RagdollCreatorExample : MonoBehaviour {

    [Tooltip("The character prefab/FBX.")]
    public GameObject prefab;

    void Start() {
        // Instantiate the character
        GameObject instance = GameObject.Instantiate(prefab);
        // Find bones (Humanoids)
        BipedRagdollReferences r = BipedRagdollReferences.FromAvatar(instance.GetComponent<Animator>());
        // How would you like your ragdoll?
        BipedRagdollCreator.Options options = BipedRagdollCreator.AutodetectOptions(r);
        // Edit options here if you need to
        //options.headCollider = RagdollCreator.ColliderType.Box;
        //options.weight *= 2f;
        //options.joints = RagdollCreator.JointType.Character;
        // Create the ragdoll
        BipedRagdollCreator.Create(r, options);
        Debug.Log("A ragdoll was successfully created.");
    }

    void Update() {
        // If bone proportions have changed, just clear and recreate:
        //BipedRagdollCreator.ClearBipedRagdoll(r); //ClearAll if you have changed references
        //BipedRagdollCreator.Create(r, options);
    }
}
```

--------------------------------

### RootMotion Class Methods

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_a41b04853a9e6cf8e77234d6ef2f10b6d.html

Documentation for methods and properties within the RootMotion class.

```APIDOC
## GET /api/rootmotion/properties

### Description
Retrieves a list of all properties available for the RootMotion class.

### Method
GET

### Endpoint
/api/rootmotion/properties

### Parameters
None

### Response
#### Success Response (200)
- **properties** (array) - A list of strings, where each string is a property name.

### Response Example
{
  "properties": [
    "AddMuscle",
    "AddPropMuscle",
    "angularLimits",
    "angularPinning",
    "behaviours",
    "blendTime",
    "ContainsJoint",
    "controlsAnimator",
    "DisableImmediately",
    "DisableMuscleRecursive",
    "DisconnectMuscleRecursive",
    "EnableMuscleRecursive",
    "FixMusclePositions",
    "FixMusclePositionsAndRotations",
    "FixTargetToSampledState",
    "fixTargetTransforms",
    "FlagInternalCollisionsForUpdate",
    "FlattenHierarchy",
    "Freeze",
    "GetMuscle",
    "GetMuscleIndex",
    "HierarchyIsFlat",
    "humanoidConfig",
    "initiated",
    "internalCollisions",
    "isActive",
    "isAlive",
    "isBlending",
    "IsDisconnecting",
    "isFrozen",
    "isKilling",
    "IsReconnecting",
    "isSwitchingMode",
    "isSwitchingState",
    "IsValid",
    "Kill",
    "manualAngularLimitControl",
    "manualInternalCollisionControl",
    "mapDisconnectedMuscles",
    "mappingWeight",
    "mode",
    "Mode",
    "muscleDamper",
    "muscles",
    "muscleSpring",
    "muscleWeight",
    "OnFixTransforms",
    "OnHierarchyChanged",
    "OnMuscleDisconnected",
    "OnMuscleReconnected",
    "OnMuscleRemoved",
    "OnPostInitiate",
    "OnPostLateUpdate",
    "OnPostSimulate",
    "OnPreSimulate",
    "OnRead",
    "OnWrite",
    "pinDistanceFalloff",
    "pinPow",
    "pinWeight",
    "propMuscles",
    "Rebuild",
    "ReconnectMuscleRecursive",
    "RemoveMuscleRecursive",
    "RemoveRagdollComponents",
    "ReplaceMuscle",
    "Resurrect",
    "SampleTargetMappedState",
    "SetAngularLimitsManual",
    "SetInternalCollisionsManual",
    "SetMuscles",
    "SetMuscleWeights",
    "SetMuscleWeightsRecursive",
    "SetUp",
    "SetUpTo",
    "solverIterationCount",
    "solvers",
    "state",
    "stateSettings",
    "StoreTargetMappedState",
    "storeTargetMappedState",
    "supportTranslationAnimation",
    "SwitchToActiveMode",
    "SwitchToDisabledMode",
    "SwitchToKinematicMode",
    "targetAnimation",
    "targetAnimator",
    "targetRoot",
    "Teleport",
    "TreeHierarchy",
    "updateJointAnchors",
    "UpdateMode",
    "updateMode",
    "visualizeTargetPose"
  ]
}
```

--------------------------------

### RootMotion Class Methods

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_ac0a171600231aa09b0c952c9e3025c62.html

Documentation for methods available within the RootMotion class.

```APIDOC
## void FlattenHierarchy ()

### Description
Flattens the ragdoll hierarchy so that all muscles are parented to the PuppetMaster.

### Method
void

### Endpoint
N/A (Class Method)

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### BipedLimbOrientations UMA

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_limb_orientations_a7885e0ae0fc51d4bcbd7cb0a69794054.html

Provides information on how to get the local bend directions of the standard UMA skeleton using BipedLimbOrientations.

```APIDOC
## BipedLimbOrientations UMA

### Description
Gets the local bend directions of the standard UMA skeleton.

### Method
static get

### Endpoint
N/A (This appears to be a static method within a class, not a REST endpoint)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **bendDirections** (object) - The local bend directions of the UMA skeleton.

#### Response Example
```json
{
  "bendDirections": {
    "leftArm": { "x": 0.1, "y": 0.2, "z": 0.3 },
    "rightArm": { "x": -0.1, "y": 0.2, "z": -0.3 },
    "leftLeg": { "x": 0.1, "y": -0.2, "z": 0.3 },
    "rightLeg": { "x": -0.1, "y": -0.2, "z": -0.3 }
  }
}
```
```

--------------------------------

### RootMotion Class Methods

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_acd7acef45fdcc1c5877e83ba9af27b1f.html

Documentation for methods within the RootMotion class.

```APIDOC
## void SetMuscleWeightsRecursive

### Description
Sets the muscle weights for the specified human body bone and all its child muscles. This function is applicable only when working with a Humanoid avatar. For instance, calling it on the upper arm will also set weights for the forearm and hand of the same limb.

### Method
void

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (void return type)

#### Response Example
N/A
```

--------------------------------

### RootMotion.Dynamics.Muscle.Props Constructor

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_muscle_1_1_props_a61fd41f02e99da59f27f1788a7e4925b.html

Initializes a new instance of the RootMotion.Dynamics.Muscle.Props class.

```APIDOC
## RootMotion.Dynamics.Muscle.Props Constructor

### Description
Initializes a new instance of the RootMotion.Dynamics.Muscle.Props class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A

### Error Handling
N/A
```

--------------------------------

### Class Members - Group 'g'

Source: http://root-motion.com/puppetmasterdox/html/functions_0x67.html

Lists functions and variables starting with 'g' from various classes within the PuppetMasterDox project.

```APIDOC
## Class Members - Group 'g'

### Description
This section lists functions and variables that start with the letter 'g', along with their respective classes.

### Functions
- **GetAncestor()** : Hierarchy
- **GetAxisToDirection()** : AxisTools
- **GetAxisToPoint()** : AxisTools
- **GetAxisVectorToDirection()** : AxisTools
- **GetAxisVectorToPoint()** : AxisTools
- **GetFirstCommonAncestor()** : Hierarchy
- **GetFirstCommonAncestorRecursive()** : Hierarchy
- **GetMuscle()** : PuppetMaster
- **GetMuscleIndex()** : PuppetMaster
- **GetRigidbody()** : PuppetMasterProp
- **GetValue()** : Weight

### Variables
- **getUpCollisionResistanceMlp** : BehaviourPuppet
- **getUpDelay** : BehaviourPuppet
- **getUpKnockOutDistanceMlp** : BehaviourPuppet
- **getUpOffsetProne** : BehaviourPuppet
- **getUpOffsetSupine** : BehaviourPuppet
- **getUpRegainPinSpeedMlp** : BehaviourPuppet
- **groundLayers** : BehaviourPuppet
- **group** : Muscle.Props
- **Group** : Muscle
- **groupOverrides** : BehaviourPuppet
- **groups** : BehaviourPuppet.MusclePropsGroup , Booster
```

--------------------------------

### RootMotion Class Overview

Source: http://root-motion.com/puppetmasterdox/html/struct_root_motion_1_1_dynamics_1_1_biped_ragdoll_references.html

Provides an overview of the RootMotion class, its purpose, and its key components.

```APIDOC
## Class RootMotion

### Description
Holds references to all Transforms required for a biped ragdoll.

### Public Member Functions

#### bool Contains (Transform t, bool ignoreRoot=false)

* **Description**: Returns true if the References contain the specified Transform.
* **Parameters**:
  * **t** (Transform) - The transform to check for.
  * **ignoreRoot** (bool) - Optional. Whether to ignore the root transform in the check. Defaults to false.

### Public Attributes

#### Transform root

* **Description**: The root transform is the parent of all the biped's bones and should be located at ground level.

#### Transform hips

* **Description**: The pelvis bone.

#### Transform spine

* **Description**: The middle spine bone.

#### Transform chest

* **Description**: The last spine bone.

#### Transform head

* **Description**: The head.

#### Transform leftUpperLeg

* **Description**: The first bone of the left leg.

#### Transform leftLowerLeg

* **Description**: The second bone of the left leg.

#### Transform leftFoot

* **Description**: The third bone of the left leg.

#### Transform rightUpperLeg

* **Description**: The first bone of the right leg.

#### Transform rightLowerLeg

* **Description**: The second bone of the right leg.

#### Transform rightFoot

* **Description**: The third bone of the right leg.

#### Transform leftUpperArm

* **Description**: The first bone of the left arm.

#### Transform leftLowerArm

* **Description**: The second bone of the left arm.

#### Transform leftHand

* **Description**: The third bone of the left arm.

#### Transform rightUpperArm

* **Description**: The first bone of the right arm.

#### Transform rightLowerArm

* **Description**: The second bone of the right arm.

#### Transform rightHand

* **Description**: The third bone of the right arm.
```

--------------------------------

### Class Members - C

Source: http://root-motion.com/puppetmasterdox/html/functions_0x63.html

Lists class members starting with the letter 'c' from various classes within the PuppetMaster system.

```APIDOC
## Class Members - C

### Description
This section lists class members that start with the letter 'c'. Each member is associated with the class(es) it belongs to.

### Members
- **canEnd** (BehaviourFall)
- **canGetUp** (BehaviourPuppet)
- **canMoveTarget** (BehaviourPuppet)
- **chest** (BipedRagdollReferences)
- **childFlags** (Muscle)
- **childIndexes** (Muscle)
- **clipSettings** (Baker)
- **colliders** (Muscle)
- **collision** (MuscleCollision)
- **collisionLayers** (BehaviourPuppet)
- **collisionResistance** (BehaviourPuppet.MuscleProps, BehaviourPuppet)
- **collisionResistanceMultipliers** (BehaviourPuppet)
- **collisionThreshold** (BehaviourPuppet.CollisionResistanceMultiplier, BehaviourPuppet)
- **connectedBodyTarget** (Muscle)
- **connectTo** (PropRoot)
- **Contains()** (BipedRagdollReferences, BipedReferences)
- **ContainsChild()** (Hierarchy)
- **ContainsDuplicate()** (Hierarchy)
- **ContainsJoint()** (PuppetMaster)
- **controlsAnimator** (PuppetMaster)
- **ConvertSelected()** (ConvertToConfigurableJoints)
- **copOffset** (SubBehaviourBalancer.Settings)
- **crossfadeTime** (BehaviourBase.AnimatorEvent)
- **currentProp** (PropMuscle, PropRoot)
- **curve** (Weight)
```

--------------------------------

### RootMotion.Dynamics.Weight Class Overview

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_weight.html

This snippet provides a structured overview of the RootMotion.Dynamics.Weight class, including its constructors, public member functions, and public attributes.

```APIDOC
## Class: RootMotion.Dynamics.Weight

### Description
A floating point value that can be used as a simple float or a weight curve evaluated by another floating point parameter.

### Public Types

#### Enum: Mode
- **Simple float value or a curve evaluated by another floating point parameter.**

### Public Member Functions

#### Constructor: Weight (float floatValue)
- Initializes a new instance of the RootMotion.Dynamics.Weight class.

#### Constructor: Weight (float floatValue, string tooltip)
- Initializes a new instance of the RootMotion.Dynamics.Weight class.

#### Function: GetValue (float param)
- **Returns:** float
- **Description:** Gets the value. If in 'Float' mode, will return floatValue, if 'Curve' mode, will return the curve's value evaluated at 'param'.

### Public Attributes

#### Attribute: mode (Mode)
- **Description:** Simple float value or a curve evaluated by another floating point parameter.

#### Attribute: floatValue (float)
- **Description:** The float value.

#### Attribute: curve (AnimationCurve)
- **Description:** The AnimationCurve.
```

--------------------------------

### BipedLimbOrientations - Get Local Bend Directions

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_limb_orientations_aa20bd8796a5b9f55b5cf6117f517b05e.html

Retrieves the local bend directions for the standard 3ds Max Biped skeleton.

```APIDOC
## GET /api/biped/limb-orientations

### Description
Gets the local bend directions of the standard 3ds Max Biped skeleton.

### Method
GET

### Endpoint
/api/biped/limb-orientations

### Parameters
#### Query Parameters
- **MaxBiped** (object) - Required - Represents the MaxBiped object.
- **UMA** (object) - Required - Represents the UMA object.

### Response
#### Success Response (200)
- **BipedLimbOrientations** (object) - An object containing the local bend directions.

#### Response Example
```json
{
  "BipedLimbOrientations": {
    "MaxBiped": {
      "some_property": "value"
    },
    "UMA": {
      "another_property": "value"
    }
  }
}
```
```

--------------------------------

### RootMotion Methods

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_behaviour_puppet_a9ba901c643a3654fcb14481c7bbd1ec7.html

This section lists and describes the methods available for the RootMotion class.

```APIDOC
## RootMotion Methods

### Description
Methods for controlling and managing the RootMotion system.

### Methods
- **Reset()** - Resets the RootMotion system to its default state.
- **SetColliders(Collider[] colliders)** - Sets the colliders for the RootMotion system.
```

--------------------------------

### RootMotion Class Properties

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_a82a2d79feeb92d960470ed662b69e3b5.html

Details the properties available within the RootMotion class, including references to body parts and setup information.

```APIDOC
## RootMotion Class Properties

### Description
This section lists the properties associated with the RootMotion class, which are used to define and manage character references and their hierarchical structure.

### Properties
- **AssignHumanoidReferences**: (Method) Assigns humanoid references to the RootMotion system.
- **AutoDetectReferences**: (Method) Automatically detects and assigns references.
- **Contains**: (Method) Checks if a specific reference is contained within the system.
- **DetectReferencesByNaming**: (Method) Detects references based on naming conventions.
- **eyes**: (Property) Reference to the eyes bone.
- **head**: (Property) Reference to the head bone.
- **isEmpty**: (Property) Returns true if the RootMotion system is empty.
- **IsEmpty**: (Property) Returns true if the RootMotion system is empty.
- **isFilled**: (Property) Returns true if the RootMotion system is filled with references.
- **leftCalf**: (Property) Reference to the left calf bone.
- **leftFoot**: (Property) Reference to the left foot bone.
- **leftForearm**: (Property) Reference to the left forearm bone.
- **leftHand**: (Property) Reference to the left hand bone.
- **leftThigh**: (Property) Reference to the left thigh bone.
- **leftUpperArm**: (Property) Reference to the left upper arm bone.
- **pelvis**: (Property) Reference to the pelvis bone.
- **rightCalf**: (Property) Reference to the right calf bone.
- **rightFoot**: (Property) Reference to the right foot bone.
- **rightForearm**: (Property) Reference to the right forearm bone.
- **rightHand**: (Property) Reference to the right hand bone.
- **rightThigh**: (Property) Reference to the right thigh bone.
- **rightUpperArm**: (Property) Reference to the right upper arm bone.
- **root**: (Property) Reference to the root bone.
- **SetupError**: (Property) Information about any setup errors.
- **SetupWarning**: (Property) Information about any setup warnings.
- **spine**: (Property) Reference to the spine bones.

### Example Usage
```csharp
// Accessing the spine property
Transform[] spineBones = rootMotion.spine;

// Checking if the system is empty
bool isEmpty = rootMotion.isEmpty;
```

### Associated Class
- **RootMotion**
```

--------------------------------

### RootMotion Class Methods

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_hierarchy_a0cf4b414f7b8e9b38736c84c354c6fe4.html

Provides documentation for static methods within the RootMotion class, focusing on hierarchy and ancestor relationships.

```APIDOC
## RootMotion GetFirstCommonAncestor

### Description
Gets the first common ancestor of the specified transforms.

### Method
static

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Transform** (Transform) - The first common ancestor transform.

#### Response Example
N/A
```

--------------------------------

### RootMotion Class Documentation

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_puppet_master_af50c3a1a9f5e2a61ecf96bef323a3881.html

Details on the RootMotion class and its associated properties and methods.

```APIDOC
## RootMotion Class

### Description
Provides functionality for managing root motion in character animations, including dynamics, muscle control, and state management.

### Properties
- **AddMuscle** (Method) - Adds a muscle to the system.
- **AddPropMuscle** (Method) - Adds a prop muscle.
- **angularLimits** (Property) - Controls angular limits for joints.
- **angularPinning** (Property) - Enables or disables angular pinning.
- **behaviours** (Property) - Manages character behaviours.
- **blendTime** (Property) - Sets the blending time for transitions.
- **ContainsJoint** (Method) - Checks if a joint is contained within the system.
- **controlsAnimator** (Property) - Controls the animator component.
- **DisableImmediately** (Method) - Disables the system immediately.
- **DisableMuscleRecursive** (Method) - Disables a muscle and its children recursively.
- **DisconnectMuscleRecursive** (Method) - Disconnects a muscle and its children recursively.
- **EnableMuscleRecursive** (Method) - Enables a muscle and its children recursively.
- **FixMusclePositions** (Method) - Fixes the positions of muscles.
- **FixMusclePositionsAndRotations** (Method) - Fixes the positions and rotations of muscles.
- **FixTargetToSampledState** (Method) - Fixes the target to a sampled state.
- **fixTargetTransforms** (Method) - Fixes target transforms.
- **FlagInternalCollisionsForUpdate** (Method) - Flags internal collisions for update.
- **FlattenHierarchy** (Method) - Flattens the hierarchy.
- **Freeze** (Method) - Freezes the system.
- **GetMuscle** (Method) - Retrieves a muscle by its index or name.
- **GetMuscleIndex** (Method) - Retrieves the index of a muscle.
- **HierarchyIsFlat** (Method) - Checks if the hierarchy is flat.
- **humanoidConfig** (Property) - Configuration for humanoid characters.
- **initiated** (Property) - Indicates if the system has been initiated.
- **internalCollisions** (Property) - Manages internal collisions.
- **isActive** (Property) - Checks if the system is active.
- **isAlive** (Property) - Checks if the system is alive.
- **isBlending** (Property) - Checks if blending is active.
- **IsDisconnecting** (Method) - Checks if the system is disconnecting.
- **isFrozen** (Property) - Checks if the system is frozen.
- **isKilling** (Property) - Checks if the system is in the process of killing.
- **IsReconnecting** (Method) - Checks if the system is reconnecting.
- **isSwitchingMode** (Property) - Checks if the mode is switching.
- **isSwitchingState** (Property) - Checks if the state is switching.
- **IsValid** (Method) - Checks if the system is valid.
- **Kill** (Method) - Kills the system.
- **manualAngularLimitControl** (Property) - Manual control for angular limits.
- **manualInternalCollisionControl** (Property) - Manual control for internal collisions.
- **mapDisconnectedMuscles** (Method) - Maps disconnected muscles.
- **mappingWeight** (Property) - The weight of the mapping.
- **mode** (Property) - The current mode of the system.
- **Mode** (Property) - Enum for different modes.
- **muscleDamper** (Property) - Damper value for muscles.
- **muscles** (Property) - Collection of muscles.
- **muscleSpring** (Property) - Spring value for muscles.
- **muscleWeight** (Property) - Weight of the muscles.
- **OnFixTransforms** (Event) - Called when transforms are fixed.
- **OnHierarchyChanged** (Event) - Called when the hierarchy changes.
- **OnMuscleDisconnected** (Event) - Called when a muscle is disconnected.
- **OnMuscleReconnected** (Event) - Called when a muscle is reconnected.
- **OnMuscleRemoved** (Event) - Called when a muscle is removed.
- **OnPostInitiate** (Event) - Called after initiation.
- **OnPostLateUpdate** (Event) - Called after LateUpdate.
- **OnPostSimulate** (Event) - Called after simulation.
- **OnPreSimulate** (Event) - Called before simulation.
- **OnRead** (Event) - Called when data is read.
- **OnWrite** (Event) - Called when data is written.
- **pinDistanceFalloff** (Property) - Falloff value for pin distance.
- **pinPow** (Property) - Power value for pin.
- **pinWeight** (Property) - Weight of the pin.
- **propMuscles** (Property) - Collection of prop muscles.
- **Rebuild** (Method) - Rebuilds the system.
- **ReconnectMuscleRecursive** (Method) - Reconnects a muscle and its children recursively.
- **RemoveMuscleRecursive** (Method) - Removes a muscle and its children recursively.
- **RemoveRagdollComponents** (Method) - Removes ragdoll components.
- **ReplaceMuscle** (Method) - Replaces a muscle.
- **Resurrect** (Method) - Resurrects the system.
- **SampleTargetMappedState** (Method) - Samples the target mapped state.
- **SetAngularLimitsManual** (Method) - Manually sets angular limits.
- **SetInternalCollisionsManual** (Method) - Manually sets internal collisions.
- **SetMuscles** (Method) - Sets the muscles.
- **SetMuscleWeights** (Method) - Sets the weights of muscles.
- **SetMuscleWeightsRecursive** (Method) - Sets the weights of muscles recursively.
- **SetUp** (Method) - Sets up the system.
- **SetUpTo** (Method) - Sets up to a specific state.
- **solverIterationCount** (Property) - Number of solver iterations.
- **solvers** (Property) - Collection of solvers.
- **state** (Property) - The current state of the system.
- **stateSettings** (Property) - Settings for the system state.
- **StoreTargetMappedState** (Method) - Stores the target mapped state.
- **storeTargetMappedState** (Method) - Stores the target mapped state.
- **supportTranslationAnimation** (Property) - Indicates if translation animation is supported.
- **SwitchToActiveMode** (Method) - Switches to active mode.
- **SwitchToDisabledMode** (Method) - Switches to disabled mode.
- **SwitchToKinematicMode** (Method) - Switches to kinematic mode.
- **targetAnimation** (Property) - The target animation.
- **targetAnimator** (Property) - The target animator.
- **targetRoot** (Property) - The target root object.
- **Teleport** (Method) - Teleports the system.
- **TreeHierarchy** (Property) - The hierarchy of the system.
- **updateJointAnchors** (Method) - Updates joint anchors.
- **UpdateMode** (Method) - Updates the mode.
- **updateMode** (Method) - Updates the mode.
- **visualizeTargetPose** (Method) - Visualizes the target pose.

### IsReconnecting Method

#### Description
Checks if a specific muscle is scheduled for reconnecting.

#### Method
`IsReconnecting`

#### Parameters
##### Path Parameters
- **_muscleIndex_** (int) - Required - The index of the muscle to check.

##### Return Value
- **bool** - True if the muscle is scheduled for reconnecting, false otherwise.
```

--------------------------------

### RootMotion Class Properties

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_biped_references_a0de30389b2723bf37445f1055eabf68c.html

Lists the properties available within the RootMotion class, representing various body parts and setup states.

```APIDOC
## RootMotion Class Properties

### Description
Provides access to various body part references and setup information for character rigging.

### Properties
- **AssignHumanoidReferences** (AssignHumanoidReferences) - Description not provided
- **AutoDetectReferences** (AutoDetectReferences) - Description not provided
- **Contains** (Contains) - Description not provided
- **DetectReferencesByNaming** (DetectReferencesByNaming) - Description not provided
- **eyes** (Transform) - Description not provided
- **head** (Transform) - Description not provided
- **isEmpty** (isEmpty) - Description not provided
- **IsEmpty** (IsEmpty) - Description not provided
- **isFilled** (isFilled) - Description not provided
- **leftCalf** (Transform) - Description not provided
- **leftFoot** (Transform) - Description not provided
- **leftForearm** (Transform) - Description not provided
- **leftHand** (Transform) - Description not provided
- **leftThigh** (Transform) - Description not provided
- **leftUpperArm** (Transform) - Description not provided
- **pelvis** (Transform) - Description not provided
- **rightCalf** (Transform) - Description not provided
- **rightFoot** (Transform) - Description not provided
- **rightForearm** (Transform) - Description not provided
- **rightHand** (Transform) - Description not provided
- **rightThigh** (Transform) - Description not provided
- **rightUpperArm** (Transform) - Description not provided
- **root** (Transform) - Description not provided
- **SetupError** (SetupError) - Description not provided
- **SetupWarning** (SetupWarning) - Description not provided
- **spine** (Transform) - Description not provided
```

--------------------------------

### RootMotion.Dynamics.Weight Constructor

Source: http://root-motion.com/puppetmasterdox/html/class_root_motion_1_1_dynamics_1_1_weight_a6ad3dfcaa8f73f20448518a56551477f.html

Details the constructor for the Weight class.

```APIDOC
## Weight Constructor

### Description
Initializes a new instance of the RootMotion.Dynamics.Weight class.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```
Tokens:
Raw