Func occluder: Difference between revisions
Jump to navigation
Jump to search
m (Fix keyvalue format) |
(Added images.) |
||
| Line 1: | Line 1: | ||
[[File:Occlusion example.jpg|350px|thumb|Green boxes represent occluded props, red boxes unoccluded ones.]] | [[File:Occlusion example.jpg|350px|thumb|Green boxes represent occluded props, red boxes unoccluded ones.]] | ||
[[File:Toolsoccluder.gif|left|link=]] | |||
{{base brush|func_occluder}} | {{base brush|func_occluder}} | ||
{{clr-left}} | |||
==Entity description== | ==Entity description== | ||
It hides [[model]]s 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_areaportal]]s or [[world brush]]es are unsuitable. Calculations of model visibility ingame 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. | It hides [[model]]s 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_areaportal]]s or [[world brush]]es are unsuitable. Calculations of model visibility ingame 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. | ||
| Line 10: | Line 10: | ||
== Usage == | == Usage == | ||
{| class=wikitable style="float:right; text-align:center" | |||
! Texture on a func_occluder !! Effect of that face | |||
|- | |||
| [[File:Toolsoccluder.gif|link=tool textures#occluder]] [[File:Toolstrigger.gif|link=tool textures#trigger]] || Occlude | |||
|- | |||
| [[File:Toolsnodraw.gif|link=nodraw]] || Don't Occlude | |||
|} | |||
===Texturing=== | ===Texturing=== | ||
This entity works according to how materials has been applied to it: | This entity works according to how materials has been applied to it: | ||
* All sides covered with the '''[[tool textures# | * All sides covered with the '''[[tool textures#occluder|occluder]]''' or '''[[tool textures#trigger|trigger]]''' materials will occlude. | ||
* All sides covered with the '''[[ | * All sides covered with the '''[[nodraw]]''' material will not occlude. | ||
===Occluders and Areaportals=== | ===Occluders and Areaportals=== | ||
Revision as of 21:52, 21 January 2022
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 ingame 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.
Usage
| Texture on a func_occluder | Effect of that face |
|---|---|
 |
Occlude |
 |
Don't Occlude |
Texturing
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.
Debugging commands
r_occlusion- Activate/deactivate the occlusion system.
r_visocclusion- Activate/deactivate wireframe rendering of what the occlusion system is doing.
r_drawpixelvisibility- Show the occlusion proxies
r_occludeemaxarea- Prevents occlusion testing for entities that take up more than X% of the screen. 0 means use whatever the level said to use.
r_occluderminarea- Prevents this occluder from being used if it takes up less than X% of the screen. 0 means use whatever the level said to use.
r_occlusionspew- Activate/deactivates spew about what the occlusion system is doing.
r_occludermincount- At least this many occluders will be used, no matter how big they are.
Keyvalues
- Initial State (StartActive) <choices>
- If the entity starts inactive, use the
ActivateorToggleinputs to turn it on. Default value is 1- 0: Inactive
- 1: Active
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
Inputs
ActivateDeactivateToggle- Control the state of the occluder.