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
Classes
CameraEffectSystem
chevron_left Classes
class
CameraEffectSystem

Constructors

functionsCameraEffectSystem

Properties

data_objectScale

Methods

functionsAddfunctionsAddPunchfunctionsAddShakefunctionsAddTiltfunctionsClearfunctionsQueryOffsets
CameraEffectSystem
Transient camera effects - screen shakes, punches and tilts. Fire and forget: <c>CameraEffectSystem.Current.AddShake( Scene.Camera, 4, 40, 1 )</c>. The camera folds the combined offsets in when it composes its view each tick - effects never touch the camera's transform or the player's aim, so they can't accumulate or fight the game's camera code.
class Sandbox .account_tree extends GameObjectSystem<T>
sealedSandbox.Engine

build Constructors 1

CameraEffectSystem (scene)

data_object Properties 1

Scale
float
Global multiplier on every camera effect - wire this to a screen shake preference. Zero disables them entirely.

functions Methods 6

Add (effect)
T
Add a camera effect. A null Sandbox.CameraEffectSystem.BaseEffect.Camera applies to every camera.
AddPunch (camera, direction, amplitude, frequency, duration, fovAmplitude)
BaseEffect
A punch along a camera-local direction that oscillates and dies out - Vector3.Up bounces the view upward, scales how often it oscillates before it lapses.
AddShake (camera, amplitude, frequency, duration)
ScreenShake
The classic screen shake (Half-Life's env_shake) - every 1/ seconds a new random offset within world units, settling to nothing over . A duration of zero shakes until Sandbox.CameraEffectSystem.BaseEffect.Stop.
AddTilt (camera, angle, duration, easeTime)
BaseEffect
Tilt the camera by , eased in over and back out before ends.
Clear ()
Remove every active effect.
QueryOffsets (camera, position, angles, fieldOfView)
The combined effect offsets for this camera this frame - the position is camera-local (Vector3.Forward pushes the view forward). The camera reads these once per tick, when it composes its view.

Inheritance

GameObjectSystem
GameObjectSystem<T>
CameraEffectSystem
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.