Env dof controller: Difference between revisions

Revision as of 18:16, 17 May 2024

Class hierarchy
CEnvDOFController ↳CPointEntity ↳CBaseEntity
`env_dof_controller.cpp`

env_dof_controller is a point entity available in all Source games since Left 4 Dead. (also in ) This entity controls the depth of field settings for all players.

Enabled (enabled) <boolean> (in all games since ): Whether the effect should begin active. If it starts inactive, it must be enabled with SetNearBlurRadius or SetFarBlurRadius.

Near blur depth (near_blur) <float> (in all games since ): Distance that the blurriness is at its peak near the viewpoint.

Near focus depth (near_focus) <float> (in all games since ): Distance that the focus is in full effect near the viewpoint.

Near blur radius (near_radius) <float> (in all games since ): Radius (in pixels) to blur the surrounding pixels.

Far blur depth (far_blur) <float> (in all games since ): Distance where blurriness is at its peak far from the viewpoint.

Far focus depth (far_focus) <float> (in all games since ): Distance that the focus is in full effect far from the viewpoint.

Far blur radius (far_radius) <float> (in all games since ): Radius (in pixels) to blur the surrounding pixels.

Focus target (focus_target) <string> (in all games since ): Entity to use as a focal point.

Focus target range (focus_range) <float> (in all games since ): Distance behind the focal plane to remain in focus.

Name (targetname) <string>[ Edit ]: The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report. See also: Generic Keyvalues, Inputs and Outputs available to all entities

SetNearBlurDepth <floatRedirectInput/float>: Set the distance in front of the focus region at which the scene will be completely blurred using the near blur radius. Must be smaller than the near focus death.

SetNearFocusDepth <floatRedirectInput/float>: The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far focus depth.

SetFarFocusDepth <floatRedirectInput/float>: The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far blur depth.

SetFarBlurDepth <floatRedirectInput/float>: Set the distance beyond the focus region at which the scene will be completely blurred using the far blur radius. Must be larger than the far focus depth.

SetNearBlurRadius <floatRedirectInput/float>: Set the blur radius (in pixels) to use at the near blur distance. Set to 0 to disable near blur.

SetFarBlurRadius <floatRedirectInput/float>: Set the blur radius (in pixels) to use at the far blur distance. Set to 0 to disable far blur.

SetFocusTarget <stringRedirectInput/string> (in all games since ): Set the focal target for the effect.

SetFocusTargetRange <floatRedirectInput/float> (in all games since ): Set the distance behind the focal point that will remain in focus.

@@ Line 1: / Line 1: @@
 <!-- When this page is updated to {{langsp}} or {{langsp}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{lang|Env dof controller}}{{CD|CEnvDOFController|file1=env_dof_controller.cpp}}
-[[File:env_dof_controller.png|left|link=]]{{this is a|name=env_dof_controller|e0|since=Left 4 Dead}} {{also|{{mapbase}}}} This entity controls the [[W:depth of field|depth of field]] settings for all players.
+[[File:env_dof_controller.png|left|link=]]{{this is a|point entity|name=env_dof_controller|since=Left 4 Dead}} {{also|{{mapbase}}}} This entity controls the [[W:depth of field|depth of field]] settings for all players.
 {{clr}}