setLightColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Some wiki formatting)
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= ofpe
|version1= 1.00


|1.00|Game version=
|game2= arma1
|version2= 1.00


|gr1 = Lights |GROUP1=
|game3= arma2
|version3= 1.00


|arg= local |MPARGUMENTS=
|game4= arma2oa
|version4= 1.50


|eff= local |Multiplayer Effects=
|game5= tkoh
____________________________________________________________________________________________
|version5= 1.00


| Set diffuse color of light. Illuminates surfaces that are facing the light. |DESCRIPTION=
|game6= arma3
____________________________________________________________________________________________
|version6= 0.50


| light [[setLightColor]] [r, g, b] |SYNTAX=
|gr1= Lights


|p1= light: [[Object]] |PARAMETER1=
|arg= local


|p2= [r, g, b]: [[Array]] of [[Number]]s |PARAMETER2=
|eff= local


| [[Nothing]] |RETURNVALUE=
|descr= Set diffuse color of light. Illuminates surfaces that are facing the light.


|x1= <code>myLight setLightColor [0.5,0,0]; {{cc|produces red}}</code> |EXAMPLE1=
|s1= light [[setLightColor]] [r, g, b]
____________________________________________________________________________________________


| [[setLightAmbient]], [[setLightBrightness]], [[lightAttachObject]], [[lightDetachObject]], [[setLightIntensity]], [[setLightAttenuation]], [[setLightUseFlare]], [[setLightFlareSize]], [[setLightFlareMaxDistance]], [[setLightDayLight]] |SEEALSO=
|p1= light: [[Object]]


|p2= r: [[Number]] - red value in range 0..1
|p3= g: [[Number]] - green value in range 0..1
|p4= b: [[Number]] - blue value in range 0..1
|r1= [[Nothing]]
|x1= <sqf>myLight setLightColor [0.5,0,0]; // produces red</sqf>
|seealso= [[setLightAmbient]] [[setLightBrightness]] [[lightAttachObject]] [[lightDetachObject]] [[setLightIntensity]] [[setLightAttenuation]] [[setLightUseFlare]] [[setLightFlareSize]] [[setLightFlareMaxDistance]] [[setLightDayLight]] [[setLightIR]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Feersum
<!-- Note Section BEGIN -->
|timestamp= 20061201164200
<dd class="notedate">Posted on Dec 1, 2006 - 16:42
|text= Light can be created with command [[createVehicleLocal]] with special vehicle class {{hl|"#lightpoint"}}<br>
<dt class="note">[[User:Feersum|Feersum]]<dd class="note">
for example:
Light can be created with command [[createVehicleLocal]] with special vehicle class "#lightpoint"
<sqf>
<br>for example:
_light = "#lightpoint" createVehicleLocal pos;
<code>_light = "#lightpoint" [[createVehicleLocal]] pos;
_light setLightBrightness 1.0;
_light [[setLightBrightness]] 1.0;
_light setLightAmbient [0.0, 1.0, 0.0];
_light [[setLightAmbient]] [0.0, 1.0, 0.0];
_light setLightColor [0.0, 1.0, 0.0];
_light [[setLightColor]] [0.0, 1.0, 0.0];
_light lightAttachObject [_object, [0,0,0]];
_light [[lightAttachObject]] [_object, [0,0,0]];
</sqf>
</code>
}}
<dd class="notedate">Posted on Aug 17, 2007 - 07:15
 
<dt class="note">[[User:ColonelSandersLite|ColonelSandersLite]]<dd class="note"><br>
{{Note
To clarify:<br>
|user= ColonelSandersLite
[[setLightAmbient]] - Terrain and surrounding objects are bathed in this colour.<br>
|timestamp= 20170817071500
[[setLightColor]] - Controls the "haze" seen around the lightsource (ex flares).<br>
|text= To clarify:
<dd class="notedate">Posted on Mar 24, 2014 - 23:58
* [[setLightAmbient]] - Terrain and surrounding objects are bathed in this colour.
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]<dd class="note">1. In ArmA3 ver 1.14 [[setLightColor]] will also change the color of the flare when [[setLightUseFlare]], [[setLightFlareSize]] and [[setLightFlareMaxDistance]] were used on the same light source. For example:
* [[setLightColor]] - Controls the "haze" seen around the lightsource (ex flares).
<code>
}}
_light [[setLightUseFlare]] true;
_light [[setLightFlareSize]] 2;
_light [[setLightFlareMaxDistance]] 60;
_light [[setLightColor]] [1, 1, 1];
</code><br>
2. When both [[setLightAmbient]] and [[setLightColor]] were [0,0,0], there won’t be any visual presentation on the light source.
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= ffur2007slx2_5
{{GameCategory|ofpe|Scripting Commands}}
|timestamp= 20140324235800
{{GameCategory|arma1|Scripting Commands}}
|text= 1. In {{arma3}} ver 1.14 [[setLightColor]] will also change the color of the flare when [[setLightUseFlare]], [[setLightFlareSize]] and [[setLightFlareMaxDistance]] were used on the same light source. For example:
{{GameCategory|arma2|Scripting Commands}}
<sqf>
{{GameCategory|arma3|Scripting Commands}}
_light setLightUseFlare true;
{{GameCategory|tkoh|Scripting Commands}}
_light setLightFlareSize 2;
_light setLightFlareMaxDistance 60;
_light setLightColor [1, 1, 1];
</sqf><br>
2. When both [[setLightAmbient]] and [[setLightColor]] are [0,0,0], there won’t be any visual presentation on the light source.
}}

Latest revision as of 12:42, 25 April 2022

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
Set diffuse color of light. Illuminates surfaces that are facing the light.
Groups:
Lights

Syntax

Syntax:
light setLightColor [r, g, b]
Parameters:
light: Object
r: Number - red value in range 0..1
g: Number - green value in range 0..1
b: Number - blue value in range 0..1
Return Value:
Nothing

Examples

Example 1:
myLight setLightColor [0.5,0,0]; // produces red

Additional Information

See also:
setLightAmbient setLightBrightness lightAttachObject lightDetachObject setLightIntensity setLightAttenuation setLightUseFlare setLightFlareSize setLightFlareMaxDistance setLightDayLight setLightIR

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Feersum - c
Posted on Dec 01, 2006 - 16:42 (UTC)
Light can be created with command createVehicleLocal with special vehicle class "#lightpoint"
for example:
_light = "#lightpoint" createVehicleLocal pos; _light setLightBrightness 1.0; _light setLightAmbient [0.0, 1.0, 0.0]; _light setLightColor [0.0, 1.0, 0.0]; _light lightAttachObject [_object, [0,0,0]];
ColonelSandersLite - c
Posted on Aug 17, 2017 - 07:15 (UTC)
To clarify:
  • setLightAmbient - Terrain and surrounding objects are bathed in this colour.
  • setLightColor - Controls the "haze" seen around the lightsource (ex flares).
ffur2007slx2_5 - c
Posted on Mar 24, 2014 - 23:58 (UTC)
1. In Arma 3 ver 1.14 setLightColor will also change the color of the flare when setLightUseFlare, setLightFlareSize and setLightFlareMaxDistance were used on the same light source. For example:
_light setLightUseFlare true; _light setLightFlareSize 2; _light setLightFlareMaxDistance 60; _light setLightColor [1, 1, 1];

2. When both setLightAmbient and setLightColor are [0,0,0], there won’t be any visual presentation on the light source.
Retrieved from "https://community.bistudio.com/wiki?title=setLightColor&oldid=309010"