prop_physics

From Valve Developer Community
Jump to: navigation, search

prop_physics is a point entity available in all Source games. It is used to add rigid, VPhysics-simulated models to the world.

The only value required for prop_physics to work is a path to a model. As long as that model is physics-enabled, the correct data will be loaded from it when the map starts. It is possible to change any embedded physics data with the "Override Parameters" keyvalue.

Tip:Multiplayer maps should use prop_physics_multiplayer or prop_physics_respawnable. To create a jointed physics object, use prop_ragdoll.
Note:prop_physics can be parented if the 'parentname' value is manually added with smartedit turned off. Parenting prop_physics can be unpleasant and buggy in some situations.

Consistency

To do: Move this section to its own article.

Consistency becomes a large problem when dealing with the many prop models that the Source engine provides. From a player's perspective, object interactivity should remain consistent across all the levels of your game / mod. (Why? Shouldn't the level designer have control over this, dependent on the context of the prop's use?) To enforce this, the game-related data of props is stored within the model itself.

Models that are meant to be physically simulated (chairs, tables, wooden planks, etc) will remove themselves if they are placed as prop_static or prop_dynamic entities. Other game-related data, such as mass, "health", gib amount & models, and so on are all stored inside the prop model as well.

The method by which they are stored, and guidelines for how to set it up, can be found in the Prop Data section of the model's QC file.

See also

Keyvalues

BasePropPhysics:

Min Damage to Hurt <int>
The prop will ignore any damage events if the damage is less than this amount.
Shadow Cast Distance <int>
Use this to override how far this object casts shadows. 0 means the default distance.
Physics Impact Damage Scale <float>
Multiplies damage received from physics impacts. 0 means the feature is disabled for backwards compatibility.
Impact damage type <bool>
If true, damage type is sharp and the object can slice others.
Damaging it Doesn't Push It <bool>
Whether damaging the entity applies force to it.
Scale Factor For Inertia <float>
Scales the angular mass of an object. Used to hack angular damage and collision response.
Mass Scale <float>
Multiplier for the object's mass.
Override Parameters <string>
A list of physics keyvalues that are usually embedded in the model. Format is key,value,key,value,...
Health Level to Override Motion <int>
If specified, this object will start motion disabled. Once its health has dropped below this specified amount, it will enable motion.
Physics Impact Force to Override Motion <float>
If specified, this object will start motion disabled. Any impact that imparts a force greater than this value will enable motion.
puntsound <string>
Sound to make when punted by the Gravity Gun.

Studiomodel:

World Model <string>
The model this entity should appear as. 128-character limit.
Skin <int>
Some models have multiple skins. This value selects from the index, starting with 0.
Tip:Hammer's model browser automatically updates this value if you use it to view different skins.
modelscale <float> (New with Team Fortress 2)
The scaling factor for the model

Shadow:

Disable shadows <boolean>
Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
Disable ShadowDepth <boolean> (New with Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Projected Texture Cache <choices> (New with Portal 2)
Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.
  • 0 : Default
  • 1 : No cache - render every frame
  • 2 : Cache it - render only once
Disable flashlight <boolean> (New with Portal 2)
Used to disable projected texture lighting and shadows on this entity.

BreakableProp:

Pressure Delay <float>
Seconds to delay breaking from pressure. Allows creaking/groaning sounds to play.

Breakable:

Explosion Damage <float>
If non-zero, when this entity breaks it will create an explosion that causes the specified amount of damage. See also Explosion Radius.
Explosion Radius <float>
If non-zero, when this entity breaks it will create an explosion with a radius of the specified amount. See also Explosion Damage.
Performance Mode <choices>
Used to limit the amount of gibs produced when this entity breaks, for performance reasons.
  • 0 : Normal
  • 1 : No Gibs
  • 2 : Full Gibs on All Platforms
  • 3 : Reduced gibs

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
Name(s) of script files that are executed after all entities have spawned.
Script think function <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

DamageFilter:

Damage Filter <targetname>
Name of the filter_damage_type entity that controls which entities can damage us.

Shadow:

Disable shadows <boolean>
Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
Disable ShadowDepth <boolean> (New with Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Projected Texture Cache <choices> (New with Portal 2)
Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.
  • 0 : Default
  • 1 : No cache - render every frame
  • 2 : Cache it - render only once
Disable flashlight <boolean> (New with Portal 2)
Used to disable projected texture lighting and shadows on this entity.

Reflection:

Render in Fast Reflections <boolean> (New with Portal 2)
If enabled, causes this entity/prop to to render in fast water reflections (i.e. when a water material specifies $reflectonlymarkedentities) and in the world impostor pass.

BaseFadeProp:

Start Fade Dist <float>
End Fade Dist <float>
Distances at which the prop start and finish fading.
  • If start fade is <0, the prop will disappear instantly when end fade is hit.
  • If end fade is <0, the prop won't disappear at all. (This is the default behaviour.)
The values will scale appropriately if the prop is in a 3D Skybox.
Fade Scale <float>
If you specify so in worldspawn, or if the engine is running below DirectX 8 (DX7 in Ep1), props will fade out even if the fade distances above aren't specified. This value gives you some control over when this happens: numbers smaller than 1 cause the prop to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also the QC command $noforcedfade.

DXLevelChoice:

Minimum DX Level <choices>
Maximum DX Level <choices>
The entity will not exist if the engine is running outside the given range of DirectX Versions. Don't use this with anything that will break saved games should a player switch dxlevel!
  • Default (no bounding)
  • DX7
  • DX8
  • DX8.1
  • DX9 SM2
  • DX9 SM3

Angles:

Pitch Yaw Roll (Y Z X) <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.

Global:

Global Entity Name <string>
Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.

RenderFields:

Render Mode <choices>
Set a non-standard rendering mode on this entity. See Render Modes for details.
FX Amount (0 - 255) <int>
Intensity of the selected render mode.
FX Color (R G B) <color255>
Color used by the selected render mode (if applicable).
Disable Receiving Shadows <bool>
Prevents the entity from receiving shadows.

RenderFXChoices:

Render FX <choices>
Several GoldSrc-era visibility modes which change the way the entity is rendered, typically by fading it in and out.

Flags

BasePropPhysics:

  • 1 : Start Asleep
  • 2 : Don't take physics damage
  • 4 : Debris - Don't collide with the player or other debris
  • 8 : Motion Disabled
  • 64 : Enable motion on Physcannon grab
  • 128 : Not affected by rotor wash
  • 256 : Generate output on +USE
  • 512 : Prevent pickup
  • 1024 : Prevent motion enable on player bump
  • 4096 : Debris with trigger interaction
  • 8192 : Force server-side (Multiplayer only; see sv_pushaway_clientside_size)
  • 1048576 : Physgun can ALWAYS pick up. No matter what.

BreakableProp:

  • 16 : Break on Touch
  • 32 : Break on Pressure

Inputs

Ignite
Ignite, burst into flames.
IgniteLifetime  <float>
Ignite with the given lifetime. To do: Before the flames extinguish, or before health reaches zero?
IgniteNumHitboxFires  <integer>
Ignite with the given number of hitbox fires.
IgniteHitboxFireScale  <float>
Ignite with the given hitbox fire scale.

BasePropPhysics:

Wake
Sleep
Manually take the prop in or out of sleep mode. Props sleep after coming to rest and wake if affected by an external force.
EnableMotion
DisableMotion
Props with motion disabled will not move under any circumstances.
DisableFloating
Disable fluid/floating simulation.
SetBodyGroup <int>
Set this prop's body group.
physdamagescale <float>
Multiplies damage received from physics impacts. 0 means the feature is disabled for backwards compatibility.
EnableDamageForces
DisableDamageForces
Whether damaging the entity does applies force to it.
EnablePuntSound
DisablePuntSound
Allow/prevent this prop from playing its own sound when punted

Studiomodel:

Skin <int>
Changes the model's skin to the specified number.
SetBodyGroup <int>
Set the model's body group.
EnableShadow
DisableShadow
Control the model's cheap render-to-texture shadow.
AlternativeSorting <bool>
Used to attempt to fix sorting problems when rendering. To do: What is the effect?
SetModelScale  <float> (New with Team Fortress 2)
Sets the model scaling factor

Breakable:

Break
Breaks the breakable.
SetHealth  <integer>
Sets a new value for the breakable's health. If the breakable's health reaches zero it will break.
AddHealth  <integer>
Adds health to the breakable. If the breakable's health reaches zero it will break.
RemoveHealth  <integer>
Removes health from the breakable. If the breakable's health reaches zero it will break.
EnablePhyscannonPickup
Makes the breakable able to picked up by the Gravity Gun.
DisablePhyscannonPickup
Makes the breakable not able to picked up by the Gravity Gun.
SetMass  <float>
Set mass of this object.

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>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a game script file from disk.
RunScriptCode  <string> (New with Left 4 Dead 2)
Execute a string of script source code. String quotation may be needed when fired via console.
Note:The code is executed in the script scope of the entity that fires the output, not the one of the targeted entity.
Warning:Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction  <string> (New with Left 4 Dead 2)
Execute a game script function.

DamageFilter:

SetDamageFilter  <string>
Sets the entity to use as damage filter. Pass in an empty string ("") to clear the damage filter.

Shadow:

DisableShadow
Turn shadow off.
EnableShadow
Turn shadow on.
DisableReceivingFlashlight  (New with Portal 2)
This object will not receive light or shadows from projected textures.
EnableReceivingFlashlight  (New with Portal 2)
This object may receive light or shadows from projected textures.

Reflection:

DisableDrawInFastReflection  (New with Portal 2)
Turns off rendering of this entity in reflections when using $reflectonlymarkedentities in water material.
EnableDrawInFastReflection  (New with Portal 2)
Turn on rendering of this entity in reflections when using $reflectonlymarkedentities in water material.

RenderFields:

Alpha  <integer>
Set the sprite's alpha (0 - 255).
Color  <color255>
Set the sprite's color (R G B).

Outputs

BasePropPhysics:

OnMotionEnabled
Motion has been enabled on the prop, either via the "Health Level to Override Motion" keyvalue or from the EnableMotion input.
OnAwakened
The prop has woken (force has been applied to it while it was asleep, or the wake input has been called).
OnPhysGunOnlyPickup
Player has picked the prop up with the Gravity Gun.
OnPlayerPickup
Player has picked the prop up with +USE or the Gravity Gun.
OnPhysGunDrop
Player has dropped the prop (from either hands or Gravity Gun). (activator is the player)
OnPlayerUse
Player has +USEd the prop. (activator is the player)
Note:This output will fire only if the "Generate output on +USE" spawnflag is set.
OnOutOfWorld (New with Source 2007)
Not in a leaf?
OnHealthChanged (New with Source 2007)
OnTakeDamage (New with Source 2007)
Prop's health has changed
OnHitByTank (New with Left 4 Dead 2)
Prop has been punched by a Tank boss infected.
OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  

(New with Left 4 Dead)

This Output fires when the entity is killed and removed from the game.