Env lensflare

Template:BMS point It creates a  lens flare that can be used to represent bright light sources.

Keyvalues

File (FlareFile) <string>

Optionnal [sic] - file defining the lens flare. Note: Hammer's parameters overwrite the file's parameters.

Distance attenuation (FlareAttenuation) <float>

distance where lensflare will be invisible. 0.0 if not attenuation with distance

Flare Type (FlareType) <choices>

Normal: normal lens flare (Pitch,Yaw,Roll not used) ------ Sun Flare: set the same Pitch,Yaw,Roll that the one from the sun light_env. That will define the position of the sun. the actual position of this entity is not used.

• 0: Normal
• 1: Sun Flare

Appearance (FlareStyle) <choices>

Template:Light appearances

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. - 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>

image of the lens - if empty the flare doesn't exist

Flare 01 parameters (Flare01_params) to Flare 20 parameters (Flare20_params) <string>

parameters - example : DISK 1.0 10 10

Flare 01 intensity (Flare01_intensity) to Flare 20 intensity (Flare20_intensity) <vector>

intensity of the flare - example : 1.0 1.0 1.0

Flare 01 sizes (Flare01_sizes) to Flare 20 sizes (Flare20_sizes) <vector>

intensity of the flare - example : 1.0 1.0 1.0

Flare 01 color (Flare01_color) to Flare 20 color (Flare20_color) <color255>

color factor of the texture - example : 255 255 255

Inputs

ColorRedValue

Sets the red color channel's value (0 - 255).

ColorGreenValue

Sets the green color channel's value (0 - 255).

ColorBlueValue

Sets the blue color channel's value (0 - 255).

SetScale

Set the lensflare's scale (0 - 8.0).

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.

Texture

The texture property sets the material used by the flare. It is a path to a VMT file relative to the materials folder and without the file extension. Common flare materials are located in the effects/lensflare/ folder. Any material can be used as a lens flare, but flare materials should use UnlitGeneric and be additive.

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 parameter scales the position of the flare on screen. When it is 0 the flare stays at the env_lensflare's screen space position. When it's greater than zero and less than one it will stay between the center of the player's screen and the env_lensflare's on screen position. When it is equal to one the flare will stay at the center of the screen. When greater than one the flare will get further away from the env_lensflare's screen space position the more the player looks away from the env_lensflare.

The second and third parameters is the size of the flare in the x- and y-axis respectively.

Todo: Document lens flare properties