TetrapodRagdoll Class

A component used for configuring and maintaining references to a tetrapod character ragdoll hierarchy.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Candlelight.PhysicsRagdoll
            Candlelight.PhysicsArbitraryRagdoll
              Candlelight.PhysicsTetrapodRagdoll
                Candlelight.PhysicsHumanoidRagdoll

Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0

Syntax

Copy

public class TetrapodRagdoll : ArbitraryRagdoll, 
	ITetrapodMutable<RagdollPart, RagdollPartChain>, ITetrapod<RagdollPart, RagdollPartChain>, 
	IVertebrate<RagdollPart, RagdollPartChain>, IHierarchy<RagdollPart>, 
	IArbitraryChains<RagdollPart, RagdollPartChain>, IForelimbs<RagdollPart>, 
	IHindlimbs<RagdollPart>, IVertebrateMutable<RagdollPart, RagdollPartChain>, 
	IArbitraryChainsMutable<RagdollPart, RagdollPartChain>, IForelimbsMutable<RagdollPart>, 
	IHindlimbsMutable<RagdollPart>

The TetrapodRagdoll type exposes the following members.

Methods

	Name	Description
	AutomaticallyFindParts	Automatically finds all parts in this object's hierarchy using a TetrapodNamingConvention or Animator. The character is assumed to be in a neutral pose (e.g., T-Pose).
	Characterize	Apply Collider, Joint, and Rigidbody properties to all PhysicalBody nodes defined on this instance using the specified template. If the template is , then DefaultCharacterizationTemplate will be used.
	ConnectAndMapParts	Connect all parts defined on this instance and map symmetry as needed. (Overrides ArbitraryRagdollConnectAndMapParts(DictionaryString, String).)
	DefinesArbitraryChain	Gets a value indicating whether or not this instance defines an arbitrary RagdollPartChain with the specified identifier. (Inherited from ArbitraryRagdoll.)
	GetAllNodes	Gets all nodes in this TetrapodRagdoll's definition, with the most basal parts sorted first. (Overrides ArbitraryRagdollGetAllNodes(ListRagdollPart).)
	GetArbitraryChains	Gets the arbitrary chains. (Inherited from ArbitraryRagdoll.)
	GetArbitraryChains(DictionaryString, RagdollPartChain)	Gets the arbitrary RagdollPartChains. (Inherited from ArbitraryRagdoll.)
	GetDefaultNamingConvention	Gets a default naming convention for this instance.
	GetEstimatedLocalBounds	Gets the estimated Bounds of this Ragdoll in its current configuration, in the space of its Transform component. It will encapsulate all of the Transforms of the hierarchy's nodes, as well as all of the currently active SkinnedMeshRenderers and MeshRenderers. (Inherited from Ragdoll.)
	OnEnable	Ensure current values of self collision properties are respected.
	OnPartsChanged	Raises an event when one or more parts changed, which reconnects and remaps parts as needed, and redistributes the hierarchy mass. (Overrides RagdollOnPartsChanged.)
	RebuildChain	Rebuilds the specified chain to ensure its bodies are connected. (Inherited from Ragdoll.)
	RedistributeHierarchyMass	Redistributes the mass specified on this object to each of the parts, based on their current proportional contribution to the whole hierarchy. (Inherited from Ragdoll.)
	SetArbitraryChains(DictionaryString, RagdollPartChain)	Sets the arbitrary chains. (Inherited from ArbitraryRagdoll.)
	SetArbitraryChains(IdentifiableRagdollPartChain)	Sets the arbitrary chains. (Inherited from ArbitraryRagdoll.)
	SetHierarchyAngularDampingProfile	Sets the shape of the angular damping profile for all RagdollParts in the definition. Their values will be the specified profile multiplied by the hierarchy's total mass. (Inherited from Ragdoll.)
	SetHierarchyAngularPositionForceProfile	Sets the shape of the angular position force profile for all RagdollParts in the definition. Their values will be the specified profile multiplied by the hierarchy's total mass. (Inherited from Ragdoll.)
	SetHierarchyAngularVelocityForceProfile	Sets the shape of the angular velocity force profile for all RagdollParts in the definition. Their values will be the specified profile multiplied by the hierarchy's total mass. (Inherited from Ragdoll.)
	SetHierarchyLinearDampingProfile	Sets the shape of the linear damping profile for all RagdollParts in the definition. Their values will be the specified profile multiplied by the hierarchy's total mass. (Inherited from Ragdoll.)
	SetHierarchyLinearPositionForceProfile	Sets the shape of the linear position force profile for all RagdollParts in the definition. Their values will be the specified profile multiplied by the hierarchy's total mass. (Inherited from Ragdoll.)
	SetHierarchyLinearVelocityForceProfile	Sets the shape of the linear velocity force profile for all RagdollParts in the definition. Their values will be the specified profile multiplied by the hierarchy's total mass. (Inherited from Ragdoll.)
	SetHierarchyPhysicsMaterial	Sets the hierarchy physics material. This method will assign the Collider.sharedMaterial property on each Collider referenced in this Ragdoll's definition. (Inherited from Ragdoll.)
	Start	Cache the bindpose. (Inherited from Ragdoll.)

Top

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.)

Top

Properties

	Name	Description
	CharacterizationTemplate	Gets the characterization template currently in use.
	DefaultCharacterizationTemplate	Gets the default template to be used when Characterize(TetrapodCharacterizationTemplate) is called and no template is supplied.
	Head	Gets or sets the head.
	HierarchyMass	Gets or sets the hierarchy mass. Setting this value will redistribute mass to all PhysicalBody nodes in this Ragdoll's definition, based on their current proportional distribution. For example, if the definition contains two parts, one with mass 5.0 and another with mass 10.0, setting this property to a value of 9.0 would change their masses to 3.0 and 6.0, respectively. This property will enforce a minimum value of 1.0. (Inherited from Ragdoll.)
	LeftDistalForelimb	Gets or sets the left distal forelimb.
	LeftDistalHindlimb	Gets or sets the left distal hindlimb.
	LeftManualPhalanx	Gets or sets the left manual phalanx.
	LeftManus	Gets or sets the left manus.
	LeftPedalPhalanx	Gets or sets the left pedal phalanx.
	LeftPes	Gets or sets the left pes.
	LeftProximalForelimb	Gets or sets the left proximal forelimb.
	LeftProximalHindlimb	Gets or sets the left proximal hindlimb.
	LeftShoulder	Gets or sets the left shoulder.
	NamingConvention	Gets the naming convention currently in use.
	Neck	Gets or sets the neck.
	Pelvis	Gets or sets the pelvis.
	RightDistalForelimb	Gets or sets the right distal forelimb.
	RightDistalHindlimb	Gets or sets the right distal hindlimb.
	RightManualPhalanx	Gets or sets the right manual phalanx.
	RightManus	Gets or sets the right manus.
	RightPedalPhalanx	Gets or sets the right pedal phalanx.
	RightPes	Gets or sets the right pes.
	RightProximalForelimb	Gets or sets the right proximal forelimb.
	RightProximalHindlimb	Gets or sets the right proximal hindlimb.
	RightShoulder	Gets or sets the right shoulder.
	Root	Gets the root. (Inherited from Ragdoll.)
	ShouldAxialSkeletonCollideWithProximalLimbs	Gets or sets a value indicating whether the RagdollParts in the axial skeleton (head, neck, and spine) should ignore collisions with nearby proximal limbs.
	ShouldAxialSkeletonCollideWithSelf	Gets or sets a value indicating whether the RagdollParts in the axial skeleton (head, neck, and spine) should ignore collisions with one another.
	Spine	Gets or sets the spine.

Top

Reference

Candlelight.Physics Namespace