Godrays settings

godrays_settings is a point entity available in Black Mesa. This entity uses to dynamically change godrays settings for Black Mesa new light entities. For better understanding of this page - recommended at first familiarize yourself with new lights.

Represented by class CGodRaysSettings.

Tip:You can change values dynamically via AddOutput input.

← Black Mesa Level Creation

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

TargetGodRays_Name (TargetGodRays) <string>

Here you enter name of new light entity (with godrays support) for which you want to apply changes. Works with multiple lights if they have the same name.

TransitionTime (TransitionTime) <integer>

Transition time in seconds (0 for instant) to transition into new settings. Its a lerp operation A + (B-A) * TimeFactor.

LightType (LightType) <choices>

Type of light source for which you want to apply settings. Entity will not apply settings for newLight_Dir if selected Point Light and will not apply settings for point lights if selected Direction/Sun Light.

• 0: Direction/Sun Light
• 1: Spot Light

Bug:Doesn't affects newLight_Dir due to mistake in the game code.

EnableGodRays (EnableGodRays) <choices>

Sets godrays state on spawn, enabled or disabled.

• 0: Disabled
• 1: Enabled

Warning:You can have only 40 point lights with godrays enabled simultaneously, otherwise the game will crash with this error message.

The error

If you'll try to enable forty-first light point with enabled Godrays.

Density (Density) <float>

Density controls the length of rays/volumetric shadows. 1.0 should work in 99% cases. Good values are 0.5-1.5.

Examples

1.0 0.5 2.0

Weight (Weight) <float>

Weight controls the intensity of volumetric shadow. Blocking of rays by geometry. Good values are 0.1-10.

Examples

1.0 2.0 5.0

Decay (Decay) <float> 

Deprecated.
Decay controls luminance fall off per sample. Value here doesn't work.

Exposure (Exposure) <float>

Exposure controls the intensity of rays during blending pass with main scene. 2.0 is a good start. Good values are 1.0-10.0.

Examples

00.5 01.0 10.0

DistFactor (DistFactor) <float>

DistFactor controls the falloff of rays/length. 1.0 is a good starting value increase or decrease in the increments of 0.1. 0.0 will make the rays dissappear only disk will be rendererd.

Examples

1.0 2.0 5.0

Note:Godrays doesn't look smooth if used big value here. The same for Exposure.

Example

9999

ColorInner (ColorInner) <color255 + int>

The RGB color and brightness of the inner circle. Colors and brightness must be between 0 and 255.

Bug:This color value doesn't work properly with newLight_Point if you are using Normal godrays type. This entity takes only red value. Works fine with Fancy type.

Examples

Note:Rays is disabled on this picture (the colors are partially blending). 0 255 0 255 255 255 255 255 255 0 255 155

ColorRays (ColorRays) <color255 + int>

The RGB color and brightness of the rays. Colors and brightness must be between 0 and 255.

Examples

0 255 0 255 0 0 255 255 255 0 0 55

ColorOuter (ColorOuter) <color255 + int>

The RGB color and brightness of the outer circle. Colors and brightness must be between 0 and 255.

Bug:This color value doesn't work properly with newLight_Point if you are using Normal godrays type. This entity takes only red value. Works fine with Fancy type.

Examples

Note:Rays is disabled on this picture (the colors are partially blending). 255 255 255 255 255 0 0 255 0 0 255 55

Note:You can't use black colors for ColorOuter, ColorInner and ColorRays.

DiskRadius (DiskRadius) <float>

Radius of disk/circle of sun/point light in texturespace. 1.0 will be full screen, 0.5 is half screen, etc. 0 means don't render.

Examples

0.01 0.1 0.7

DiskInnerSizePercent (DiskInnerSizePercent) <float>

Disk inner circle radius is DiskRadius * DiskInnerSizePercent. 0 means don't render.

Examples

Note:Rays is disabled on this picture (for clarity). 0.1 0.7 0.9

Inputs

InputApplySettings <void>

Triggers the entity to apply the settings.

See also

• NewLights_settings
• newLight_Point
• newLight_Spot
• env_lensflare
• newLight_Dir
• env_cascade_light
• Lighting
• Adding Light
• Intermediate Lighting
• Advanced Lighting
• Effect flags (dynamic light effects)
• Tool textures (for Block light)
• BlackMesa XenEngine: Part 4 – Lighting & Shadows (page from Black Mesa developer about new lights)
• BlackMesa XenEngine: Part2 – How a Frame is Rendered (page from Black Mesa developer about how a frame rendered)
• BlackMesa XenEngine: Part1 – Heavily Modified Source Engine (page from Black Mesa developer about Black Mesa engine, better known as Xengine)

Todo: Clean up english. Add more issues if you'll find.