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

Constructors

lockBaseEffect

Properties

data_objectCameradata_objectDurationdata_objectEpicenterlockFractiondata_objectIsDonedata_objectIsInfinitedata_objectRadiusdata_objectTimeAlive

Methods

functionsEvaluatefunctionsScaleForfunctionsStopfunctionsUpdate
BaseEffect
A transient camera effect, living in the Sandbox.CameraEffectSystem. Targets one Sandbox.CameraEffectSystem.BaseEffect.Camera, every camera (null), or radiates from an Sandbox.CameraEffectSystem.BaseEffect.Epicenter with distance falloff. Derive to make your own effects.
class Sandbox.CameraEffectSystem .
abstractSandbox.Engine

build Constructors 1

BaseEffect ()

data_object Properties 8

Camera
CameraComponent
The camera this applies to - null applies to every camera.
Duration
float
Seconds the effect runs. Zero or less runs until Sandbox.CameraEffectSystem.BaseEffect.Stop.
Epicenter
Nullable`1
When set, the effect radiates from this world position - full strength at the epicenter, nothing beyond Sandbox.CameraEffectSystem.BaseEffect.Radius.
Fraction
float
1 at the start of the effect's life falling to 0 at the end. Infinite effects hold 1.
IsDone
bool
True when the effect has expired or been stopped, and is about to be removed. An effect whose target camera has been destroyed is done too.
IsInfinite
bool
Runs until Sandbox.CameraEffectSystem.BaseEffect.Stop rather than expiring.
Radius
float
How far the effect reaches from Sandbox.CameraEffectSystem.BaseEffect.Epicenter.
TimeAlive
float
Seconds this effect has been running.

functions Methods 4

Evaluate (scale, position, angles, fieldOfView)
Accumulate this effect's contribution. is camera-local - Vector3.Forward pushes the view forward, Vector3.Up up.
ScaleFor (camera)
float
How strongly this effect applies to a camera - 0 when it targets a different camera, fading with distance from the Sandbox.CameraEffectSystem.BaseEffect.Epicenter when one is set. Override for custom falloff.
Stop ()
End the effect now.
Update (delta)
Advance the effect - called once a frame by the system.

Inheritance

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