Prop dynamic: Difference between revisions
Jump to navigation
Jump to search
Tip:If your model is never going to move and/or requires more detailed lighting, consider using prop_static (which is cheaper).
Note:To enforce consistency, models with embedded physics data cannot by default be used by
Bug:Scaling a prop_dynamic disables its physics collisions. (tested in: 
)
AltNames: This entity is also tied to
ChiacDomva (talk | contribs) m (alelcnada) |
(Scaled props lose physics in gmod -- bug. Would be better to write it under the model scale KV, but since it's a template, gotta write it in the beginning...) |
||
| (75 intermediate revisions by 27 users not shown) | |||
| Line 1: | Line 1: | ||
{{LanguageBar}} | |||
{{CD|CDynamicProp|file1=props.cpp}} | |||
{{this is a|model entity|name=prop_dynamic}} It is used to add a [[model]] to the world that can [[Skeletal animation|animate]] itself. | |||
{{tip|If your model is never going to move and/or requires more detailed lighting, consider using {{ent|prop_static}} (which is [[cheap]]er).}} | |||
{{note|To enforce consistency, models with [[prop_data|embedded physics data]] cannot by default be used by <code>prop_dynamic</code>. Use the Hammer model browser's [[:Image:Model_info.gif|Info tab]] to check for support. If you intend to use a physics model in non-physics role, use {{ent|prop_dynamic_override}}.}} | |||
{{bug|tested={{Gmod}}|Scaling a prop_dynamic disables its physics collisions.}} | |||
{{altnames|name1=dynamic_prop|misc=The classname is always changed to <code>prop_dynamic</code> on spawn.}} | |||
== Uses == | |||
*'''Buttons''' can be created by parenting a <code>prop_dynamic</code> to a {{ent|func_button}} brush. This will cause <code>+use</code> inputs on the prop to be forwarded to the {{ent|func_button}}, which can be placed anywhere in the map (or even outside the map, [[Leak|as long as the origin, if present, is inside]]). The <code>SetAnimation</code> input can then be used to make the prop animate when interacted with. | |||
:* In {{mapbase|2}}, {{ent|prop_interactable|game=Mapbase}} combines these entities, making setup easier. Likewise, {{vtmb|2}} has {{ent|prop_button|game=Vampire The Masquerade - Bloodlines}}. | |||
*Similarly, '''levers''' can be created by parenting a <code>prop_dynamic</code> to a {{ent|func_rot_button}} (or {{ent|momentary_rot_button}}) brush. No animation is needed for this - the brush will rotate the prop by itself. As before, the entity can be placed anywhere, as long as the origin is positioned at the point you want it to rotate around. | |||
*A <code>prop_dynamic</code> can be configured to '''break apart''' after receiving damage or on cue by using the <code>Break</code> input. {{note|Health set [[prop_data|inside the model]] will intentionally override health set in Hammer! Use {{ent|prop_dynamic_override}} instead if this is an issue.}} | |||
== Keyvalues == | |||
{{KV Targetname}} | |||
{{KV|Default Animation|intn=DefaultAnim|string|The animation this prop will play when not doing a random or forced animation.}} | |||
{{KV|Randomly Animate|intn=RandomAnimation|bool|Makes the prop randomly select and play animations at intervals defined by the '''Min/Max Random Anim Time''' KVs. In between the random animations, it will revert to playing '''Default Animation'''.{{note|Will only select from animation [[$sequence]]s linked with <code>ACT_IDLE</code> if they exist.}}}} | |||
{{KV|Min Random Anim Time|intn=MinAnimTime|float|Minimum time between random animations.}} | |||
{{KV|Max Random Anim Time|intn=MaxAnimTime|float|Maximum time between random animations.}} | |||
{{KV|Collisions|intn=solid|integer choices|How the prop should interact with other objects. | |||
:* 0 - Not solid | |||
:* 2 - Use bounding box | |||
:* 6 - Use [[VPhysics]] (default)}} | |||
{{KV|Update children|intn=updatechildren|bool|since={{l4d}}|Update touches for any children that are attached to attachment points as this prop animates. This allows SetParentAttached triggers or func_brushes to touch properly.}} | |||
{{KV|Disable Bone Followers|intn=DisableBoneFollowers|boolean|since={{Source 2009}}|Disables generation of {{ent|phys_bone_follower}}s for each convex piece the model has in its [[collision model]]. <code>phys_bone_follower</code>s can quickly eat up the [[entity limit|edict count]], so this keyvalue can be very helpful in freeing resources. This will however make the collision model no longer function (the model will be nonsolid to anything that uses the collision model instead of the [[hitbox]]{{elaborate}}). No effect on models which use {{cmd|$collisionmodel}} instead of {{cmd|$collisionjoints}}. {{tip|In games where this keyvalue is not available, {{ent|prop_dynamic_override}} with collision set to 'Not solid' can be used.}}}} | |||
{{KV|Hold Animation|intn=HoldAnimation|boolean|since={{AS}}|If set, the prop will not loop its animation, but hold the last frame.}} | |||
{{KV|Animate Every Frame|intn=AnimateEveryFrame|boolean|since={{P2}}|Force this prop to animate every frame. Usually this doesn't need to be touched.}} | |||
{{KV|Ignore NPC Collisions|intn=IgnoreNPCCollisions|choices|Disable collisions for [[NPC|NPCs]] if yes. | |||
:*0: No | |||
:*1: Yes | |||
|only={{bms}}}} | |||
{{KV BaseFadeProp}} | |||
{{KV Rendermode}} | |||
{{KV Render FX}} | |||
{{KV|Render Amount / Transparency (0–255)|intn=renderamt|int 0-255|Transparency amount; requires a Render Mode other than '''Normal'''. 0 is invisible, 255 is fully visible.}} | |||
{{KV|Render Color (R G B)|intn=rendercolor|color255|Color tint.}} | |||
{{KV Glow}} | |||
{{KV BreakableProp}} | |||
{{KV CBaseAnimating|noscroll=1|no sequence=1}} | |||
{{KV GMOD}} | |||
==Flags== | |||
{{minititle|DynamicProp}} | |||
{{Fl|64|Use Hitboxes for Renderbox|{{elaborate}}}} | |||
{{Fl|128|Disable [[VPhysics]] collision|nofgd=1}} | |||
{{Fl|256|Start with collision disabled}} | |||
{{Fl BreakableProp}} | |||
==Inputs== | |||
{{I|SetAnimation|param=string|Forces the prop to play the named animation immediately.}} | |||
{{I|SetDefaultAnimation|param=string|Changes the animation played when not in a random/forced sequence. New default animations begin when the previous playing animation has ended.}} | |||
== | {{I|SetPlaybackRate|param=float|Sets the framerate at which animations are played.}} | ||
{{I|TurnOff|Hides the prop through {{ent|EF_NODRAW}}. The <code>Disable</code> input does the exact same thing.}} | |||
{{I|TurnOn|Shows the prop (by removing {{ent|EF_NODRAW}}). The <code>Enable</code> input does the exact same thing.}} | |||
{{I|DisableCollision|Tells the prop to no longer be solid.}} | |||
{{I|EnableCollision|Tells the prop to become solid again.}} | |||
{{I|SetAnimationNoReset|param=string|since=AS|Force the prop to play an animation unless the prop is already playing the animation. The parameter should be the name of the animation.}} | |||
{{I|FadeAndKill|since={{P2}}|Fade out then remove this prop.}} | |||
{{I Glow}} | |||
{{I BreakableProp}} | |||
| | |||
| | |||
| | |||
| | |||
| | |||
| | |||
== | ==Outputs== | ||
{{O|OnAnimationBegun|activator = none|Fired when an animation begins.}} | |||
{{O|OnAnimationDone|activator = none|Fired when an animation finishes.}} | |||
{{O Breakable|prop=1}} | |||
== | ==See also== | ||
*{{ | * [[Prop Types Overview]] | ||
*{{ | * {{ent|prop_dynamic_ornament}} | ||
*{{ | * {{ent|prop_dynamic_override}} | ||
* {{ent|prop_physics}} | |||
[[Category:Prop entities|dynamic]] | |||
: | |||
Latest revision as of 15:33, 22 October 2025
 Class hierarchy
|
|---|
| CDynamicProp |
| props.cpp
|
prop_dynamic is a model entity available in all 
Source games. It is used to add a model to the world that can animate itself.
Tip:If your model is never going to move and/or requires more detailed lighting, consider using prop_static (which is cheaper).Note:To enforce consistency, models with embedded physics data cannot by default be used by prop_dynamic. Use the Hammer model browser's Info tab to check for support. If you intend to use a physics model in non-physics role, use prop_dynamic_override.
Bug:Scaling a prop_dynamic disables its physics collisions. (tested in: )AltNames: This entity is also tied to dynamic_prop. The classname is always changed to prop_dynamic on spawn. Uses
- Buttons can be created by parenting a
prop_dynamicto a func_button brush. This will cause+useinputs on the prop to be forwarded to the func_button, which can be placed anywhere in the map (or even outside the map, as long as the origin, if present, is inside). TheSetAnimationinput can then be used to make the prop animate when interacted with.
- In
Mapbase, prop_interactable combines these entities, making setup easier. Likewise, 
Vampire: The Masquerade – Bloodlines has prop_button.
- In
- Similarly, levers can be created by parenting a
prop_dynamicto a func_rot_button (or momentary_rot_button) brush. No animation is needed for this - the brush will rotate the prop by itself. As before, the entity can be placed anywhere, as long as the origin is positioned at the point you want it to rotate around. - A
prop_dynamiccan be configured to break apart after receiving damage or on cue by using theBreakinput.Note:Health set inside the model will intentionally override health set in Hammer! Use prop_dynamic_override instead if this is an issue.
Keyvalues
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report. - See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Default Animation (DefaultAnim) <string>
- The animation this prop will play when not doing a random or forced animation.
- Randomly Animate (RandomAnimation) <boolean>
- Makes the prop randomly select and play animations at intervals defined by the Min/Max Random Anim Time KVs. In between the random animations, it will revert to playing Default Animation.Note:Will only select from animation $sequences linked with
ACT_IDLEif they exist.
- Min Random Anim Time (MinAnimTime) <float>
- Minimum time between random animations.
- Max Random Anim Time (MaxAnimTime) <float>
- Maximum time between random animations.
- Collisions (solid) <integer choices>
- How the prop should interact with other objects.
- 0 - Not solid
- 2 - Use bounding box
- 6 - Use VPhysics (default)
- Update children (updatechildren) <boolean> (in all games since
) - Update touches for any children that are attached to attachment points as this prop animates. This allows SetParentAttached triggers or func_brushes to touch properly.
- Disable Bone Followers (DisableBoneFollowers) <boolean> (in all games since
) - Disables generation of phys_bone_followers for each convex piece the model has in its collision model.
phys_bone_followers can quickly eat up the edict count, so this keyvalue can be very helpful in freeing resources. This will however make the collision model no longer function (the model will be nonsolid to anything that uses the collision model instead of the hitbox[Elaborate?]). No effect on models which use$collisionmodelinstead of$collisionjoints.Tip:In games where this keyvalue is not available, prop_dynamic_override with collision set to 'Not solid' can be used.
- Hold Animation (HoldAnimation) <boolean> (in all games since
) - If set, the prop will not loop its animation, but hold the last frame.
- Animate Every Frame (AnimateEveryFrame) <boolean> (in all games since
) - Force this prop to animate every frame. Usually this doesn't need to be touched.
- Ignore NPC Collisions (IgnoreNPCCollisions) <choices> (only in
) - Disable collisions for NPCs if yes.
- 0: No
- 1: Yes
BaseFadeProp:
- Start Fade Dist (fademindist) <float>
- Distance at which the entity starts to fade.
- End Fade Dist (fademaxdist) <float>
- Max fade distance at which the entity is visible.
- If start fade is <0, the entity will disappear instantly when end fade is hit.
- If end fade is <0, the entity won't disappear at all. (This is the default behavior.)
- The values will scale appropriately if the entity is in a 3D Skybox.
- Fade Scale (fadescale) <float>
- If you specify so in worldspawn, or if the engine is running below DirectX 8 (DX7 in
), 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, while those 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.
- Render Mode (rendermode) <byte choices>
- Set a non-standard rendering mode on this entity.
Render Modes - 0: Normal
- 1: Color
- 2: Texture
- 3: Glow
- 4: Solid/Alphatest
- 5: Additive
- 6: Removed, does nothing
- 7: Additive Fractional Frame
- 8: Alpha Add
- 9: World Space Glow
- 10: Don't Render
- Render FX (renderfx) <byte choices>
- Various somewhat legacy alpha effects. See render effects.
- Render Amount / Transparency (0–255) (renderamt) <integer 0–255>
- Transparency amount; requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
- Render Color (R G B) (rendercolor) <color255>
- Color tint.
Glow:
- Glow State (glowstate) <choices> (only in
) -
- OFF
- +use
- look-at
- ON
- Glow Range (glowrange) <integer> (only in )
- Range at which the glow becomes visible on approach. 0 means always visible.
- Glow Range Min (glowrangemin) <integer> (only in )
- Inner range at which the glow stops being visible on approach. 0 means always visible.
- Glow Color Override (R G B) (glowcolor) <color255> (only in )
- Change the render color of the glow.
BreakableProp:
- Explosion Damage (ExplodeDamage) <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 (ExplodeRadius) <float>
- If non-zero, when this entity breaks it will create an explosion with a radius of the specified amount. See also Explosion Damage.
- Sound to make when punted (puntsound) <sound> (in all games since
) - Sound to make when punted by gravity gun.
- Break Model Message (BreakModelMessage) <string> (only in
) - "If set, will use this break model message instead of the normal break behavior."
Breakable (common):
- Performance Mode (PerformanceMode) <choices>
- Used to limit the amount of gibs produced when this entity breaks, for performance reasons.
Choices - 0: Normal
- 1: No Gibs
- 2: Full Gibs on All Platforms (Xbox 360, PS3, etc)
- 3: Reduced gibs
- Min Damage to Hurt (minhealthdmg) <integer>
- If a single hit to the object doesn't do at least this much damage, the prop won't take any of the damage it attempted to give.
- Pressure Delay (PressureDelay) <float>
- Seconds to delay breaking from pressure. Allows creaking/groaning sounds to play.
- Health (health) <integer>
- How close to breaking the object is.
- Maximum Health (max_health) <integer>
- Health cannot exceed this amount.
- Physics Impact Damage Scale (physdamagescale) <float>
- Multiplier for damage amount when this entity is hit by a physics object. With a value of 0 the entity will take no damage from physics.
- Breakable By (BreakableType) <choices> (only in )
Who can break this? - 0: Everyone
- 1: All Infected
- 2: Only Tanks
Note:Only for model entities, even despite the fact that this is also present in brush entities.
 Important:Both explosion_soundscript and explosion_soundscript_liquid require a sound script, a raw sound file will not work. |
- World Model (model) <model path>
- The model this entity should appear as. 128-character limit.
- Skin (skin) <integer>
- Some models have multiple skins. This value selects from the index, starting with 0. May be overridden by game code. Tip:Hammer's model browser automatically updates this value if you use it to view different skins.
- Model Scale (modelscale) <float> (in all games since ) (also in )
- A multiplier for the size of the model.
- Tip:In
Hammer++ with a prop selected in 3D view, hold Ctrl and scroll the mouse wheel to change the modelscale in increments of 0.5. Holding ⇧ Shift will scale it in smaller increments of 0.05.
- Bodygroup (body / SetBodyGroup) <integer>
- Some models have multiple submodels. This value selects from the index, starting with 0. May be overridden by animations and/or game code. Note:If both
bodyandSetBodyGroupare present (even if set to 0),bodywill be prioritized.
- Lighting Origin (lightingorigin) <targetname>
- Select an entity (not info_lighting!) from which to sample lighting and cubemaps instead of the entity's $illumposition.
Shadow:
- Disable Shadows (disableshadows) <boolean>
- Prevents the entity from creating cheap render-to-texture shadows, or lightmap shadows if the entity is a prop_static. Does not affect shadow mapping.
- Disable Receiving Shadows (disablereceiveshadows) <boolean>
- Prevent the entity from receiving dynamic shadows on itself.
- Shadow Cast Distance (shadowcastdist) <integer> !FGD
- Sets how far the entity casts dynamic shadows. 0 means default distance from the shadow_control entity.
- Disable Shadow Depth (disableshadowdepth) <boolean> (in all games since )
- Used to disable rendering into shadow depth (for projected textures) for this entity.
- Disable flashlight (disableflashlight) <boolean> (in all games since )
- Used to disable projected texture lighting and shadows on this entity.
- Projected Texture Cache (shadowdepthnocache) <integer choices> (in all games since )
- 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.
Choices - 0 : Default
- 1 : No cache - render every frame
- 2 : Cache it - render only once
- Render in Fast Reflections (drawinfastreflection) <boolean> (in all games since )
- If enabled, this entity will render in fast water reflections (i.e. when a water material specifies
$reflectonlymarkedentities) and in the world impostor pass.
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
.luafiles of those tools. This also includes the context menu properties!
Flags
DynamicProp:
- Use Hitboxes for Renderbox : [64]
- [Elaborate?]
- Start with collision disabled : [256]
BreakableProp:
- Break on Touch : [16]
- Break on Pressure : [32]
- Will break after being stood on for
PressureDelayseconds.Note:Some models will break instantly if this is or isn't set. (e.g. militiawindow02_breakable.mdl,window_industrial.mdl)
Inputs
- SetAnimation <string>
- Forces the prop to play the named animation immediately.
- SetDefaultAnimation <string>
- Changes the animation played when not in a random/forced sequence. New default animations begin when the previous playing animation has ended.
- SetPlaybackRate <float>
- Sets the framerate at which animations are played.
- TurnOff
- Hides the prop through EF_NODRAW. The
Disableinput does the exact same thing.
- TurnOn
- Shows the prop (by removing EF_NODRAW). The
Enableinput does the exact same thing.
- DisableCollision
- Tells the prop to no longer be solid.
- EnableCollision
- Tells the prop to become solid again.
- SetAnimationNoReset <string> (in all games since )
- Force the prop to play an animation unless the prop is already playing the animation. The parameter should be the name of the animation.
- FadeAndKill (in all games since )
- Fade out then remove this prop.
Glow:
- StartGlowing (only in )
- Turn on glow effect for this prop.
- StopGlowing (only in )
- Turn off this prop's glow effect.
BreakableProp:
- 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.
- RemoveHealth <integer>
- Removes health from the breakable.
- physdamagescale <float>
- Sets Physics Impact Damage Scale. 0 means this feature is disabled for backwards compatibility.
- 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.
- EnablePuntSound (in all games since )
- Allow this prop from playing its Punt Sound sound when punted by the gravity gun.
- DisablePuntSound (in all games since )
- Prevent this prop from playing its Punt Sound sound when punted by the gravity gun.
Outputs
- OnAnimationBegun
- !activator = none
!caller = this entity
Fired when an animation begins.
- OnAnimationDone
- !activator = none
!caller = this entity
Fired when an animation finishes.
BreakableProp:
- OnBreak
- !activator = entity that breaks the object
!caller = this entity
Fired when this object breaks.
- OnHealthChanged <float>
- !activator = entity that caused the health change
!caller = this entity
Fired whenever the health of the breakable has increased or decreased. This output automatically puts the new health amount as a decimal percent (e.g. 45% = 0.45) into the parameter box for inputs, if the mapper does not override the parameter with something else. - OnTakeDamage
- !activator = entity that caused the damage
!caller = this entity
Fired when damage is taken. - OnPhysCannonAnimatePreStarted
- !activator = none
!caller = this entity
Fired when prop starts itsACT_PHYSCANNON_ANIMATE_PREactivity. Caused by the object being picked up by the gravity gun.
- OnPhysCannonAnimatePullStarted
- !activator = none
!caller = this entity
Fired when prop has started itsACT_PHYSCANNON_ANIMATEactivity.ACT_PHYSCANNON_ANIMATE_PREplays once, thenACT_PHYSCANNON_ANIMATEstarts looping.
- OnPhysCannonDetach
- !activator = none
!caller = this entity
Fired when prop has started itsACT_PHYSCANNON_DETACHactivity (caused by the gravity gun ripping it from a wall).
- OnPhysCannonAnimatePostStarted
- !activator = none
!caller = this entity
Fired when prop has started itsACT_PHYSCANNON_ANIMATE_POSTactivity (caused by the player letting the prop go from the gravity gun).
- OnPhysCannonPullAnimFinished
- !activator = none
!caller = this entity
Fired when prop has finished all gravity gun-related animations.