phys_constraint
From Valve Developer Community
Revision as of 08:20, 1 September 2009 by TomEdwards (Talk | contribs)
Contents |
phys_constraint is a point entity available in all Source games. It forces one entity to keep its position in relation to another. The two objects need not be touching, or even near to each other.
Example map: sourcesdk_content\hl2\mapsrc\sdk_phys_constraint.vmf
Keyvalues
TwoObjectPhysics:
- Entity 1
<targetname> - Entity 2
<targetname> - The entities to constrain. Leave one or the other field blank to constrain to the world.
Note:Only one entity will be constrained, even if several share the given targetname. - Constraint System Manager
<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 (lbs)
<float> - Impact force required to break the constraint, in pounds. 0 means infinite. A way of calculating this is to set it to the mass of an object that would break the constraint if it were resting on its objects.
- Torque Limit to Break (lbs * distance)
<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
<string> - A sound played when the constraint is broken.
- Follow teleport distance
<float> - If one constrained object teleports more than this many units away, the other will teleport with it.
Targetname:
- Name <string>
- The targetname other entities refer to this entity by.
Flags
- 1: No Collision until break
- 4: Start inactive
- 8: Change mass to keep stable attachment to world
- 16: Do not connect entities until turned on
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.
Targetname:
-
Kill - Removes this entity from the world.
-
KillHierarchy - Removes this entity and all its children from the world.
-
AddOutput <string> - Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
- Format:
<key> <value> - Format:
<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite> -
FireUser1toFireUser4 - Fire the
OnUseroutputs; see User Inputs and Outputs.
Outputs
TwoObjectPhysics:
- OnBreak
- Fired when the constraint breaks.
Targetname:
-
OnUser1toOnUser4 - Fired in response to the
FireUserinputs; see User Inputs and Outputs. -
OnKilled(New with Left 4 Dead) - Fired when the entity is killed and removed from the game.
