This article's documentation is for anything that uses the Source engine. Click here for more information.

env_dof_controller

From Valve Developer Community
Jump to: navigation, search
English (en)中文 (zh)
... Icon-Important.png
class hierarchy
CEnvDOFController defined in env_dof_controller.cpp
CPointEntity
CBaseEntity
Env dof controller.png

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

Keyvalues

Enabled (enabled) <boolean> (in all games since Alien Swarm)
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 Alien Swarm)
Distance that the blurriness is at its peak near the viewpoint.
Near focus depth (near_focus) <float> (in all games since Alien Swarm)
Distance that the focus is in full effect near the viewpoint.
Near blur radius (near_radius) <float> (in all games since Alien Swarm)
Radius (in pixels) to blur the surrounding pixels.
Far blur depth (far_blur) <float> (in all games since Alien Swarm)
Distance where blurriness is at its peak far from the viewpoint.
Far focus depth (far_focus) <float> (in all games since Alien Swarm)
Distance that the focus is in full effect far from the viewpoint.
Far blur radius (far_radius) <float> (in all games since Alien Swarm)
Radius (in pixels) to blur the surrounding pixels.
Focus target (focus_target) <targetname> (in all games since Alien Swarm)
Entity to use as a focal point.
Focus target range (focus_range) <float> (in all games since Alien Swarm)
Distance behind the focal plane to remain in focus.

Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.

Inputs

SetNearBlurDepth <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 <float>
The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far focus depth.
SetFarFocusDepth <float>
The area between the near focus and far focus distances is perfectly in focus. Must be smaller than the far blur depth.
SetFarBlurDepth <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 <float>
Set the blur radius (in pixels) to use at the near blur distance. Set to 0 to disable near blur.
SetFarBlurRadius <float>
Set the blur radius (in pixels) to use at the far blur distance. Set to 0 to disable far blur.
SetFocusTarget <string> (in all games since Alien Swarm)
Set the focal target for the effect.
SetFocusTargetRange <float> (in all games since Alien Swarm)
Set the distance behind the focal point that will remain in focus.