env_lensflare
 Class hierarchy
|
|---|
| CLensflare |
env_lensflare is a point entity available in 
Black Mesa. It creates a cinematic dynamic 
lens flare that can be used to represent bright light sources.
Keyvalues
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Distance attenuation (FlareAttenuation) <float>
- Distance where lens flare will be invisible. 0.0 if not attenuation with distance.
- Flare Type (FlareType) <choices>
- 0: Normal - use origin position and display normally.
- 1: Sun Flare - display in the skybox and use angle values for position in the skybox, similar to env_sun or newLight_Dir.
|
Warning:Never place more then 4 lens flares with sun flare type, otherwise game will crash on map launch with this message.
|
- Appearance (FlareStyle) <choices>
Lightstyle presets (epilepsy warning) Literal Value Description Sequence Preview 0 Normal m 
10 Fluorescent flicker mmamammmmammamamaaamammma 
2 Slow, strong pulse abcdefghijklmnopqrstuvwxyzyxwvutsrqponmlkjihgfedcba 
11 Slow pulse, noblack abcdefghijklmnopqrrqponmlkjihgfedcba 
5 Gentle pulse jklmnopqrstuvwxyzyxwvutsrqponmlkj 
1 Flicker A mmnmmommommnonmmonqnmmo 
6 Flicker B nmonqnmomnmomomno 
3 Candle A mmmmmaaaaammmmmaaaaaabcdefgabcdefg 
7 Candle B mmmaaaabcdefgmmmmaaaammmaamm 
8 Candle C mmmaaammmaaammmabcdefaaaammmmabcdefmmmaaaa 
4 Fast strobe mamamamamama 
9 Slow strobe aaaaaaaazzzzzzzz 
12 Underwater light mutation mmnnmmnnnmmnn 
- Size of Glow Proxy Geometry. (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.
Note:Richard's note : I noticed that value more than ~100 wont work correctly.- Flare 01 texture (Flare01_texture) to Flare 20 texture (Flare20_texture) <string>
- Texture to use for the lens flare. If not specified - the lens flare will not exists. A path to a VMT file relative to the
materialsfolder, without the file extension. Common flare materials are located in theeffects/lensflare/folder. Any material can be used as a lens flare, but flare materials should preferably use UnlitGeneric and be $additive.
- Flare 01 parameters (Flare01_params) to Flare 20 parameters (Flare20_params) <string>
- Sets function and values for it, this will define the lens flare behavior. See below for more details.
- Flare 01 intensity (Flare01_intensity) to Flare 20 intensity (Flare20_intensity) <vector>
- Sets scale of intensity in three independent numbers, used number depends on the player's camera deviation.
- First number sets when player look at entity center.
- Second number sets when player camera have slight deviation.
- Third number sets when player look far away from entity center.
Example in a short video with 3 different values.
- Flare 01 sizes (Flare01_sizes) to Flare 20 sizes (Flare20_sizes) <vector>
- Sets scale of size in three independent numbers, used number depends on the player's camera deviation.
- First number sets when player look at entity center.
- Second number sets when player camera have slight deviation.
- Third number sets when player look far away from entity center.
Note:Doesn't work with BOW function (see below).Example in a short video with 3 different values.
- Flare 01 color (Flare01_color) to Flare 20 color (Flare20_color) <color255>
- The RGB color value of the flare.
Inputs
ColorRedValue
- Deprecated.
This is a leftover from env_sprite entity code.
ColorGreenValue- Deprecated.
This is a leftover from env_sprite entity code.
ColorBlueValue- Deprecated.
This is a leftover from env_sprite entity code.
SetScale- Deprecated.
Set the lensflare's scale (0 - 8.0). Only in FGD, doesn't exists in the game.
- HideLensFlare
- Hide the lensflare. Won't be drawn until the 'ShowLensFlare' input is received.
- ShowLensFlare
- Show the lensflare.
- ToggleLensFlare
- Toggle the lensflare between hidden and shown.
Flags
- Start on : [1]
- Play once : [2]
Lens Flare Properties
An individual env_lensflare can support up to 20 flares. Each flare have different properties that can be customized.
Parameters
The parameters property controls the appearance of the flare. Parameters take the following form:
TYPE parameters
The following lens flare types can be used:
DISK
A screen space flare that gets stronger when the player looks directly at the env_lensflare, and weaker as the player looks away. It takes three parameters.
The first number - how strong a image will move away from screen center. With 1 it will attached to screen center. If 0 - will stay at env_lensflare center. Negative number will mirror effect that do positive number.
The second number - distort a image along the axis Y. Doesn't work with negative numbers.
The third number - distort a image along the axis X. Doesn't work with negative numbers.
|
|
BOW
An effect that uses an image and distorts it between center of screen and env_lensflare center. It takes one parameter. Doesn't work with negative numbers.
The first number - change a picture scale.
|
|
CLA
This effect looks like copy of DISK. It use same parameters.
|
|
DISKH
An effect that uses an image and moves it along the X axis. It takes four parameter.
The first number - how strong the image will move away from screen center along the axis X. If number is 0 - it will stand at env_lensflare center. With 1 it will attached to screen center. Negative number will mirror effect that do positive number.
The second number - distort the image along the axis X. Doesn't work with negative numbers.
The third number - distort the image along the axis Y. Doesn't work with negative numbers.
The fourth number - change position of a image along the axis Y. If positive number - be higher, if negative number - be lower.
|
|
RAY
An effect that uses an image and scale it. It takes two parameter. Doesn't work with negative numbers.
The first number - distort the image along the axis Y.
The second number - distort the image along the axis X and Z.
|
|
Lens flare creation tips
There is no preview in Hammer for lens flares, there is also no UI editor for lens flares. The developers recommend to use their lens flares, or use their lens flares as base for your own. You can create your own lens flares from scratch by following these steps:
- 1. Open the developer console.
- 2. Enter in the console
sv_cheats 1. - 3. Enter in the console
ent_fire YourLensFlareName addoutput "FlareNUMBER_params ParameterName VALUES". - 4. Save and load the save.
After load save you will see changes, so, with this you don't need to recompile your level to see how your lens flare will looks like.
Bugs/Limitations
Lens flares render behind viewmodel
Not a bug, but this is not what you expect from real life. You can block lens flare with your first person weapon model and it will not fade out. Fixed in Half-Life 2: Inhuman.
Black Mesa
Half-Life 2: Inhuman
Sun flare incorrect work with point_viewcontrol
Sun flare change position in sky when player move, this affects to what show point_viewcontrol when it's enabled. If you want to see in your background level sun flare - place player on needed position. If your point_viewcontrol moves - attach player to it.
Showcase of problem in background level of Black Mesa: Black Ops - Restored
User can disable lens flares and see defect
In graphics settings user can turn off all flares, keep in mind this to escape situations like in the picture. Add sprites or corresponding skins, paint sun on your skybox if don't plan to use newLight_Dir.
Option enabled. Dr. Rosenberg hold enabled flashlight, everything looks fine.
Option disabled. Dr. Rosenberg still hold enabled flashlight, but flashlight looks disabled in fact.
Doesn't work with 3D Skybox
Don't use env_lensflare in your 3D skyboxes, 3D skybox will not show flares.
Sun flare render through 3D Skybox objects
Unlike env_sun, sun flare renders through any object pasted in 3D Skybox environment. Keep in mind this before you will create 3D Skybox.
Clear example (the missiles is 3D Skybox objects).
Incorrect work with -tools
If you don't use Full Screen - lens flares will be displayed offset from where they initially should be.
An example (note that the tram flares is in a wrong place).
Doesn't work with level transition
If it is attached to an object, it will not transmit between levels.
See also
- newLight_Point
- newLight_Spot
- newLight_Dir
- NewLights_settings
- env_cascade_light
- New_Specular
- Lighting
- Adding Light
- Intermediate Lighting
- Advanced Lighting
- env_sprite
- BlackMesa XenEngine: Part2 – How a Frame is Rendered (page from Black Mesa developer about new graphics features)
- BlackMesa XenEngine: Part1 – Heavily Modified Source Engine (page from Black Mesa developer about Black Mesa engine, better known as Xengine)