Prop ragdoll

See also:  For details on creating a ragdoll, see $collisionjoints.

Class hierarchy
CRagdollProp ↳CBaseAnimating ↳CBaseEntity
physics_prop_ragdoll.cpp

prop_ragdoll can interact with dynamic objects, unlike death ragdolls.

prop_ragdoll is a point entity available in all Source games. It is a VPhysics ragdoll. Ragdolls are collections of physics objects constrained together to simulate a jointed object like a dead body. They are very expensive to simulate.

Note:In Black Mesa original entity version is available as prop_ragdoll_original. The difference is: prop_ragdoll_original can't be gibbed with explosions, crowbar can hit prop_ragdoll_original if [4] Debris spawnflag is unchecked (crowbar's raycast skips prop_ragdoll for some reason), prop_ragdoll_original doesn't bleed or have decals on it, prop_ragdoll_original can't be picked up, prop_ragdoll_original have realistic bullet push.

Warning:This entity generates server-side ragdolls, which collide with everything but produce very large amounts of network traffic. Network traffic can be significantly reduced by making the ragdoll start asleep, disabling motion and disabling collisions with dynamic objects (!FGD add "solid" keyvalue with value of 0) and only enabling motion when necessary.

Bug:Setting a custom pose via Hammer and making the ragdoll start asleep will make the rendering box fail to update. Making the ragdoll wake for a single frame when spawned and then sleeping it will fix this issue.  [todo tested in ?]

Bug: Portal 2 ragdolls cannot pass through portals. This often occurs in Portal as well.  [todo tested in ?]

Bug: Ragdolls are ignored in prediction, this causes lots of prediction errors when touching a ragdoll.  [todo tested in ?]

Bug:In Black Mesa:

• server side ragdolls created by NPCs never gib before loading save since the first Steam version, the same for gibs created by gibbed ragdolls. Use the workshop addon if you want to use server side ragdolls in your mod.
• crowbar's raycast skips/ignores server side ragdolls since the first Steam version.
• Tripmines do not gib ragddols
• In multiplayer ragdolls do not create hole decals and blood from bullets if [4] Debris spawnflag is enabled. If this flag is disabled - ragdolls still will not create blood effects and hand blood overlays.  [todo tested in ?]

AltNames: This entity is also tied to physics_prop_ragdoll.

Death Ragdolls/Ragdoll Transformation

When a NPC/player dies or an entity receives the BecomeRagdoll input, it normally creates a client-side ragdoll and copies most of its animation and visual data to it. Unlike server-side prop_ragdolls, these client-side ragdolls are handled completely on a per-client basis and are much cheaper and simpler than their server-side counterparts, at the expense of being virtually nonexistent on the server, being inconsistent across client perspectives, and only colliding with entities that have physics objects on the client (e.g. worldspawn).

However, a NPC will become a server-side ragdoll while it's under any of the following conditions:

• The NPC is inside the volume of a trigger_serverragdoll
• The NPC is killed by a vehicle in singleplayer
• The gravity gun is supercharged
• The NPC dies on fire while in Alyx darkness mode
• The NPC is a vital ally (e.g., npc_alyx)

These server-side death ragdolls will collide with physics objects and beyond, like any prop_ragdoll, but they are marked as debris and do not collide with each other. They do not collide with themselves either, unlike client-side ragdolls (fixed in Entropy : Zero 2 and Black Mesa). This is believed to be intentional behavior to reduce performance/networking costs.

Bug:Server side ragdolls don't save blood decals. Fixed in Mapbase and Black Mesa.  [todo tested in ?]

Note:Most of this list theoretically applies to players as well, although that hasn't been tested.

Warning:While most of the relevant animation/visual data is copied to ragdolls, some fields, like fade distances, are not transferred.

Code:This can be modified at CBaseAnimating::CopyAnimationDataFrom() in baseanimating.cpp for server-side ragdolls and C_BaseAnimating::CreateRagdollCopy() in c_baseanimating.cpp for client-side ragdolls.

Keyvalues

Name (targetname) <string>[ Edit ]

The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.

See also:  Generic Keyvalues, Inputs and Outputs available to all entities

sequence ([todo internal name (i)]) <integer> !FGD

The ragdoll will be moved to the first frame of this animation before VPhysics takes over.

Bug:Doesn't function.  [todo tested in ?]

Body (body) <integer> !FGD

Specifies which body group should be used.

Override Animation (angleOverride) <string>

Filled in by the engine via wc_update_entity. Do not edit by hand except to clear.

Health (health) <integer> (only in )

The amount of damage the ragdoll takes before gibbing.

Character Manifest Mimic Name (MimicName) <string> (only in )

Choose a name or a classname from the character manifest to dress the ragdoll.

GMODSandbox:

Allow Physics Gun (gmod_allowphysgun) <boolean> (only in )

If set, players cannot use Physics Gun on this entity.

Sandbox Tool Whitelist (gmod_allowtools) <string> (only in )

If set, only given tools can be used on this entity. You need to supply the tool class names, the names of the .lua files of those tools. This also includes the context menu properties!

Flags

Debris : [4]

Don't collide with the player or other debris

Use 'Least Recently Used' Retirement : [4096] !FGD

Allow Dissolve : [8192]

Motion Disabled : [16384]

Allow stretch : [32768]

Start asleep : [65536]

Inputs

StartRagdollBoogie

Begins ragdoll boogie effect for 5 seconds.

Bug:This input is actually supposed to use a parameter for how long the ragdoll should boogie, but it uses the wrong field type in the data description.  [todo tested in ?]

Code Fix:In CRagdollProp's data description, find DEFINE_INPUTFUNC( FIELD_VOID, "StartRagdollBoogie", InputStartRadgollBoogie ) and replace FIELD_VOID with FIELD_FLOAT.

EnableMotion, DisableMotion

Enable/disable physics simulation.

FadeAndRemove  (in all games since )

Fade out then remove (kill) self. Parameter override = duration of fade.

AllowBloodPool  (only in ) !FGD

Сorpse once will create pool of blood (particle effect) if it is placed on brush.

Note:Not avaible for prop_ragdoll_original and prop_ragdoll_attached.

See Also

• Prop Types Overview