Prop dynamic

Template:Base point It is used to add a model to the world that can animate itself.

Note:This entity may also use the deprecated dynamic_prop for the classname, and is used in beta Half-Life 2 maps.

Note:Dynamic props use origin lighting. How much lighting the entire prop has is determined by how much lighting the origin has. This can look odd on large props.

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.

In code, it is represented by theCDynamicPropclass, defined in theprops.cppfile.

Uses

• Buttons can be created by enveloping a prop_dynamic inside an invisible func_button brush, then using the SetAnimation input to play a switching animation.
• Similarly, levers can be created by enveloping a prop_dynamic inside a func_rot_button (or momentary_rot_button) brush. No animation needed for this - the brush will rotate the prop by itself.
• A prop_dynamic can be configured to break apart after receiving damage or on cue by using the Break input.
  Bug:Health set inside the model will override health set in Hammer!  [todo tested in ?]

Keyvalues

CDynamicProp:

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_IDLE if they exist.

Ignore NPC Collisions (IgnoreNPCCollisions) <choices> (only in )

Disable collisions for NPCs if yes.

• 0: No
• 1: Yes

Min Random Anim Time (MinAnimTime) <float>

Minimum time between random animations.

Max Random Anim Time (MaxAnimTime) <float>

Maximum time between random animations.

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 (^[confirm] As in become non-solid?), and the model will not be able to ragdoll anymore.

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.

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 .lua files of those tools. This also includes the context menu properties!

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

Non-Valve games

Enable Explosion Override (explosion_override) <choices> (only in ) !FGD Enable/disable explosion parameters override (explosion_particle, explosion_particle_liquid, explosion_attachment, explosion_soundscript and explosion_soundscript_liquid). 0: No 1: Yes Explosion Particle (explosion_particle) <string> (only in ) !FGD A particle system to use when this entity explodes. Explosion Particle Underwater (explosion_particle_liquid) <string> (only in ) !FGD A particle system to use when this entity explodes in water. Explosion Attachment Point (explosion_attachment) <string> (only in ) !FGD An attachment point to use for custom explosion particle system. Note:Only for model entities, even despite the fact that this is also present in brush entities. Explosion Sound Script (explosion_soundscript) <sound> (only in ) !FGD A sound script to use when this entity explodes. Explosion Sound Script Underwater (explosion_soundscript_liquid) <sound> (only in ) !FGD A sound script to use when this entity explodes in water. Important:Both explosion_soundscript and explosion_soundscript_liquid require a sound script, a raw sound file will not work.

Note:Content moved to Rendering and studio model related KIO/Keyvalues for continuation of page history

Flags

CDynamicProp:

Use Hitboxes for Renderbox : [64]

No VPhysics : [128] !FGD

Start with collision disabled : [256]

Inputs

CDynamicProp:

SetAnimation <stringRedirectInput/string>

Forces the prop to play the named animation.

SetDefaultAnimation <stringRedirectInput/string>

Changes the animation played when not in a random/forced sequence.

SetPlaybackRate <floatRedirectInput/float>

Sets the framerate at which animations are played.

TurnOff

Hides the prop through EF_NODRAW. The Disable input does the exact same thing.

TurnOn

Shows the prop (by removing EF_NODRAW). The Enable input does the exact same thing.

DisableCollision

Tells the prop to no longer be solid.

EnableCollision

Tells the prop to become solid again.

SetAnimationNoReset <stringRedirectInput/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.

BreakableProp:

Break

Breaks the breakable.

SetHealth <integerRedirectInput/integer>

Sets a new value for the breakable's health. If the breakable's health reaches zero it will break.

AddHealth <integerRedirectInput/integer>

Adds health to the breakable.

RemoveHealth <integerRedirectInput/integer>

Removes health from the breakable.

physdamagescale <floatRedirectInput/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.

Note:Content moved to Rendering and studio model related KIO/Inputs for continuation of page history

Outputs

CDynamicProp:

OnAnimationBegun

Fired when an animation begins.

OnAnimationDone

Fired when an animation finishes.

BreakableProp:

OnBreak

!activator = entity that breaks the object
!caller = this entity
Fired when this object breaks.

OnHealthChanged <floatRedirectOutput/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 its ACT_PHYSCANNON_ANIMATE_PRE activity. Caused by the object being picked up by the gravity gun.

OnPhysCannonAnimatePullStarted

!activator = none
!caller = this entity
Fired when prop has started its ACT_PHYSCANNON_ANIMATE activity. ACT_PHYSCANNON_ANIMATE_PRE plays once, then ACT_PHYSCANNON_ANIMATE starts looping.

OnPhysCannonDetach

!activator = none
!caller = this entity
Fired when prop has started its ACT_PHYSCANNON_DETACH activity (caused by the gravity gun ripping it from a wall).

OnPhysCannonAnimatePostStarted

!activator = none
!caller = this entity
Fired when prop has started its ACT_PHYSCANNON_ANIMATE_POST activity (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.

Note:Content moved to Rendering and studio model related KIO/Outputs for continuation of page history

See also

• Prop Types Overview