This article's documentation is for anything that uses the Source engine. Click here for more information.

Phys ragdollmagnet: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (cleanup tag)
No edit summary
 
(22 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{cleanup}}
{{CD|CRagdollMagnet|file1=CRagdollMagnet.cpp}}
phys_ragdollmagnet
{{this is a|point entity|name=phys_ragdollmagnet}} It acts like a magnet for ragdolls. Useful for crafting exaggerated ragdoll behavior (i.e. guys falling over rails on death). If the Bar Magnet spawnflag is set, the magnet works like it was a cylindrical magnet i.e. it attracts ragdolls to the nearest point on a line.
{{official vmf example|sdk_phys_ragdollmagnet.vmf}}


An entity that acts like a magnet for ragdolls. Useful for crafting exaggerated ragdoll behavior (i.e. guys falling over rails on death). If the Bar Magnet spawnflag is set, the magnet works like it was a cylindrical magnet i.e. it attracts ragdolls to the nearest point on a line.
== Keyvalues ==
{{KV Targetname}}
{{KV|Bar Magnet Axis|intn=axis|vecline|Axis of the bar magnet, if the spawnflag is active.}}
{{KV|Effective Radius|intn=radius|float|Radius in which ragdolls are affected around this entity's origin.}}
{{KV|Force|intn=force|float|Magnetic force to apply to ragdolls within the radius. Expressed as kilograms per inch per second. So a force of 1000 will add 10 inches/second to a 100kg man. It will add 100 inches per second to a 10kg headcrab. {{tip|Using a negative value will propel ragdolls away from the magnet.}}}}
{{KV|Entity to affect|intn=target|string|If specified, the phys_ragdollmagnet will only affect the target entity.}}
{{KV EnableDisable}}


KEYS
== Flags ==
{{fl|2|Bar Magnet (use axis helper)}}


Name targetname <target_source> The name that other entities refer to this entity by.
== Inputs ==
{{I EnableDisable}}


Start Disabled StartDisabled <choices>
[[Category:Forces]]
 
Parent parentname <target_destination> The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
 
Pitch Yaw Roll (Y Z X) angles <angle> This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
 
Bar Magnet Axis axis <vecline>
 
Effective Radius radius <float> Radius in which ragdolls are affected around this entity's origin.
 
Force force <float> Magnetic force to apply to ragdolls within the radius. Expressed as kilograms per inch per second. So a force of 1000 will add 10 inches/second to a 100kg man. It will add 100 inches per second to a 10kg headcrab.
 
Entity to affect target <string> If specified, the phys_ragdollmagnet will only affect the target entity.
 
spawnflags spawnflags <flags>
 
 
INPUTS
 
Kill Removes this entity from the world.
 
KillHierarchy Removes this entity and all its children from the world.
 
AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
 
FireUser1 Causes this entity's OnUser1 output to be fired.
 
FireUser2 Causes this entity's OnUser2 output to be fired.
 
FireUser3 Causes this entity's OnUser3 output to be fired.
 
FireUser4 Causes this entity's OnUser4 output to be fired.
 
Enable Enable this entity.
 
Disable Disable this entity.
 
SetParent <string> Changes the entity's parent in the movement hierarchy.
 
SetParentAttachment <string> Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
 
ClearParent Removes this entity from the the movement hierarchy, leaving it free to move independently.
 
 
OUTPUTS
 
OnUser1 Fired in response to FireUser1 input.
 
OnUser2 Fired in response to FireUser2 input.
 
OnUser3 Fired in response to FireUser3 input.
 
OnUser4 Fired in response to FireUser4 input.

Latest revision as of 06:57, 29 April 2025

C++ Class hierarchy
CRagdollMagnet
↳CPointEntity
↳CBaseEntity
C++ CRagdollMagnet.cpp

phys_ragdollmagnet is a point entity available in all Source Source games. It acts like a magnet for ragdolls. Useful for crafting exaggerated ragdoll behavior (i.e. guys falling over rails on death). If the Bar Magnet spawnflag is set, the magnet works like it was a cylindrical magnet i.e. it attracts ragdolls to the nearest point on a line.

PlacementTip.pngExample:See steamapps/common/sourcesdk_content/hl2/mapsrc/sdk_phys_ragdollmagnet.vmf for example use (comes with Source SDK installation [confirm])

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

Bar Magnet Axis (axis) <vector>
Axis of the bar magnet, if the spawnflag is active.
Effective Radius (radius) <float>
Radius in which ragdolls are affected around this entity's origin.
Force (force) <float>
Magnetic force to apply to ragdolls within the radius. Expressed as kilograms per inch per second. So a force of 1000 will add 10 inches/second to a 100kg man. It will add 100 inches per second to a 10kg headcrab.
Tip.pngTip:Using a negative value will propel ragdolls away from the magnet.
Entity to affect (target) <string>
If specified, the phys_ragdollmagnet will only affect the target entity.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Flags

Bar Magnet (use axis helper) : [2]

Inputs

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Phys_ragdollmagnet&oldid=474067"