isLightOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
m (Some wiki formatting)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.32


|1.32|= Game version
|gr1= Lights


|arg= global|=
|arg= global
____________________________________________________________________________________________


| Returns [[true]] if vehicle headlights are on otherwise [[false]].
|descr= Returns [[true]] if vehicle headlights are on otherwise [[false]].
* Since Arma 3 v1.94 it is possible to get the status of a search light on a turret (see alt syntax) |DESCRIPTION=
____________________________________________________________________________________________


| '''isLightOn''' vehicle |SYNTAX1=
|s1= [[isLightOn]] vehicle


|p1= vehicle: [[Object]] - vehicle with headlights |PARAMETER1=
|p1= vehicle: [[Object]] - vehicle with headlights


| [[Boolean]] |RETURNVALUE1=
|r1= [[Boolean]]


|s2= '''isLightOn''' [vehicle, turret] |SYNTAX2=
|s2= [[isLightOn]] [vehicle, turret]


|p21= [vehicle, turret]: [[Array]] |PARAMETER21=  
|s2since= arma3 1.94


|p22= vehicle: [[Object]] - vehicle with search light on a turret |PARAMETER22=
|p21= vehicle: [[Object]] - vehicle with search light on a turret
|p23= turret: [[Array]] - turret path |PARAMETER23=


|r2= [[Boolean]] |RETURNVALUE2=
|p22= turret: [[Array]] - turret path


|r2= [[Boolean]]


|x1= <code>_headlightsOn = [[isLightOn]] [[vehicle]] [[player]];</code>|EXAMPLE1=
|x1= <sqf>_headlightsOn = isLightOn vehicle player;</sqf>
|x2= <code>_pilotLightOn = [[isLightOn]] heli;</code>|EXAMPLE2=
|x3= <code>_searchLightOn = [[isLightOn]] [heli, [0]];</code>|EXAMPLE3=


____________________________________________________________________________________________
|x2= <sqf>_pilotLightOn = isLightOn heli;</sqf>


| [[setPilotLight]], [[isCollisionLightOn]], [[setCollisionLight]], [[isIRLaserOn]] |SEEALSO=
|x3= <sqf>_searchLightOn = isLightOn [heli, [0]];</sqf>


| |MPBEHAVIOUR=  
|seealso= [[setPilotLight]] [[isCollisionLightOn]] [[setCollisionLight]] [[isIRLaserOn]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:31, 1 March 2023

Arma 3 logo black.png1.32
GAGlobal
Hover & click on the images for description

Description

Description:
Returns true if vehicle headlights are on otherwise false.
Groups:
Lights

Syntax

Syntax:
isLightOn vehicle
Parameters:
vehicle: Object - vehicle with headlights
Return Value:
Boolean

Alternative Syntax

Syntax:
isLightOn [vehicle, turret]
Parameters:
vehicle: Object - vehicle with search light on a turret
turret: Array - turret path
Return Value:
Boolean

Examples

Example 1:
_headlightsOn = isLightOn vehicle player;
Example 2:
_pilotLightOn = isLightOn heli;
Example 3:
_searchLightOn = isLightOn [heli, [0]];

Additional Information

See also:
setPilotLight isCollisionLightOn setCollisionLight isIRLaserOn

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
Retrieved from "https://community.bistudio.com/wiki?title=isLightOn&oldid=338377"