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

Env lightglow: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(33 intermediate revisions by 18 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_lightglow}}
{{lang|Env lightglow|title=env_lightglow}}
[[File:env_lightglow.jpg|thumb|300px|right|<code>env_lightglow</code> used in a tunnel to create an illusion of overwhelming brightness at the end of the tunnel.]]
{{CD|CLightGlow|file1=lightglow.cpp}}
{{this is a|point entity|name=env_lightglow}} It puts an additive glow in the world, mostly used over light sources and other locations where a glow would look natural (tunnels, caves, dark buildings, etc). It's main difference from {{ent|env_sprite}} is it's ability to appear in a configurable distance.


[[Image:env_lightglow.jpg|thumb|300px|right|env_lightglow used in a tunnel to create an illusion of overwhelming brightness at the end of the tunnel]]
== Bugs and Caveats ==
 
{{note|This entity does not have Enable/Disable inputs. Using the <code>Color</code> input with a parameter of 0 0 0 will hide it, as a workaround.}}
==Entity Description==
{{note|This file will be cached inside of saves, regardless of if the map has had the entity deleted in a new compile. Avoid loading saves created using outdated maps.}}
An entity that puts an additive glow in the world, mostly used over light sources and other locations where a glow would look natural (tunnels, caves, dark buildings, etc).
{{bug|If an <code>env_lightglow</code> entity is moved during an active level, the fade distances will apply as if the <code>env_lightglow</code> did not move.}}
 
{{bug|If the player camera was centered in between the top of the water, the glow can be seen through a wall. Player can easily notice this when they go down underwater.|tested={{hl2}}}}
{{tip|For symmetrical glows, you can also use an [[env_sprite]] entity using a glow sprite.}}
[https://www.youtube.com/watch?v=VSWiZcKti_0] for above
==Flags==
{{fl|1|Visible only from front}}


==Keyvalues==
==Keyvalues==
 
{{KV Targetname}}
* {{kv targetname}}
{{KV|Color (R G B)|intn=rendercolor|color255|Glow color.}}
 
{{KV|Vertical Size|intn=VerticalGlowSize|integer|Vertical glow size in units.}}
* {{kv parentname}}
{{KV|Horizontal Size|intn=HorizontalGlowSize|integer|Horizontal glow size in units.}}
 
{{KV|Minimum Distance|intn=MinDist|integer|The distance at which this effect will be fully translucent.}}
* {{kv hdrcolorscale}}
{{KV|Maximum Distance|intn=MaxDist|integer|The distance at which this effect will be at full intensity.}}
 
{{KV|Outer Maximum Distance|intn=OuterMaxDist|integer|If larger than the maximum distance, this is the length at which the glow will fade completely out, between the span of the maximum distance and this length.}}
* '''rendercolor'''
{{KV|Glow Proxy Geometry Size (0-64)|intn=GlowProxySize|float|Size of the glow to be rendered for visibility testing. Any time a sphere of this radius would be visible (poking through any nearby geometry), the glow will be rendered.}}
: {{color}} Glow Color
{{KV|HDR color scale|intn=HDRColorScale|float|Color multiplier for players using HDR.}}
 
* '''VerticalGlowSize'''
: <integer> Vertical Size
 
* '''HorizontalGlowSize'''
: <integer> Horizontal Size
 
* '''MinDist'''
: <integer> The distance at which this effect will be fully translucent.
 
* '''MaxDist'''
: <integer> The distance at which this effect will be at full intensity.
 
* '''OuterMaxDist'''
: <integer> If larger than the maximum distance, this is the length at which the glow will fade completely out, between the span of the maximum distance and this length.
 
* '''GlowProxySize'''
: <float> Size of the glow to be rendered for visibility testing. Must be larger than the distance from the sprite center to empty space. So if this glow is inside geometry (like a light bulb), set this value to be bigger than the bulb's radius. Any time a sphere of this radius would be visible (poking through any nearby geometry), the glow will be rendered.
 
==Flags==
 
* 1 : Visible only from front


==Inputs==
==Inputs==
{{I|Color|param=color255|Change the render color of the glow. A value of 0 0 0 will hide the sprite.}}


* {{i targetname}}
==See also==
 
*{{ent|env_sprite}}
==Outputs==
*{{ent|env_sprite_oriented}}
 
*{{ent|env_sprite_clientside}}
* {{o targetname}}


[[Category:Entities]]
[[Category:Abstract mapping]]
[[Category:Special effects]]
[[Category:Special effects]]
[[Category:Lighting]]
[[Category:Lighting]]

Latest revision as of 23:52, 21 July 2025

English (en)中文 (zh)Translate (Translate)
env_lightglow used in a tunnel to create an illusion of overwhelming brightness at the end of the tunnel.
C++ Class hierarchy
CLightGlow
↳CBaseEntity
C++ lightglow.cpp

env_lightglow is a point entity available in all Source Source games. It puts an additive glow in the world, mostly used over light sources and other locations where a glow would look natural (tunnels, caves, dark buildings, etc). It's main difference from env_sprite is it's ability to appear in a configurable distance.

Bugs and Caveats

Note.pngNote:This entity does not have Enable/Disable inputs. Using the Color input with a parameter of 0 0 0 will hide it, as a workaround.
Note.pngNote:This file will be cached inside of saves, regardless of if the map has had the entity deleted in a new compile. Avoid loading saves created using outdated maps.
Icon-Bug.pngBug:If an env_lightglow entity is moved during an active level, the fade distances will apply as if the env_lightglow did not move.  [todo tested in ?]
Icon-Bug.pngBug:If the player camera was centered in between the top of the water, the glow can be seen through a wall. Player can easily notice this when they go down underwater.  (tested in: Half-Life 2)

[1] for above

Flags

Visible only from front : [1]

Keyvalues

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

Color (R G B) (rendercolor) <color255>
Glow color.
Vertical Size (VerticalGlowSize) <integer>
Vertical glow size in units.
Horizontal Size (HorizontalGlowSize) <integer>
Horizontal glow size in units.
Minimum Distance (MinDist) <integer>
The distance at which this effect will be fully translucent.
Maximum Distance (MaxDist) <integer>
The distance at which this effect will be at full intensity.
Outer Maximum Distance (OuterMaxDist) <integer>
If larger than the maximum distance, this is the length at which the glow will fade completely out, between the span of the maximum distance and this length.
Glow Proxy Geometry Size (0-64) (GlowProxySize) <float>
Size of the glow to be rendered for visibility testing. Any time a sphere of this radius would be visible (poking through any nearby geometry), the glow will be rendered.
HDR color scale (HDRColorScale) <float>
Color multiplier for players using HDR.

Inputs

Color <color255RedirectInput/color32>
Change the render color of the glow. A value of 0 0 0 will hide the sprite.

See also

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