Skip to main content

env_volumetric_fog_controller

Point Entity

Controller for volumetric fogging - bounds are extents of fog irradiance volume (for indirect)

Keyvalues

  • Start Disabled (StartDisabled) <Boolean>

  • Parent (parentname) <TargetDestination>
    The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.

  • Parent Model Bone/Attachment Name (parentAttachmentName) <ParentAttachment>
    The name of the bone or attachment to attach to on the entity's parent in the movement hierarchy. Use !bonemerge to use bone-merge style attachment.

  • Model Attachment position offset (local.origin) <Vector>
    Offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Model Attachment angular offset (local.angles) <Angle>
    Angular offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Model Attachment scale (local.scales) <Vector>
    Scale in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Use Model Attachment Offset (useLocalOffset) <Boolean>
    Whether to respect the specified local offset when doing the initial hierarchical attachment to its parent.

  • 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.

  • Master Fog Controller (IsMaster) <Boolean>
    Use this as the active fog if there are more than one

  • Fog strength (FogStrength) <Float>
    Technically the scattering value. Higher values make denser fog.

  • Draw distance (DrawDistance) <Float>
    Maximum distance to draw fog - WARNING! Changing from default will make fog blockier.

  • Fade-in start (FadeInStart) <Float>
    Distance from the eye at which fog starts to fade in.

  • Fade-in end (FadeInEnd) <Float>
    Distance from the eye at which fog finishes fading in and is at full strength.

  • Enable indirect lighting (IndirectEnabled) <Boolean>

  • Indirect light strength (IndirectStrength) <Float>

  • Indirect Lighting Dimension (IndirectVoxelDim) <Choices>

    • Very High Resolution (512x)
    • High Resolution (256x)
    • Medium Resolution (128x)
    • Low Resolution (64x)

  • Fade time (FadeSpeed) <Float>
    Sets fade in or out time (in seconds).

  • Anisotropy (Anisotropy) <Float>
    How much the fog should get brighter when you stare directly at the light.

  • Fog Irradiance Texture (fogirradiancevolume) <Resource>
    Name of the fog irradiance texture

Inputs

  • Enable <Void>
    Enable this entity.

  • Disable <Void>
    Disable this entity.

  • SetParent <TargetDestination>
    Changes the entity's parent in the movement hierarchy.

  • SetParentAttachment <String>
    Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

  • SetParentAttachmentMaintainOffset <String>
    Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.

  • ClearParent <Void>
    Removes this entity from the the movement hierarchy, leaving it free to move independently.

  • 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.

  • 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.

  • SetToDefaults <Void>
    Resets scattering and anisotropy to default values

  • SetFogStrength <Float>
    Set overall fog strength

  • SetAnisotropy <Float>
    Set anisotropy value

  • SetFadeSpeed <Float>
    Set fade in/out speed

  • SetDrawDistance <Float>
    Set draw distance

  • ForceRefresh <Void>
    Forces the fog volume to update if a light's state has changed

  • EnableIndirect <Boolean>
    Turns on/off indirect fogging

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.