View source for New Lights Editor

{{Background|file=LightScriptBac.jpg|opacity=.05|gradient-color=50,50,50}}
'''New Lights Editor''' is a based on console commands in-game light/godrays editor, avaible in {{bms|4}}. This editor can configure on the fly most properties of new lights and godrays with instant results in game; you can also add new ones to see how they look at your level. Initially, it was planned to implement the editor via [[VGUI]], but because VGUI is not easy to work with, Kim made <code>lightscript.cfg</code>, which can be executed once to bind various console commands to keys on the keyboard to make the process much easier.

==Usage==
Before '''New Lights Editor''' usage, make a copy of your <code>config.cfg</code> file (for example <code>config_copy.cfg</code>), because '''New Light Editor''' rewrites some bindings. With a copy of the file, you will be able to restore all your binds quickly.

To activate '''New Lights Editor''', at first, open the console (usually this is {{key|`}} bind), than enter in the console {{command|exec|lightscript}} (it is also recommended to enter {{command|sv_cheats|1}}, this to have full access to the commands). After this, you will be automatically moved in {{command|developer|1}}, with this, some bindings will rewratted, and you'll see the message in the console.
<gallery mode=nolines heights=800px widths=800px>
File:LightScript1.jpg|The message.
</gallery>
So, the '''New Lights Editor''' editor is now activated and you may already noticed orange box around entity that is under your crosshair.
<gallery mode=nolines heights=800px widths=800px>
File:LightScriptBox.jpg|The orange box.
</gallery>
This is [[bounding box]], usually uses by game engine to tell when model can be seen by player to draw or not draw it (for performance). You also can see the lines which shows direction of entity, they are always located in [[origin]].

In this case, both things shows you entity that you are targeting, so, technically you can select and edit any entity, but most commands will not produce any results. The only two entities you should interact with is {{ent|newLight_Point}} and {{ent|newLight_Spot}} (might work {{ent|newLight_Dir}} as well, but you can't select it).
{{confirm|Will this work if an entity have on of the properties ?}}

To edit your new light source, move your crosshair at it. You'll note this white box and lines which shows direction of it, bounding box as well.
<gallery mode=nolines heights=800px widths=800px>
File:LightScript2.jpg|This is how it looks like with point light.
File:LightScript5.jpg|This is how it looks like with spot light.
</gallery>
Press {{key|Enter}} to select it (to deselect it, press {{key|Enter}} again). Now you can see sphere instead of white box. In case of point light, the lines will be disabled (you don't really need them at all), in case of spot light, they will stay. The color of sphere will match color of selected light source.
<gallery mode=nolines heights=800px widths=800px>
File:LightScript3.jpg|This is how it looks like with point light.
File:LightScript6.jpg|This is how it looks like with spot light.
</gallery>
Now you can change light properties. In totalm you can change 18 different properties. There are 9 buttons in total, one button for every two property, you switch between them by pressing on it.

To select one of the properties you want to change, press one of these buttons: {{key|F1}} to {{key|F9}} or {{key|1}} to {{key|9}} on numpad. See below for what each does. To get full list of binds - press {{key|*}} on numpad.
<gallery mode=nolines heights=800px widths=800px>
File:LightScriptSel.jpg|This message appear when you select {{code|Intensity}} property.
</gallery>
After property selection, you can increase or decrease property value. Use mouse wheel up to increase, or {{key|+}} on numpad. Use mouse wheel down to decrease, or {{key|-}} on numpad. The resulting value will be displayed in the console.
{{note|There are limits due to scripting limits. Most values don't have the limits, or they are much larger than can be set using this editor.}}
<gallery mode=nolines heights=500px widths=500px>
File:LightScriptValu.jpg|This message appear when you change {{code|Range}} value.
</gallery>
Once you have decided on the values, manually write them in [[Hammer]]. If you have lost some value, you can get full information about selected light source, press {{key|,}} or {{key|/}} on numpad.
<gallery mode=nolines heights=800px widths=800px>
File:LightScriptInfo.jpg|Example with the spot light in {{code|bm_c2a4c}}.
</gallery>
In addition to editing an existing lights, you can also add new ones. Press {{key|Insert}} (or {{key|0}} on numpad), then press {{key|LMB}}. This will cause white light source with no shadows to appear under your crosshair.
{{bug|Initially planned that you are able to create both point and spot light, but due to mistake in {{code|lightscript.cfg}} you can create only point light. Attempt to create spot light will cause message in the console {{code|Unknown command: newl_s}}.|hidetested=1}}
<gallery mode=nolines heights=800px widths=800px>
File:LightScriptCreate.jpg|Example.
</gallery>
To delete light source, press {{key|Delete}}, or {{key|.}} on numpad.

To disable '''New Lights Editor''', enter in the console {{command|exec|lightscript}}.

==Keypad List==
This is full list of bind/commands.


* {{key|F1}} or {{key|1}} on numpad - Intensity / Range.
{{bug|Range increasing doesn't increase bounding box, this means that your light will be disabled when it shouldn't. Don't care, just put value in Hammer, compile map and everything will be okay.|hidetested=1}}
{{bug|Shadows incorrectly displaying with Range increase.|hidetested=1}}
* {{key|F2}} or {{key|2}} on numpad - Inner Angle  /Outer Angle.
* {{key|F3}} or {{key|3}} on numpad - Angle FallOff / Shadow Radius.
{{bug|It looks like Shadow Radius doesn't saves after switching to another property.|hidetested=1}}
* {{key|F4}} or {{key|4}} on numpad - NearZ / Shadow Bias Depth.
* {{key|F5}} or {{key|5}} on numpad - Shadow Bias Slope / Normal Bias.
{{bug|Normal Bias doesn't saves. The original value will be returned after switching to another property.|hidetested=1}}
* {{key|F6}} or {{key|6}} on numpad - Light Styles / Specular Multiplier.
* {{key|F7}} or {{key|7}} on numpad - Godray Density / Godray Weight.
* {{key|F8}} or {{key|8}} on numpad - Godray Distfactor / Godray Radius.
* {{key|F9}} or {{key|9}} on numpad - Godray Exposure.


* {{key|Enter}} - select/deselect light.
* {{key|Mause Wheel Up}} or {{key|+}} on numpad - increase value of selected property.
* {{key|Mause Wheel Down}} or {{key|-}} on numpad - decrease value of selected property.
* {{key|,}} or {{key|/}} on numpad - shows all values of selected light.
* {{key|*}} on numpad - shows all keypad binds.
* {{key|Delete}} or {{key|.}} on numpad - removes any entity your crosshair is pointed at.


* {{key|Insert}} or {{key|0}} on numpad - inserts newLight_Spot/newLight_Point.
{{bug|You can't create spot light due to mistake in <code>lightscript.cfg</code>.|hidetested=1}}
* {{key|MOUSE1}} - place light source where your crosshair is pointed.

==Unused Commands==
Some commands are unsed. You still can use them via console when your light source is selected.

* {{command|le_light_Col}} - sets light color value ([[RGB]]).
* {{command|le_light_ColAmbient}} - sets shadow color value ([[RGB]]).
* {{command|le_light_Pos}} - sets light source position in world ([[XYZ]]).
* {{command|le_gr_col_inner}} - sets godrays inner color ([[RGB]]).
* {{command|le_gr_col_outer}} - sets godrays outer color ([[RGB]]).
* {{command|le_gr_col_rays}} - sets godrays rays color ([[RGB]]).
* {{command|le_gr_godray_type}} - sets godrays type (0 - normal, 1 - fancy).
* {{command|le_gr_worldspace_enable}} - sets world space render state (0 - disabled, 1 - enabled).
* {{command|le_gr_ell_FR_constA}} - sets size of disk from fancy godrays ([[float]]).
* {{command|le_gr_ell_FR_constB}} - sets distortion scale of disk from fancy godrays ([[float]]).
* {{command|le_gr_ell_rot_pattern}} - sets amount of fancy rays in frame ([[float]]).
* {{command|le_gr_ell_rotspeed}} - sets rotating speed of fancy rays ([[float]]).
* {{command|le_gr_ell_RRF_constA}} - sets inner size of fancy godrays ([[float]]).
* {{command|le_gr_ell_RRF_constB}} - sets inner distortion size of fancy godrays ([[float]]).
* {{command|le_gr_ell_SR_constA}} - sets size of disk hole for fancy godrays ([[float]]).
* {{command|le_gr_ell_SR_constB}} - sets distortion scale of disk hole for fancy godrays ([[float]]).
{{note|Non-functioning commands are not included here.}}

== See also ==
* {{ent|Xog Editor}} - similar editor, but for [[newxog_global|xog]].
* {{ent|newLight_Point}} - new point light.
* {{ent|newLight_Spot}} - new spot light.
* {{ent|newLight_Dir}} - godrays in sky.
* {{ent|NewLights_settings}} - entity that changes properties of lighting.
* {{ent|godrays_settings}} - entity that changes properties of godrays.