infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Components
EnvShake
chevron_left Components
class
EnvShake

Constructors

functionsEnvShake

Properties

data_objectAmplitudedata_objectDurationdata_objectFrequencydata_objectGlobalShakedata_objectLoopdata_objectOndata_objectRadiusdata_objectRumbledata_objectScaledata_objectShakePhysicsdata_objectShakeView

Methods

functionsStartShakefunctionsStopShake
EnvShake
Shakes players' screens - and optionally physics objects - around a point. Half-Life's env_shake. Call Sandbox.Mapping.EnvShake.StartShake to set it off on every player, and it runs a Sandbox.Mapping.EnvShake.Duration second cycle, the curves shaping it over that time. Sandbox.Mapping.EnvShake.Loop repeats the cycle until turned off.
class Sandbox.Mapping .account_tree extends Component
sealedSandbox.Engine

build Constructors 1

EnvShake ()

data_object Properties 11

Amplitude
ParticleFloat
How far the view gets thrown over the cycle, in world units.
Duration
float
Seconds one shake cycle lasts - the curves play out over this.
Frequency
ParticleFloat
Direction changes per second over the cycle - low is a slow lurch, high is a violent tremble.
GlobalShake
bool
Shake every player in the scene at full strength, no matter where they are.
Loop
bool
Restart the cycle when it ends, shaking until turned off.
On
bool
Is the shake running? Local to this machine - map-placed shakes start everywhere because the scene ships with it set, but toggling it at runtime only affects this peer. Use Sandbox.Mapping.EnvShake.StartShake/Sandbox.Mapping.EnvShake.StopShake to run one on every player. A non-looping shake turns itself off when its cycle ends.
Radius
float
How far the shake reaches, fading to nothing at the edge. The view ignores this when Sandbox.Mapping.EnvShake.GlobalShake is set - physics always uses it.
Rumble
bool
Rumble controllers along with the shake.
Scale
ParticleFloat
Overall strength over the cycle - fade the whole shake in or out without retuning the others.
ShakePhysics
bool
Throw physics objects around within Sandbox.Mapping.EnvShake.Radius while shaking.
ShakeView
bool
Shake the view. Turn off for a physics-only shake.

functions Methods 2

StartShake ()
Set the shake off on everyone, restarting the cycle if it's already running.
StopShake ()
Stop a running shake on everyone.

Inheritance

Component
EnvShake
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.