Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The ragdoll module applies applies ragdoll physics to the agents belonging to this agent group agents.

Your agent types will have to be set up for with a ragdoll file.


...

Attributes

AttributesTypeOverridableDescription
modeintyes

The ragdoll mode. Values are:
0 - none
1 - static
2 - kinematic
3 - ragdoll
4 - partial ragdoll
3 - motor ragdoll
4 - partial motor ragdoll

ragdollSetupstringyesOverrides the ragdoll setup file stored in the agentType for this agent (not yet in use)
useDynamicModeMetadataboolyesIf set
the
to true the mode is driven by the "dynamicMode" metadata
partialRagdollFilterstringyesA comma separated string containing the joint names with partial ragdoll (wildcards are supported)
dynamicOnCollisionintegeryes
Activate dynamicOnCollisionPoolintegeryescollisionForceThresholddoubleyesmotorRagdollDampingdoubleyes
Activates dynamics on collision
dynamicOnCollisionFilterstringyes

If a metadata name is specified, the metadata value is used.
Depending on the metadata type a different action is performed:

  • Vector3Metadata: the force direction is taken from the metadata
  • DoubleMetadata: the force magnitude is taken from the metadata
  • IntMetadata, BoolMetadata: the weight of the module is taken from the metadata
A comma separated string containing the joint names that are used to trigger the dynamicOnCollision mode (wildcards are supported)
dynamicOnCollisionPoolintegeryes

Pool on which an agent is assigned after a dynamicCollision event happen.
Use the following values:

  • -1 for making the agent collide with everything
  • -2 to disable collision
  • any positive integer for setting a specific pool
collisionForceThresholddoubleyes

The force threshold for the kinematic to dynamic conversion, if the force magnitude is lower than this value the object won't be converted.
As soon as the force magnitude is higher than this value the dynamicOnCollision mode will be triggered.

motorRagdollDampingdoubleyesMotor constraint damping value, with value of -1 the operator uses the one stored inside the ragdoll setup file
motorRagdollStiffnessdoubleyesMotor constraint stiffness value, with value of -1 the operator uses the one stored inside the ragdoll setup file
motorRagdollIsAccelerationintegeryesMotor constraint "isAcceleration" value, with value of -1 the operator uses the one stored inside the ragdoll setup file
motorRagdollMaxForcedoubleyesMotor constraint "max force" value, with value of -1 the operator uses the one stored inside the ragdoll setup file
breakableintegeryesActivate the constraint breakable force
breakableFilterstringyesA comma separated string containing the joint names where the operator sets the breakable option (wildcards are supported)
breakForcevector2yesBreakable force limit (x for linear magnitude and y for torque magnitude)
animationBlendingdoubleyesBlend weight used on motor constraint. With a value of 1.0 the agent clip animation is applied on the motor constraint
stuckOnCollisionboolyesIf set to true, rigid bodies
gets
get stuck on collision
stuckOnCollisionBreakForcevector2yesBreak force magnitude to break the stuck on collision constraint. Value of -1 means an infinite force
stuckOnCollisionImpulsedoubleyesInpulse magnitude multiplier applied to the impulse force on a stuckOnCollision event
stuckOnCollisionPoolintegeryesPool on which an agent is assigned after the occurring of a stuckOnCollision event. 

Use the following values:

  • -1 for making the agent collide with everything
  • -2 to disable collision
  • any positive integer for setting a specific pool
collisionPoolintegeryesCollision pool. 

Use the following values:

  • -1 for making the agent collide with everything
  • -2 to disable collision
  • any positive integer for setting a specific pool
partialRagdollSkipChildrenboolyes

If true, the ragdoll operator won't create rigid bodies for the children of the given joints (partialRagdollFilter) when the agent is in partial ragdoll.

selfCollisionboolyesEnable the agent self collision
debugboolnoActivate the
dubegging
debugging drawing on the selected agents.