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

Info overlay transition: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(documented bug I just encountered)
 
(28 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{wrongtitle|title=info_overlay_transition}}
[[File:Info_overlay_transistion_effect.png|The "Wave" effect from the info_overlay_transition.|200px|thumb|right]]
{{base_point_ep1}}
{{this is a|logical entity|internal=1|name=info_overlay_transition|since=Source 2006}}
This entity creates a scrolling texture between a displacement and a water brush, so you can create a "wave" effect.


==Entity Description==
Unlike regular overlays, overlay transitions cannot modified by {{ent|env_texturetoggle}} or {{ent|material_modify_control}}.
Overlay Transition
{{Internal entity note}}
==Keyvalues==
 
* '''material'''
== Keyvalues ==
: <material> Material
{{note|These KVs are used by {{hammer|2}} only; the actual information that [[VBSP]] uses to create the overlay is a separate OverlayTransition{} block in the VMF.}}
* '''sides'''
{{KV Targetname null|hammer only=y}}
: <sidelist> Brush faces
{{KV|Material|intn=material|material|Texture to use with this overlay.}}
* '''sides2'''
{{KV|Brush faces|intn=sides|sidelist|Brush faces on which the overlay will be applied.}}
: <sidelist> Water faces
{{KV|Water faces|intn=sides2|sidelist|Water brush faces on which the overlay will be applied.}}
* '''LengthTexcoordStart'''
{{KV|Texcoord Length Start|intn=LengthTexcoordStart|float}}
: <float> Texcoord Length Start
{{KV|Texcoord Length End|intn=LengthTexcoordEnd|float}}
* '''LengthTexcoordEnd'''
{{KV|Texcoord Width Start|intn=WidthTexcoordStart|float}}
: <float> Texcoord Length End
{{KV|Texcoord Width End|intn=WidthTexcoordEnd|float}}
* '''WidthTexcoordStart'''
{{KV|Width Land|intn=Width1|float|Width of the overlay on displacements from the coastline, in Hammer units.}}
: <float> Texcoord Width Start
{{KV|Width Water|intn=Width2|float|Width of the overlay on water from the coastline, in Hammer units.}}
* '''WidthTexcoordEnd'''
{{KV|Show Debug|intn=DebugDraw|bool|If set, visualizes overlay width with helper cubes, as well as coastline angles in {{hammer|2}}.}}
: <float> Texcoord Width End
:* Red Cubes - Width Land
* '''Width1'''
:* Blue Cubes - Width Water
: <float> Width Land
:{{bug|When enabled, it causes models and sprites to render as wireframe when the {{ent|info_overlay_transition}} is in the camera view.|tested={{src13sp}}}}
* '''Width2'''
: <float> Width Water
* '''DebugDraw'''
: {{boolean}} Show Debug

Latest revision as of 14:04, 27 May 2025

The "Wave" effect from the info_overlay_transition.

info_overlay_transition is an internal logical entity available in all Source Source games since Source 2006 Source 2006. This entity creates a scrolling texture between a displacement and a water brush, so you can create a "wave" effect.

Unlike regular overlays, overlay transitions cannot modified by env_texturetoggle or material_modify_control.

Note.pngNote:This is an internal entity. When the map is compiled by VBSP, it is processed and then removed; it does not exist when the map is running.

Keyvalues

Note.pngNote:These KVs are used by Hammer Hammer only; the actual information that VBSP uses to create the overlay is a separate OverlayTransition{} block in the VMF.
Name (targetname) <string>
Name of this entity. Displayed in Hammer's 2D views and Entity Report. No effect in-game, nor in map compilers.
Material (material) <material>
Texture to use with this overlay.
Brush faces (sides) <sidelist>
Brush faces on which the overlay will be applied.
Water faces (sides2) <sidelist>
Water brush faces on which the overlay will be applied.
Texcoord Length Start (LengthTexcoordStart) <float>
Texcoord Length End (LengthTexcoordEnd) <float>
Texcoord Width Start (WidthTexcoordStart) <float>
Texcoord Width End (WidthTexcoordEnd) <float>
Width Land (Width1) <float>
Width of the overlay on displacements from the coastline, in Hammer units.
Width Water (Width2) <float>
Width of the overlay on water from the coastline, in Hammer units.
Show Debug (DebugDraw) <boolean>
If set, visualizes overlay width with helper cubes, as well as coastline angles in Hammer Hammer.
  • Red Cubes - Width Land
  • Blue Cubes - Width Water
Icon-Bug.pngBug:When enabled, it causes models and sprites to render as wireframe when the info_overlay_transition is in the camera view.  (tested in: Source 2013 Singleplayer)