Skip to main content

env_fog_controller

env_fog_controller icon

Point Entity

An entity that controls the fog and view distance in the map.

Keyvalues

  • Entity Scripts (vscripts) <ScriptList>
    Name(s) of script files that are executed after all entities have spawned.

  • Name (targetname) <TargetSource>
    The name that other entities refer to this entity by.

  • Fog Enable (fogenable) <Boolean>

  • Fog Blend (fogblend) <Boolean>

  • Use Angles for Fog Dir (use_angles) <Boolean>

  • Primary Fog Color (fogcolor) <Color255>

  • Secondary Fog Color (fogcolor2) <Color255>

  • Primary Fog Direction (fogdir) <String>

  • Fog Start (fogstart) <String>

  • Fog End (fogend) <String>

  • Fog Max Density [0..1] (fogmaxdensity) <Float>

  • Fog Exponent [0..1] (fogexponent) <Float>

  • Interpolate time (foglerptime) <Float>

  • Far Z Clip Plane (farz) <String>

  • HDR color scale. (HDRColorScale) <Float>
    float value to multiply fog color by when running in HDR mode.

  • Spawnflags (spawnflags) <Flags>

    • Master (Has priority if multiple env_fog_controllers exist) (1)

Inputs

  • RunScriptFile <String>
    Load and execute a script file

  • RunScriptCode <String>
    Execute a fragment of script code

  • CallScriptFunction <String>
    Call a script function

  • CallPrivateScriptFunction <String>
    Calls a script function from this entity's private script scope.

  • CallGlobalScriptFunction <String>
    Calls a script function in the global script scope.

  • Kill <Void>
    Removes this entity from the world.

  • KillHierarchy <Void>
    Removes this entity and all its children from the world.

  • KillConstrained <Void>
    Removes this entity, all its children, and anything constrained to it, from the world.

  • AddOutput <String>
    Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care.

  • FireUser1 <Void>
    Causes this entity's OnUser1 output to be fired.

  • FireUser2 <Void>
    Causes this entity's OnUser2 output to be fired.

  • FireUser3 <Void>
    Causes this entity's OnUser3 output to be fired.

  • FireUser4 <Void>
    Causes this entity's OnUser4 output to be fired.

  • SetStartDist <Float>
    Set the fog start distance.

  • SetEndDist <Float>
    Set the fog end distance.

  • TurnOn <Void>
    Turn the fog on.

  • TurnOff <Void>
    Turn the fog off.

  • SetColor <Color255>
    Set the primary fog color.

  • SetColorSecondary <Color255>
    Set the secondary fog color.

  • SetFarZ <Integer>
    Set the far clip plane distance.

  • SetAngles <String>
    Set the angles to use for the secondary fog direction.

  • Set2DSkyboxFogFactor <Float>
    Set the current amount of fog to blend into the 2D skybox. 0 is no fog, 1 is fully fogged.

  • SetMaxDensity <Float>
    Set the current max fog density.

  • SetColorLerpTo <Color255>
    Set the primary fog color.

  • SetColorSecondaryLerpTo <Color255>
    Set the secondary fog color.

  • SetStartDistLerpTo <Float>
    Set the fog start distance.

  • SetEndDistLerpTo <Float>
    Set the fog end distance.

  • Set2DSkyboxFogFactorLerpTo <Float>
    Set the amount of fog to blend into the 2D skybox to lerp to. 0 is no fog, 1 is fully fogged.

  • SetMaxDensityLerpTo <Float>
    Set the current max density to lerp to. 0 is no fog, 1 is fully fogged.

  • StartFogTransition <Void>
    Start fog transition.

Outputs

  • OnUser1 <Void>
    Fired in response to FireUser1 input.

  • OnUser2 <Void>
    Fired in response to FireUser2 input.

  • OnUser3 <Void>
    Fired in response to FireUser3 input.

  • OnUser4 <Void>
    Fired in response to FireUser4 input.

  • OnKilled <Void>
    Fired when the entity is killed and removed from the game. Parameter is the inflictor.