env_shake

GoldSrc

Source Engine

This article needs more  links to other articles to help  integrate it into the encyclopedia. Please help improve this article by adding links  that are relevant to the context within the existing text.
January 2024

Class hierarchy
CEnvShake ↳CPointEntity ↳CBaseEntity
EnvShake.cpp

env_shake is a point entity available in all Source games. When it receives the input StartShake, it shakes the screens of players for some duration. Objects can be jostled as well.

Tip:To get a continuous shake, one can fire the StartShake input at regular intervals, for example using a logic_timer. The continuous shake can then be stopped by disabling the timer.

Note:This can greatly hinder the accuracy of shots fired when the shaking is continuous.

Note:In code, a comment says that UTIL_ScreenShake does not work on airborne players. This is false.

Flags

GlobalShake : [1]

Ignore radius, EVERYTHING shakes.

In Air : [4]

Shake players even if they are in mid-air. Normally, if StartShake is fired while a player is in mid-air, they don't get any shaking at all even if they land before the shaking would end.

Physics : [8]

Shake physics objects, not just the camera.

Ropes : [16]

Shake ropes. This works independently from Physics.

DON'T shake view (for shaking ropes or physics only) : [32]
DON'T Rumble Controller : [64]

Do not shake the controller for players using an Xbox controller, etc.

Keyvalues

Name (targetname) <string>

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

Amplitude (0-16) (amplitude) <float>

How far away from the normal position the camera will wobble and objects move. For camera, should be a range between 0 and 16. For objects, can be set much higher.

Note:With high amplitudes, the player might be able to briefly look through walls that they touch.

Effect Radius (radius) <float>

The radius around this entity in which to affect players.

Note:Players within the effect radius will be affected by the shaking for the set duration, regardless of whether they remain within the radius after the shaking begins. Also, StopShake will only stop any shaking for players within the radius.

Duration (seconds) (duration) <float>

The length of time in which to shake the player's screens.

Frequency (frequency) <float>

How many times per second to change the direction of the camera wobble. 40 is generally enough; values higher are hardly distinguishable.

Inputs

Amplitude <integer>

Sets Amplitude.

Frequency <integer>

Sets Frequency.

StartShake

Start the shake. If a radius is used, it affects only players inside it and the shake amplitude for a player depends on their distance to the shake entity. Multiple shake starts at once do add up.

StopShake

Stop the shake. If a radius is used, it affects only players inside it.