 | RagdollPart Class |
A PhysicalBody with a ConfigurableJoint.
Inheritance HierarchySystemObject
Object
Component
Behaviour
MonoBehaviour
Candlelight.PhysicsFlexibleCollider
Candlelight.PhysicsPhysicalBody
Candlelight.PhysicsRagdollPart
Object
Component
Behaviour
MonoBehaviour
Candlelight.PhysicsFlexibleCollider
Candlelight.PhysicsPhysicalBody
Candlelight.PhysicsRagdollPart
Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0
SyntaxC#
public class RagdollPart : PhysicalBody
The RagdollPart type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Awake |
Store Joint's bindpose and frame.
|
 | CacheChild |
Adds the specified RagdollPart to the list of cached children. It will only be
returned as an actual child if its ParentBody property is this
PhysicalBody.
(Inherited from PhysicalBody.) |
| CacheCurrentAngularLimits |
Caches the current angular limits. The cached value will be used as the extent of the angular limits when
they are blended in and out. This method is automatically called when this instance is deserialized.
|
| CacheImpactTransmissionPercentages |
Caches the impact transmission percentages in the hierarchy. You should only need to call this method
manually if you change the topology of a ragdoll hierarchy by e.g., changing
ParentBody or if parts can translate far away from one another.
|
| FixedUpdate |
Recovery from impact strength reduction as needed.
|
| GetAngularDampingProfile |
Gets the profile of damping the Joint should use at different normalized strength
values when achieving its target angular position on all axes, if applicable.
|
| GetAngularPositionForceProfile |
Gets the profile of force the Joint should use at different normalized strength
values when achieving its target angular position on all axes, if applicable.
|
| GetAngularVelocityForceProfile |
Gets the profile of force the Joint should use at different normalized strength
values when achieving its target angular velocity on all axes, if applicable.
|
| GetChildParts |
Gets the child parts. These parts will include only RagdollPart objects registered
with CacheChild(RagdollPart) and whose
ParentBody is this PhysicalBody.
(Inherited from PhysicalBody.) |
| GetImpactLayerStrengths |
Gets the environment layers that will cause strength reduction upon impact, as well as the factor by which
collision impulses will be multiplied when calculating strength reduction.
|
| GetImpactRecoverySpeedProfile |
Gets the impact recovery speed profile.
|
| GetImpactStrengthReductionProfile |
Gets the impact strength reduction profile.
|
| GetImpactTransmissionProfile |
Gets the impact transmission profile.
|
| GetLinearDampingProfile |
Gets the profile of damping the Joint should use at different normalized strength
values when achieving its target linear position on all axes, if applicable.
|
| GetLinearPositionForceProfile |
Gets the profile of force the Joint should use at different normalized strength
values when achieving its target linear position on all axes, if applicable.
|
| GetLinearVelocityForceProfile |
Gets the profile of force the Joint should use at different normalized strength
values when achieving its target linear velocity on all axes, if applicable.
|
| GetPhysicalHierarchy |
Gets the physical hierarchy. These parts will include this PhysicalBody as well as
RagdollPart objects registered with
CacheChild(RagdollPart) whose
ParentBody is this PhysicalBody, as well as
their hierarchies.
(Inherited from PhysicalBody.) |
| GetPinningForceProfile |
Gets the profile of the ratio of pinning-force-to-joint-angular-limits to apply at different normalized
strength values to try to maintain target position.
|
| OnCollisionEnter |
Raises the collision enter event.
(Overrides FlexibleColliderOnCollisionEnter(Collision).) |
| OnCollisionExit |
Raises the collision exit event.
(Inherited from FlexibleCollider.) |
| OnCollisionStay |
Raises the collision stay event.
(Overrides FlexibleColliderOnCollisionStay(Collision).) |
| OnDisable |
Raises the disable event.
(Inherited from PhysicalBody.) |
| OnEnable |
Raises the enable event.
(Overrides PhysicalBodyOnEnable.) |
| OnJointBreak |
Set the HasJointBroken flag.
|
| OnModifySymmetricalProperty |
Raises the modify symmetrical property event. This method is called when a property is set that needs to be
pushed to the corresponding FlexibleCollider. You can invoke it manually if you
need to push settings that are not managed on this object directly, such as Joint
limits.
(Inherited from FlexibleCollider.) |
| OnSynchronizeSymmetricalProperties |
Raises the synchronize symmetrical properties event.
(Overrides PhysicalBodyOnSynchronizeSymmetricalProperties.) |
| RecoverFromImpactImmediately |
Immediately resets the impact recovery timer.
|
| ReduceStrength |
Tries to reduce the strength of this part using the specified impulse.
|
| Reset |
Reset this instance.
|
| ResetBindpose |
Resets Joint's bindpose in the current configuration.
|
| SetAngularDampingProfile |
Sets the profile of damping the Joint should use at different normalized strength
values when achieving its target angular position on all axes, if applicable.
|
| SetAngularPositionForceProfile |
Sets the profile of force the Joint should use at different normalized strength
values when achieving its target angular position on all axes, if applicable.
|
| SetAngularVelocityForceProfile |
Sets the profile of force the Joint should use at different normalized strength
values when achieving its target angular velocity on all axes, if applicable.
|
| SetImpactLayerStrengths |
Sets the environment layers that will cause strength reduction upon impact, as well as the factor by which
collision impulses will be multiplied when calculating strength reduction.
|
| SetImpactRecoverySpeedProfile |
Sets the impact recovery speed profile.
|
| SetImpactStrengthReductionProfile |
Sets the impact strength reduction profile.
|
| SetImpactTransmissionProfile |
Sets the impact transmission profile.
|
| SetJointTargetRotation |
Sets the ConfigurableJoint.targetRotation property by transforming the supplied
local rotation.
|
| SetLinearDampingProfile |
Sets the profile of damping the Joint should use at different normalized strength
values when achieving its target linear position on all axes, if applicable.
|
| SetLinearPositionForceProfile |
Sets the profile of force the Joint should use at different normalized strength
values when achieving its target linear position on all axes, if applicable.
|
| SetLinearVelocityForceProfile |
Sets the profile of force the Joint should use at different normalized strength
values when achieving its target linear velocity on all axes, if applicable.
|
| SetPinningForceProfile |
Sets the profile of the ratio of pinning-force-to-joint-angular-limits to apply at different normalized
strength values to try to maintain target position.
|
| SetStrength |
Sets the strength of this part.
|
| Start |
Cache the angular limits on Joint.
(Overrides PhysicalBodyStart.) |
| TryAddImpactAtPoint |
Tries to add an impact at the specified point that will cause this part and neighboring ones to reduce their
strength.
|
| TryImpactCollision |
Tries to reduce the strength of this part and neighboring ones using the specified collision data.
|
| UseExplicitCenterOfMassWhenLoaded | Makes the Rigidbody.centerOfMass property on Rigidbody use the explicit value serialized in the backing field for CenterOfMass when this objet is first loaded. Neither it nor Rigidbody.inertiaTensor will be automatically/continuously calculated anymore. This method only exists for enabling explicit center of mass before this object is loaded (e.g., in the editor). Setting CenterOfMass at run-time will cause the explicitly specified value to be used whether or not this method has been called. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetPrefabName |
Gets the name of the prefab associated with the supplied instance.
(Defined by ObjectX.) |
| OpenReferencePage |
Opens a reference web page generated for the specified object.
(Defined by ObjectX.) |
Properties| Name | Description | |
|---|---|---|
 | AreAngularLimitsCached |
Gets a value indicating whether angular limits have been cached on this instance.
|
| BlendTime |
Gets or sets the number of seconds this part takes to blend out of non-kinematic motion. This value is just
a convenience for other scripts that might want to use it.
(Inherited from PhysicalBody.) |
| Center |
Gets or sets the center of the Collider in this object's space.
(Inherited from FlexibleCollider.) |
| CenterOfMass | Gets or sets the center of mass on Rigidbody. As with Rigidbody.centerOfMass, setting a value for this property at run-time will set IsCenterOfMassExplicit to . |
| ChildCentroid |
Gets the average position of all child bodies in this body's space.
(Inherited from PhysicalBody.) |
| Collider |
Gets the collider.
(Inherited from FlexibleCollider.) |
| CorrespondingObject | Gets the corresponding FlexibleCollider across a plane of symmetry. It will be the FlexibleCollider component on the CorrespondingTransform of the SymmetryMapper assigned to this instance. |
| HasJointBroken |
Gets a value indicating whether Joint has broken.
|
| IsCenterOfMassExplicit | Gets a value indicating whether this object has already explicitly applied its CenterOfMass property to Rigidbody or should when it is loaded. If it returns , then Unity is assumed to be automatically/continuously calculating Rigidbody.centerOfMass and Rigidbody.inertiaTensor. |
| IsRecoveringFromImpact |
Gets a value indicating whether this instance is recovering from an environmental impact or an impulse
manually applied via TryAddImpactAtPoint(Vector3, Vector3).
|
 | IsSilent |
Gets or sets a value indicating whether instances of this class should emit debug messages. This value
should only be set to when performing automated tests.
|
| Joint |
Gets or sets the ConfigurableJoint on this object.
|
| LocalRotation |
Gets or sets the Collider's local rotation in this object's space.
(Inherited from FlexibleCollider.) |
| MaxStrength |
Gets or sets the max strength of this part.
|
| OnCollisionEnterEvent |
Gets the on collision enter event.
(Inherited from FlexibleCollider.) |
| OnCollisionExitEvent |
Gets the on collision exit event.
(Inherited from FlexibleCollider.) |
| OnCollisionStayEvent |
Gets the on collision stay event.
(Inherited from FlexibleCollider.) |
| ParentBody |
Gets or sets the PhysicalBody to which Joint is attached.
|
| PinningStrength |
Gets the pinning strength given the current Strength value.
|
| PrimaryJointAxisSymmetryMode |
Gets or sets the symmetry mode for the primary axis on Joint.
|
| ReciprocalBlendTime |
Gets the reciprocal of BlendTime.
(Inherited from PhysicalBody.) |
| Rigidbody |
Gets the Rigidbody on this object.
(Inherited from PhysicalBody.) |
| RunTimeSync |
Gets or sets a value describing whether or not this FlexibleCollider should
continue to sync with its corresponding part at run-time.
(Inherited from FlexibleCollider.) |
| SecondaryJointAxisSymmetryMode |
Gets or sets the symmetry mode for the secondary axis on Joint.
|
| Shape |
Gets or sets the shape of the Collider.
(Inherited from FlexibleCollider.) |
| Size |
Gets or sets the size of the Collider.
(Inherited from FlexibleCollider.) |
| Strength |
Gets the current strength of the Joint on this part.
|
| SymmetryMapper | Gets or sets a SymmetricalTransform component on this GameObject, which allows symmetrical property edits. If it is not and its CorrespondingTransform is assigned and has a FlexibleCollider component of this object's type, then all changes made to properties on this object will be reflected across the plane of symmetry. |
| Transform |
Gets this object's Transform.
(Inherited from FlexibleCollider.) |
Events| Name | Description | |
|---|---|---|
 | OnExceededMaximumImpulse |
Occurs when this part receives an impulse from the environment or from
TryAddImpactAtPoint(Vector3, Vector3) whose square magnitude exceeds the maximum
value of its impact strength reduction profile.
|
| OnImpact |
Occurs when this part receives an impulse from the environment or from
TryAddImpactAtPoint(Vector3, Vector3).
|
See Also