View source for Light Source Tutorial

{{TOC|side}}
== Basics ==

A lightpoint (glowing light source) is a non-physical object that shines a light. Unlike projectors or vehicle headlights, this light type cannot be directed into a beam and can only glow uniformously. The glowing does not cast shadows (only the sun or the moon can) and can go through walls.

{{Feature | Informative | Lightpoint notions and commands were introduced in {{arma1}}, some commands were later added in {{arma3}} (e.g [[setLightIntensity]], flare commands).}}

A lightpoint is '''[[local]]''' to the computer where the script has been called; one player could see a light in the dark while another would not have such light "object" created.

[[File:lightpoint_redColor_blueAmbient.jpg|thumb|left|200px|Lightpoint with {{Color|darkred|red}} colour, and {{Color|blue|blue}} ambient.
Note how the {{Color|darkred|red}} and {{Color|blue|blue}} hues mix to create {{Color|purple|purple}}.]]
=== Colour ===

Colour set ''via'' [[setLightColor]] determines the lens [[#Flare|flare]] effect colour, as well as light's first colour.

=== Ambient ===

Colour set ''via'' [[setLightAmbient]] determines the outer colour shone by the lightpoint.
{{Feature | important | Light colour does not affect AI, but ambient '''does'''.}}

=== Flare ===

The flare is the "colour point" centre that emits light. It can be visible or invisible (set by [[setLightUseFlare]]).
{{Feature | Informative |  Flare is '''not''' visible by day, even using [[setLightDayLight]].}}


== How to ==

The list of all lightpoint commands can be found in the [[:Category:Command Group: Lights|Lights command group]] category.

=== Create a lightpoint ===

 [[private]] _lightpoint = '''"#lightpoint"''' [[createVehicleLocal]] [[player]] [[modelToWorld]] [0,2,1.5];

{{Feature | Informative | A lightpoint is '''local''' (and all the lightpoint commands take a local argument too), hence [[createVehicleLocal]] usage.}}

=== Set light colour ===

==== Colour ====
 _lightpoint [[setLightColor]] [0.25, 1, 1]; {{cc|also defines [[#Set flare|Flare]] colour}}

==== Ambient Colour ====
 _lightpoint [[setLightAmbient]] [1, 1, 1]; {{cc|sets the colour applied to the surroundings}}

=== Set flare ===

{{Feature | Informative | For the flare to be visible, all the following values (use flare, size, visibility) must be defined and light colour [[#Colour_2|set by]] [[setLightColor]] must not be [0,0,0].}}

{{ArgTitle|Enable flare|4|{{GVI|arma3|0.50}}}}
 _lightpoint [[setLightUseFlare]] [[true]];

{{ArgTitle|Set flare size|4|{{GVI|arma3|0.50}}}}
 _lightpoint [[setLightFlareSize]] 1; {{cc|in meter}}

{{ArgTitle|Set flare visibility|4|{{GVI|arma3|0.50}}}}
 _lightpoint [[setLightFlareMaxDistance]] 100; {{cc|in meter}}

=== Set light brightness ===

==== Set brightness ====
 _lightpoint [[setLightBrightness]] 8;

{{ArgTitle|Set intensity|4|{{GVI|arma3|0.50}}}}
 _lightpoint [[setLightIntensity]] 3000;

{{ArgTitle|Set attenuation|4|{{GVI|arma3|0.50}}}}
 _lightpoint [[setLightAttenuation]] [0, 2, 4, 4, 0, 9, 10]; {{cc|[start, constant, linear, quadratic, hardLimitStart, hardLimitEnd]}}
{{Feature | Informative | Formula is {{ic|1 / (constant + linear × dist + quadratic × dist × dist)}} - see [[setLightAttenuation]] for more information.}}

{{ArgTitle|Make light visible by day|3|{{GVI|arma3|0.50}}}}

 _lightpoint [[setLightDayLight]] [[true]]; {{cc|only for the light itself, not the flare}}

=== Delete lightpoint ===

 [[deleteVehicle]] _lightpoint; {{cc|as simple as that}}

== Full examples ==

=== Dark Souls ===

 [[skipTime]] -[[daytime]];
 
 _lightpoint = "#lightpoint" [[createVehicleLocal]] [0,0,0];
 _lightpoint [[attachTo]] [<nowiki/>[[player]], [0, 0, 1.5]];
 _lightpoint [[setLightColor]] [0,0,0];
 _lightpoint [[setLightAmbient]] [1,0.8, 0.25];
 _lightpoint [[setLightBrightness]] 0.15;

=== Contact ===

 [[skipTime]] -[[daytime]];
 
 [[private]] _position = [[player]] [[modelToWorld]] [0, 20, 1.5];
 [[private]] _lightpoint = "#lightpoint" [[createVehicleLocal]] _position;
 _lightpoint [[setLightColor]] [0,1,1];
 _lightpoint [[setLightAmbient]] [0.2,0.0,0.3];
 _lightpoint [[setLightUseFlare]] [[true]];
 _lightpoint [[setLightFlareSize]] 3;
 _lightpoint [[setLightFlareMaxDistance]] 3.5;
 _lightpoint [[setLightBrightness]] 4;
 _lightpoint [[setLightDayLight]] [[true]];
 
 _lightpoint [[spawn]] {
 	[[while]] { sleep 0.05; [[player]] [[distance]] [[Magic Variables#this|_this]] > 2 } [[do]]
 	{
 		[[Magic Variables#this|_this]] [[setLightBrightness]] 4 [[max]] (40 / ([[player]] [[distance]] [[Magic Variables#this|_this]]));
 	};
 	[[deleteVehicle]] [[Magic Variables#this|_this]];
 };


== See also ==

* [[:Category:Command Group: Lights|Command Group: Lights]]


[[Category:Arma Scripting Tutorials]]
{{GameCategory|arma2|Tutorials}}
{{GameCategory|arma3|Tutorials}}