Func areaportalwindow: Difference between revisions
Jump to navigation
Jump to search
Bug:(Known to affect Half Life 2) The
In code, it is represented by the
(map link) |
(updates) |
||
| Line 1: | Line 1: | ||
{{lang|Func areaportalwindow}} | |||
[[File:Hl2 d2 coast 09 areaportalwindows.png|250px|thumb|right|An example of its use on {{ent|d2_coast_09}}{{hl2}}. When the player is close to the window, the entity is inactive and the player can see through the window. When the player backs up, the objects outside are culled from the [[PVS]] and replaced with a hazy low-res texture.]] | [[File:Hl2 d2 coast 09 areaportalwindows.png|250px|thumb|right|An example of its use on {{ent|d2_coast_09}}{{hl2}}. When the player is close to the window, the entity is inactive and the player can see through the window. When the player backs up, the objects outside are culled from the [[PVS]] and replaced with a hazy low-res texture.]] | ||
{{base brush|func_areaportalwindow}} | [[File:Toolsareaportal.gif|link=Areaportal|left]]{{base brush|func_areaportalwindow}} It creates an [[areaportal]] that automatically closes as the camera moves away, fading a second, opaque brush in to fill the gap. | ||
[[File:Areaportalwindow coast12.jpg|180px|thumb|right|caption|A <code>func_areaportal_window</code> that hides interior geometry by turning black at a distance.]] | |||
{{bug|(Known to affect Half Life 2) The <code>dev/dev_window</code> texture has to be on both sides of the brush, combining it with any other texture (except nodraw) will result in rendering glitches (objects popping in and out of the PVS depending on player position and view angle).}} | |||
{{ | {{code class|CFuncAreaPortalWindow|func_areaportalwindow.cpp}} | ||
== Keyvalues == | ==Keyvalues== | ||
{{KV|Rendered Window (target)|targetname|The brush entity that fills the gap left by the portal when closed.}} | |||
{{KV|Fade Start Distance (FadeStartDist)|int|Distance that the fade into the '''Rendered Window''' brush entity begins. The further back the player views, the more visible the brush entity will be.}} | |||
{{KV|Fade End Distance (FadeDist)|int|Distance at which the '''Rendered Window''' is fully visible, and the portal closes.}} | |||
{{KV|Translucency limit (TranslucencyLimit)|normal|Prevents the ''Rendered Window'' brush from ever going completely transparent. Useful if your rendered window uses an opaque glass material.}} | |||
{{KV|Foreground bmodel (BackgroundBModel)|targetname|Optional brush entity that is drawn after the fading brush model. This model should have alpha in its textures so you can see through it.}} | |||
{{KV BaseEntity}} | |||
==Inputs== | |||
{{IO|SetFadeStartDistance|param=int|Sets '''Fade Start Distance'''.}} | |||
{{IO|SetFadeEndDistance|param=int|Sets '''Fade End Distance'''.}} | |||
{{I BaseEntity}} | |||
{{ | |||
== | ==Outputs== | ||
{{O BaseEntity|l4d=1}} | |||
==See Also== | |||
*{{ent|func_areaportal}} | |||
== | |||
{{ | |||
[[Category:Optimization Brush Entities]] | [[Category:Optimization Brush Entities]] | ||
Revision as of 21:33, 4 October 2018
An example of its use on d2_coast_09
. When the player is close to the window, the entity is inactive and the player can see through the window. When the player backs up, the objects outside are culled from the PVS and replaced with a hazy low-res texture.
. When the player is close to the window, the entity is inactive and the player can see through the window. When the player backs up, the objects outside are culled from the PVS and replaced with a hazy low-res texture.Template:Base brush It creates an areaportal that automatically closes as the camera moves away, fading a second, opaque brush in to fill the gap.
Bug:(Known to affect Half Life 2) The dev/dev_window texture has to be on both sides of the brush, combining it with any other texture (except nodraw) will result in rendering glitches (objects popping in and out of the PVS depending on player position and view angle). [todo tested in ?] In code, it is represented by theCFuncAreaPortalWindowclass, defined in thefunc_areaportalwindow.cppfile.
Keyvalues
- Rendered Window (target) ([todo internal name (i)]) <targetname>
- The brush entity that fills the gap left by the portal when closed.
- Fade Start Distance (FadeStartDist) ([todo internal name (i)]) <integer>
- Distance that the fade into the Rendered Window brush entity begins. The further back the player views, the more visible the brush entity will be.
- Fade End Distance (FadeDist) ([todo internal name (i)]) <integer>
- Distance at which the Rendered Window is fully visible, and the portal closes.
- Translucency limit (TranslucencyLimit) ([todo internal name (i)]) <normal>
- Prevents the Rendered Window brush from ever going completely transparent. Useful if your rendered window uses an opaque glass material.
- Foreground bmodel (BackgroundBModel) ([todo internal name (i)]) <targetname>
- Optional brush entity that is drawn after the fading brush model. This model should have alpha in its textures so you can see through it.
Inputs
- SetFadeStartDistance <integer>
- Sets Fade Start Distance.
- SetFadeEndDistance <integer>
- Sets Fade End Distance.