isLightOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|arg= global|=" to "|arg= global|arguments=")
Line 10: Line 10:


| Returns [[true]] if vehicle headlights are on otherwise [[false]].   
| 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=
{{Informative | 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=
| [[isLightOn]] vehicle |SYNTAX1=


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


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


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


|p21= [vehicle, turret]: [[Array]] |PARAMETER21=  
|p21= vehicle: [[Object]] - vehicle with search light on a turret |PARAMETER21=


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


|r2= [[Boolean]] |RETURNVALUE2=  
|r2= [[Boolean]] |RETURNVALUE2=


|x1= <code>_headlightsOn = [[isLightOn]] [[vehicle]] [[player]];</code>|EXAMPLE1=


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


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[setPilotLight]], [[isCollisionLightOn]], [[setCollisionLight]], [[isIRLaserOn]] |SEEALSO=  
| [[setPilotLight]], [[isCollisionLightOn]], [[setCollisionLight]], [[isIRLaserOn]] |SEEALSO=


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 49: Line 48:


<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Lights]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 00:17, 20 July 2020

Hover & click on the images for description

Description

Description:
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).
Groups:
Uncategorised

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:
setPilotLightisCollisionLightOnsetCollisionLightisIRLaserOn

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

Notes

Bottom Section