This article's documentation is for Source 2. Click here for more information.

Visibility hint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Multipage + infotable + wow valve employee oh my gooood)
Line 1: Line 1:
{{this is a|point entity|name=visibility_hint|game=SteamVR Home|game1=Half-Life: Alyx|game2=Counter-Strike 2|engine=source2}} It is a point entity which is used to define visibility grid properties.
{{infotable
 
|visibility_hint
==Entity description==
|img=[[File:visibility hint.png]]
The visibility hint ostensibly affects visibility inside its bounds via the use of a voxel grid of variable resolution.
|type=e0
 
|engine=3
==CS2 Version==
|in={{hla|4}}, {{cs2|4}} & {{svrh|4}}
CS2 uses a newer version of the vis solver and has different options for this entity.
}}
In CS2 the split hints will split on the positive and negative sides of the bounds of this entity.  These hints work at grid resolution.  There is no way to split the underlying grid.
{{this is a|point entity|name=visibility_hint|game=SteamVR Home|game1=Half-Life: Alyx|game2=Counter-Strike 2|engine=source2}}{{multipage}}
NOTE: The split only guarantees separation in the initial cluster merge phase.  The visibility solver may still decide to merge across splits in order to reach the target number of clusters.  A typical way to use hints is to place a Z-axis split at least one grid above player height.  This can help to keep clusters from getting too tall relative to the player's view.
 
In the CS2 version you can have overlapping resolution hints.  The highest resolution hint wins for any give piece of space.  A typical use case would be to hint an entire map as "Use Lower resolution" and then surround the smaller playable space with a "Use High Resolution" hint to avoid wasting a lot of processing time computing visibility in the background / sky areas of the map.
 
 
 
:{{todo|Test the use of this entity for its behavior.}}
 
== Properties ==
{{KV|Box Mins|coordinates|The minimum bounds for the volume, can be dragged out in the 3d view or entered manually.}}
 
{{KV|Box Maxs|coordinates|The maximumbounds for the volume, can be dragged out in the 3d view or entered manually.}}
 
{{KV|Hint Type|choices}}
:*0: Use Low Resolution (64 unit grid) (default)
:*3: Use High Resolution
:*6: Z-axis split
 
 
{{KV|Hint Type|choices}} (CS2 Version)
:*0: Use High Resolution (8 unit grid) (default)
:*1: Use Normal Resolution (16 unit grid)
:*2: Use Medium Resolution (32 unit grid)
:*3: Use Low Resolution (64 unit grid)
:*8: Use Lower Resolution (64 unit grid, fewer initial clusters)
:*9: Use Lowest Resolution (256 unit grid, fewest initial clusters)
:*4: X-axis split
:*5: Y-axis split
:*6: Z-axis split
 
{{KV Source 2 Transform}}
 
== See also ==
 
[[SteamVR/Environments/Precomputed_Visibility | SteamVR Home - Precomputed Visibility Tutorial]]
 
 
[[Category:Entities]]
[[Category:Entities]]
[[Category:Half-Life:_Alyx_Entities]]
[[Category:Half-Life:_Alyx_Entities]]

Revision as of 17:28, 4 March 2024

visibility_hint
Visibility hint.png
TypePoint entity
EngineSource 2 Source 2
AvailabilityHalf-Life: Alyx Half-Life: Alyx, Counter-Strike 2 Counter-Strike 2 & SteamVR Home SteamVR Home
 

visibility_hint is a point entity available in SteamVR Home SteamVR Home, Half-Life: Alyx Half-Life: Alyx, and Counter-Strike 2 Counter-Strike 2.

Warning.pngWarning:
  • The {{{engine}}} parameter is inconsistent with the name defined by the {{source2}} template. This can most likely be fixed by setting the value of the {{{engine}}} parameter to Source 2.
    If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page.

Template:Multipage

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Visibility_hint&oldid=389367"