Func areaportalwindow: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Added "-")
(-made the page more concise)
Line 9: Line 9:


==Keyvalues==
==Keyvalues==
{{KV|Rendered Window (target)|targetname|The brush entity that fills the gap left by the portal when closed.}}
{{KV|Rendered Window|intn=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 Start Distance|intn=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|Fade End Distance|intn=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|Translucency limit|intn=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|Foreground bmodel|intn=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}}
{{KV Targetname}}


==Inputs==
==Inputs==
{{IO|SetFadeStartDistance|param=int|Sets '''Fade Start Distance'''.}}
{{IO|SetFadeStartDistance|param=int|Sets '''Fade Start Distance'''.}}
{{IO|SetFadeEndDistance|param=int|Sets '''Fade End Distance'''.}}
{{IO|SetFadeEndDistance|param=int|Sets '''Fade End Distance'''.}}
{{I BaseEntity}}
==Outputs==
{{O BaseEntity|l4d=1}}


==See Also==
==See Also==

Revision as of 12:19, 19 October 2022

English (en)Translate (Translate)
An example of its use on d2_coast_09Half-Life 2. 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.
Toolsareaportal.gif

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.

A func_areaportal_window that hides interior geometry by turning black at a distance.
Icon-Bug.pngBug:(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 ?]
C++ In code, it is represented by theCFuncAreaPortalWindowclass, defined in thefunc_areaportalwindow.cppfile.

Keyvalues

Rendered Window (target) <targetname>
The brush entity that fills the gap left by the portal when closed.
Fade Start Distance (FadeStartDist) <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) <integer>
Distance at which the Rendered Window is fully visible, and the portal closes.
Translucency limit (TranslucencyLimit) <normal>
Prevents the Rendered Window brush from ever going completely transparent. Useful if your rendered window uses an opaque glass material.
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.
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

Inputs

SetFadeStartDistance <integerRedirectInput/integer>
Sets Fade Start Distance.
SetFadeEndDistance <integerRedirectInput/integer>
Sets Fade End Distance.

See Also