HumanoidRagdollAnimator Class

A component for driving a TetrapodRagdoll with an animated hierarchy. It is mainly a wrapper for TetrapodRagdollAnimator that uses more colloquially familiar property names.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Candlelight.PhysicsRagdollAnimator
            Candlelight.PhysicsArbitraryRagdollAnimator
              Candlelight.PhysicsTetrapodRagdollAnimator
                Candlelight.PhysicsHumanoidRagdollAnimator

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

Syntax

Copy

public class HumanoidRagdollAnimator : TetrapodRagdollAnimator, 
	IHumanoid<Transform, TransformChain>, ITetrapod<Transform, TransformChain>, 
	IVertebrate<Transform, TransformChain>, IHierarchy<Transform>, 
	IArbitraryChains<Transform, TransformChain>, IForelimbs<Transform>, 
	IHindlimbs<Transform>, IRagdollBinder<HumanoidRagdoll>

The HumanoidRagdollAnimator type exposes the following members.

Methods

	Name	Description
	AutomaticallyFindParts	Automatically finds all parts in this object's hierarchy using the serialized naming convention or Animator. (Inherited from TetrapodRagdollAnimator.)
	BindRagdoll	Binds the ragdoll to this RagdollAnimator. Its hierarchy will be flattened when it is bound. (Inherited from RagdollAnimator.)
	DefinesArbitraryChain	Gets a value indicating whether or not this instance defines an arbitrary TransformChain with the specified identifier. (Inherited from ArbitraryRagdollAnimator.)
	FixedUpdate	Synchronize the ragdoll and animated hierarchies as needed. (Inherited from RagdollAnimator.)
	GetAllNodes	Gets all nodes in this TetrapodRagdollAnimator's definition, with the most basal parts sorted first. (Inherited from TetrapodRagdollAnimator.)
	GetAnimatedBody	For the specified RagdollPart, get the corresponding Transform in the rendered hierarchy. (Inherited from RagdollAnimator.)
	GetArbitraryChains	Gets the arbitrary chains. (Inherited from ArbitraryRagdollAnimator.)
	GetArbitraryChains(DictionaryString, TransformChain)	Gets the arbitrary TransformChains. (Inherited from ArbitraryRagdollAnimator.)
	GetDefaultNamingConvention	Gets a default naming convention for this instance. (Inherited from TetrapodRagdollAnimator.)
	GetEstimatedLocalBounds	Gets the estimated Bounds of this RagdollAnimator 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 RagdollAnimator.)
	GetGroundingBodies	Gets a set of animated bodies and associated minimum strength values. By default, if any one of these parts falls below its minimum strength while contacting a ground layer then the full hierarchy will enter a ragdoll state. (Inherited from RagdollAnimator.)
	GetOrientationParameters	Gets the orientation parameters. (Inherited from RagdollAnimator.)
	GetRagdollPart	For the specified Transform, get the corresponding RagdollPart in the physical hierarchy. (Inherited from RagdollAnimator.)
	IgnoreColliderForGrounding	Ignores the specified collider when performing the grounding raycast or when testing if grounding bodies are grounded. (Inherited from RagdollAnimator.)
	IgnoreCollisionsBetweenAnimatorAndRagdoll	Ignores the collisions between the animated and ragdoll hierarchies based on the specified value. (Inherited from RagdollAnimator.)
	IsPartDisconnected	Determines whether the specified animated body has been disconnected, either because its joint broken or because a joint on one of its parents broke off. (Inherited from RagdollAnimator.)
	LateUpdate	Perform final actions for the frame. (Inherited from RagdollAnimator.)
	MapHierarchies	Map the animator and ragdoll hierarchies to each other. (Inherited from TetrapodRagdollAnimator.)
	OnDestroy	Raises the destroy event. (Inherited from RagdollAnimator.)
	OnDisable	Raises the disable event. (Inherited from RagdollAnimator.)
	OnEnable	Raises the enable event. (Inherited from TetrapodRagdollAnimator.)
	PrepareHierarchies	Prepares the hierarchy mappings and regenerates the list of colliders to ignore. (Inherited from RagdollAnimator.)
	SetArbitraryChains	Sets the arbitrary chains. (Inherited from ArbitraryRagdollAnimator.)
	SetBodyShouldAnimateWhenDisconnected	Indicate that the specified animated body should continue to animate when one of its ancestors disconnects. (Inherited from RagdollAnimator.)
	SetGroundingBodies	Sets a table of animated bodies and associated minimum strength values. By default, if any one of these parts falls below its minimum strength while contacting a ground layer then the full hierarchy will enter a ragdoll state. (Inherited from RagdollAnimator.)
	SetOrientationParameters	Sets the orientation parameters. (Inherited from RagdollAnimator.)
	Start	Start this instance. (Inherited from RagdollAnimator.)
	UnbindRagdoll	Unbinds the ragdoll currently bound to this instance, returning its hierarchy to the state it was in when bound. (Inherited from RagdollAnimator.)
	UnignoreColliderForGrounding	Unignores the specified collider when performing the grounding raycast or when testing if grounding bodies are grounded. (Inherited from RagdollAnimator.)
	Update	Emit error messages if avatar or controller change at run-time and preprocess animator if necessary. (Inherited from RagdollAnimator.)

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
	Animator	Gets the animator. (Inherited from RagdollAnimator.)
	FullHierarchyBlendProgress	Gets the normalized progress of this instance blending out of full-hierarchy ragdoll. (Inherited from RagdollAnimator.)
	FullHierarchyBlendTime	Gets or sets the number of seconds to take when blending from full-hierarchy ragdoll back to animation data. (Inherited from RagdollAnimator.)
	FullHierarchyRagdollParameter	Gets or sets a AnimatorControllerParameterType.Bool parameter specifying that the full hierarchy is ragdoll. (Inherited from RagdollAnimator.)
	GroundSurfaces	Gets or sets the ground surfaces. This value is used to reposition the animated hierarchy when the it exits full-hierarchy ragdoll. (Inherited from RagdollAnimator.)
	Head	Gets the head. (Inherited from TetrapodRagdollAnimator.)
	LeftCollar	Gets the left collar.
	LeftDistalForelimb	Gets the left distal forelimb. (Inherited from TetrapodRagdollAnimator.)
	LeftDistalHindlimb	Gets the left distal hindlimb. (Inherited from TetrapodRagdollAnimator.)
	LeftFinger	Gets the left finger.
	LeftFoot	Gets the left foot.
	LeftForearm	Gets the left forearm.
	LeftHand	Gets the left hand.
	LeftHip	Gets the left hip.
	LeftLowerLeg	Gets the left lower leg.
	LeftManualPhalanx	Gets the left manual phalanx. (Inherited from TetrapodRagdollAnimator.)
	LeftManus	Gets the left manus. (Inherited from TetrapodRagdollAnimator.)
	LeftPedalPhalanx	Gets the left pedal phalanx. (Inherited from TetrapodRagdollAnimator.)
	LeftPes	Gets the left pes. (Inherited from TetrapodRagdollAnimator.)
	LeftProximalForelimb	Gets the left proximal forelimb. (Inherited from TetrapodRagdollAnimator.)
	LeftProximalHindlimb	Gets the left proximal hindlimb. (Inherited from TetrapodRagdollAnimator.)
	LeftShoulder	Gets the left shoulder. (Inherited from TetrapodRagdollAnimator.)
	LeftToe	Gets the left toe.
	LeftUpperArm	Gets the left upper arm.
	NamingConvention	Gets the naming convention currently in use. (Inherited from TetrapodRagdollAnimator.)
	Neck	Gets the neck. (Inherited from TetrapodRagdollAnimator.)
	OnEnterFullHierarchyRagdoll	Gets the event when full hierarchy ragdoll was entered (i.e. all parts just now have a strength of 0). (Inherited from RagdollAnimator.)
	OnExitFullHierarchyRagdoll	Gets the event when full hierarchy ragdoll was exited (i.e. all parts had a strength of 0 and at least one is now greater than 0). (Inherited from RagdollAnimator.)
	OnPostprocessAnimatedHierarchy	Gets the event right before the animated hierarchy is finalized for rendering. (Inherited from RagdollAnimator.)
	OnPostprocessInputPose	Gets the event when the input pose has been set up, before it has been applied to the ragdoll. Subscribe to this event for applying procedural animation normally applied in LateUpdate() (e.g., custom IK solvers). (Inherited from RagdollAnimator.)
	OnPreprocessAnimatedHierarchy	Gets the event before the Animator has been updated. Subscribe to this event if you need to revert changes to non-animated transforms made in the previous frame. For example, if you are using Final IK, you would insert a call to FixTransforms() here if necessary. (Inherited from RagdollAnimator.)
	OrientationParameterUpdateMode	Gets or sets the orientation parameter update mode. (Inherited from RagdollAnimator.)
	Pelvis	Gets the pelvis. (Inherited from TetrapodRagdollAnimator.)
	Ragdoll	Gets the ragdoll being animated by this instance. (Inherited from RagdollAnimator.)
	RightCollar	Gets the right collar.
	RightDistalForelimb	Gets the right distal forelimb. (Inherited from TetrapodRagdollAnimator.)
	RightDistalHindlimb	Gets the right distal hindlimb. (Inherited from TetrapodRagdollAnimator.)
	RightFinger	Gets the right finger.
	RightFoot	Gets the right foot.
	RightForearm	Gets the right forearm.
	RightHand	Gets the right hand.
	RightHip	Gets the right hip.
	RightLowerLeg	Gets the right lower leg.
	RightManualPhalanx	Gets the right manual phalanx. (Inherited from TetrapodRagdollAnimator.)
	RightManus	Gets the right manus. (Inherited from TetrapodRagdollAnimator.)
	RightPedalPhalanx	Gets the right pedal phalanx. (Inherited from TetrapodRagdollAnimator.)
	RightPes	Gets the right pes. (Inherited from TetrapodRagdollAnimator.)
	RightProximalForelimb	Gets the right proximal forelimb. (Inherited from TetrapodRagdollAnimator.)
	RightProximalHindlimb	Gets the right proximal hindlimb. (Inherited from TetrapodRagdollAnimator.)
	RightShoulder	Gets the right shoulder. (Inherited from TetrapodRagdollAnimator.)
	RightToe	Gets the right toe.
	RightUpperArm	Gets the right upper arm.
	Root	Gets the root. (Inherited from RagdollAnimator.)
	Spine	Gets the spine. (Inherited from TetrapodRagdollAnimator.)
	StrengthUpdateMode	Gets or sets the strength update mode to use when applying Strength values to the ragdoll. (Inherited from RagdollAnimator.)

Top

Events

	Name	Description
	OnEnterRagdollState	Occurs when a RagdollPart enters a ragdoll state (i.e. its strength just now became 0). (Inherited from RagdollAnimator.)
	OnExitRagdollState	Occurs when a RagdollPart exits a ragdoll state (i.e. its strength was 0 and is now greater than 0). (Inherited from RagdollAnimator.)

Top

Remarks

See RagdollAnimator for more notes and limitations.

Reference

Candlelight.Physics Namespace