light

Modified

12-Jul-2023

A point light source.

Keyvalues

Target target : Non-functional in light, yet need to be left empty in order to make light toggleable.

OnDestroy Function ondestroyfn : Name of the function to use from already parsed .as script files when entity is destroyed (killed) in any way. If the function belongs to namespace, you must use prefix with the namespace name (e.g. mynamespace::MyFunction) for the keyvalue.

Name targetname : Set name of light so other entities can trigger it to turn light on and off. Depending on trigger use-type: 'On'- turn light on, 'Off'- turn light off, 'Toggle'- toggle light. Kill-targeting this entity will remove light but won't remove lightstyles (you might just want to turn it off instead).

Brightness _light : Red, green and blue amounts of the light color, from 0 to 255, followed by the brightness, which can have pretty much any value greater than 0. It is not limited to 200 or 255 and can be a decimal, although that level of precision is rarely required.

Appearance style : Allows you to select a light style. This will only work when a targetname is NOT set. Note that there can be at most 4 different light styles affecting a face in your map. Otherwise, light styles will be discarded from it, causing unrealistic lighting in extreme cases.

  • 0 : Normal
  • 10 : Fluorescent flicker
  • 2 : Slow, strong pulse
  • 11 : Slow pulse, noblack
  • 5 : Gentle pulse
  • 1 : Flicker A
  • 6 : Flicker B
  • 3 : Candle A
  • 7 : Candle B
  • 8 : Candle C
  • 4 : Fast strobe
  • 9 : Slow strobe

Custom Appearance pattern : Allows you to set up a custom appearance of unnamed light. To do this, you will have to enter 1 to 64 chars from the alphabet ('a' to 'z'), whereas 'a' stands for being dark and 'z' for very bright. Normal lights' appearances uses 'm'. The program Custom Lightstyle Generator by Craig "CRAZG" McLaren might help you here. Whatever sequence you enter is stepped through at about 8 Hertz. This will only work when a targetname is set. Note that there can be at most 4 different light styles affecting a face in your map. Otherwise, light styles will be discarded from it, causing unrealistic lighting in extreme cases.

ZHLT Light Fade _fade : Controls light travel distance. You can either make light shorter (higher values above 1.0) or longer (smaller values approaching 0.0). The default value is 1.0.

ZHLT Light Falloff _falloff : This option can change the normal inverse square falloff of lighting in the direct lighting layer with inverse falloff.

  • 0 : Default
  • 1 : Inverse Linear
  • 2 : Inverse Square

Flags

  • 1 : Initially dark : If set, the light will be turned off at map start. This will only work when a targetname is set. This counts as an additional lightstyle. If you have multiple lights by the same name, they will count as one additional lightstyle, even if some of the lights are initially dark while others are not. Note that there can be at most 4 different light styles affecting a face in your map. Otherwise, light styles will be discarded from it, causing unrealistic lighting in extreme cases.

  • 2 : Remove Entity

The use of texlights is always more encouraged, as they usually produce more realistic lighting.