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

Phys ragdollconstraint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(vmf example)
 
(13 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{wrongtitle|title=phys_ragdollconstraint}}
{{CD|CRagdollConstraint|file1=1}}
{{this is a|point entity|name=phys_ragdollconstraint}} It is a constraint that fixes the position of two entities, relative to this constraint's origin. Also allows for limits on the rotation around each axis, in the space of this constraint.
{{official vmf example|sdk_phys_ragdollconstraint.vmf}}


==Entity Description==
== Keyvalues ==
A constraint that fixes the position of two entities, relative to this constraint's origin. Also allows for limits on the rotation around each axis, in the space of this constraint.
{{KV Targetname}}
{{TODO|'''MENTION RAGDOLLS!!'''}}
{{KV|X axis min limit|intn=xmin|float|-180 min and 180 max {{=}} no constraint on X axis. Default value is -90}}
{{KV|X axis max limit|intn=xmax|float|-180 min and 180 max {{=}} no constraint on X axis. Default value is 90}}
{{KV|Y axis min limit|intn=ymin|float|-180 min and 180 max {{=}} no constraint on Y axis. Default value is 0}}
{{KV|Y axis max limit|intn=ymax|float|-180 min and 180 max {{=}} no constraint on Y axis. Default value is 0}}
{{KV|Z axis min limit|intn=zmin|float|-180 min and 180 max {{=}} no constraint on Z axis. Default value is 0}}
{{KV|Z axis max limit|intn=zmax|float|-180 min and 180 max {{=}} no constraint on Z axis. Default value is 0}}
{{KV|X axis friction|intn=xfriction|float}}
{{KV|Y axis friction|intn=yfriction|float}}
{{KV|Z axis friction|intn=zfriction|float}}
{{KV TwoObjectPhysics}}


==Keyvalues==
== Flags ==
*{{kv targetname}}
{{fl|2|Only limit rotation (free movement)}}
*'''attach1''' <target_destination>
{{Fl TwoObjectPhysics}}
:Entity 1
*'''attach2''' <target_destination>
:Entity 2  
*'''constraintsystem''' <target_destination>
:The name of a [[phys_constraintsystem]] that this constraint should be a part of. All constraints on a set of entities should be placed in the same system, or they will fight each other during simulation.
*'''forcelimit''' <float>
:The amount of force an impact must apply to the constraint to break it. Measured in pounds. A way of calculating this is to set it to the mass of an object that would break this constraint if it were resting on the constrainted objects.
*'''torquelimit''' <float>
:The amount of torque required to break the constraint. Measured in pounds*distance (pounds*inches). A way of calculating this is to multiply any reference mass by the resting distance (from the center of mass of the object) needed to break the constraint.
*'''breaksound''' <sound>
:A sound played when the constraint is broken.
*'''xmin''' <float>
:X axis min limit. -180 min and 180 max = no constraint on this axis.
*'''xmax''' <float>
:X axis max limit. -180 min and 180 max = no constraint on this axis.
*'''ymin''' <float>
:Y axis min limit. -180 min and 180 max = no constraint on this axis.
*'''ymax''' <float>
:Y axis max limit. -180 min and 180 max = no constraint on this axis.
*'''zmin''' <float>
:Z axis min limit. -180 min and 180 max = no constraint on this axis.
*'''zmax''' <float>
:Z axis max limit. -180 min and 180 max = no constraint on this axis.
*'''xfriction''' <float>
:X axis friction
*'''yfriction''' <float>
:Y axis friction
*'''zfriction''' <float>
:Z axis friction


==Flags==
== Inputs ==
*1: No Collision until break
{{I TwoObjectPhysics}}
*2: Only limit rotation (free movement)
*4: Start inactive
*8: Change mass to keep stable attachment to world


==Inputs==
== Outputs ==
*{{i targetname}}
{{O TwoObjectPhysics}}
*'''Break'''
:Force the constraint to break.
*'''TurnOn'''
:Enable the constraint.  Do this when the objects don't exist when the constraint spawns, or when you have deactivated the constraint.  Broken constraints can ''not'' be turned on.  They have been deleted.
*''TurnOff''
:Disable this constraint.


==Outputs==
[[Category:Constraints|C]]
*{{o targetname}}
*'''OnBreak'''
:Fired when the constraint breaks.
 
[[Category:Entities]]

Latest revision as of 06:41, 29 April 2025

C++ Class hierarchy
CRagdollConstraint
↳CPhysConstraint
↳CLogicalEntity
↳CServerOnlyEntity
↳CBaseEntity
C++ physconstraint.cpp

phys_ragdollconstraint is a point entity available in all Source Source games. It is a constraint that fixes the position of two entities, relative to this constraint's origin. Also allows for limits on the rotation around each axis, in the space of this constraint.

PlacementTip.pngExample:See steamapps/common/sourcesdk_content/hl2/mapsrc/sdk_phys_ragdollconstraint.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

X axis min limit (xmin) <float>
-180 min and 180 max = no constraint on X axis. Default value is -90
X axis max limit (xmax) <float>
-180 min and 180 max = no constraint on X axis. Default value is 90
Y axis min limit (ymin) <float>
-180 min and 180 max = no constraint on Y axis. Default value is 0
Y axis max limit (ymax) <float>
-180 min and 180 max = no constraint on Y axis. Default value is 0
Z axis min limit (zmin) <float>
-180 min and 180 max = no constraint on Z axis. Default value is 0
Z axis max limit (zmax) <float>
-180 min and 180 max = no constraint on Z axis. Default value is 0
X axis friction (xfriction) <float>
Y axis friction (yfriction) <float>
Z axis friction (zfriction) <float>

TwoObjectPhysics:

Entity 1 (attach1) <targetname>
Entity 2 (attach2) <targetname>
The entities to constrain. Leave one or the other field blank to constrain to the world.
Note.pngNote:Only one entity will be constrained, even if several share the given targetname.
Constraint System Manager (constraintsystem) <targetname>
A phys_constraintsystem that this constraint should be a part of. This avoids the "jiggling" caused by constraints applied to the same set of entities fighting with each other.
Force Limit to Break (forcelimit) <float>
Impact force required to break the constraint, in pounds. 0 means infinite. A way of calculating this is to set it to the weight of an object that would break the constraint if it were resting on its objects.
Torque Limit to Break (torquelimit) <float>
Torque required to break the constraint, in pounds*inches. 0 means infinite. A way of calculating this is to multiply any reference mass by the resting distance (from the center of mass of the object) needed to break the constraint.
Play Sound on Break (breaksound) <string>
A sound played when the constraint is broken.
Follow teleport distance (teleportfollowdistance) <float>
If one constrained object teleports more than this many units away, the other will teleport with it.


Flags

Only limit rotation (free movement) : [2]
No Collision until break : [1]
Start inactive : [4]
Change mass to keep stable attachment to world : [8]
Do not connect entities until turned on : [16]

Inputs

TwoObjectPhysics:
Break
Force the constraint to break.
TurnOn
Enable the constraint; do this if the constrained objects don't exist when it spawns. Note that broken constraints cannot be turned back on as they have been deleted.
TurnOff
Disable the constraint.

Outputs

TwoObjectPhysics:
OnBreak
Fired when the constraint breaks.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Phys_ragdollconstraint&oldid=474059"