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


From Valve Developer Community
Jump to: navigation, search
English (en)
... Icon-Important.png
Green boxes represent occluded props, red boxes unoccluded ones.

func_occluder is a brush entity available in all Source Source games.

class hierarchy
CFuncOccluder defined in func_occluder.cpp

Entity Description

It hides models that are entirely covered by it in the player's view, according to how it has been textured. They are used to control visibility in places where func_areaportals or world brushes are unsuitable. Calculations of model visibility in-game is done in real time and is not in the final compile process. Use func_occluders wisely, because they do calculations in real time and can cost a lot of CPU if there are too many in a map.

Occluders are very useful in cases where you have reasonably large func_detail, prop, func_brush, or displacement walls. These walls do not cut visleaves and therefore will not stop props from rendering behind these walls. Adding an occluder inside the same wall will at the very least hide all props behind the brush entity walls.

Usually, all faces of a func_occluder are Nodraw or Skip (as seen in Counter-Strike: Global Offensive Counter-Strike: Global Offensive maps), with the occluding faces using the Occluder or Trigger texture.
The occlusion will only work if the player is looking at the side that has the occluding texture "visible." If the back side is Nodraw, the occlusion will not take place if looked at from the other side.


Texture on a func_occluder Effect of that face
Toolsoccluder.gif Toolstrigger.gif Occlude
Toolsnodraw.gif Don't Occlude


This entity works according to how materials has been applied to it:

  • All sides covered with the Occluder or Trigger materials will occlude.
  • All sides covered with the Nodraw material will not occlude.

Occluders and Areaportals

There are several important differences between occluders and areaportals:

  • An occluder only hides props, not world geometery or static brushes.
  • An occluder does not split visleaves.
  • An occluder can be free standing and does not need to separate two areas.
Note.pngNote:VBSP will display a warning saying Occluder "" straddles multiple areas. This is invalid! if the func_occluder is not fully enclosed in world geometry. This warning can be ignored if you intend to occlude models that may still be visible otherwise, and will not affect functionality.

Debugging Commands

Activate/deactivate the occlusion system.
Activate/deactivate wireframe rendering of what the occlusion system is doing.
Show the occlusion proxies
Prevents occlusion testing for entities that take up more than X% of the screen. 0 means use whatever the level said to use.
Prevents occlusion testing for entities that take up less than X% of the screen. 0 means use whatever the level said to use.
Activate/deactivates spew about what the occlusion system is doing.
At least this many occluders will be used, no matter how big they are.


Name (targetname) <string>
The targetname that other entities refer to this entity by.
Initial State (StartActive) <choices>
If the entity starts inactive, use the Activate or Toggle inputs to turn it on. Default value is 1.
  • 0: Inactive
  • 1: Active


Control the state of the occluder.

External links