isLightOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|1.31|= Game version
|gr1= Lights


|arg= global|=
|arg= global
____________________________________________________________________________________________


| Returns [[true]] if vehicle headlights are on otherwise [[false]]. |= Description
|descr= Returns [[true]] if vehicle headlights are on otherwise [[false]].
____________________________________________________________________________________________


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


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


| [[Boolean]] |= RETURNVALUE
|r1= [[Boolean]]


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


|x1= <code>_lightsOn = [[isLightOn]] [[vehicle]] [[player]];</code>|= EXAMPLE1
|s2since= arma3 1.94
|x2= <code>_pilotLightOn = [[isLightOn]] heli;</code>|= EXAMPLE1


____________________________________________________________________________________________
|p21= vehicle: [[Object]] - vehicle with search light on a turret


| [[setPilotLight]], [[isCollisionLightOn]], [[setCollisionLight]], [[isIRLaserOn]] |= SEEALSO
|p22= turret: [[Array]] - turret path


| |= MPBEHAVIOUR
|r2= [[Boolean]]
____________________________________________________________________________________________
 
}}
|x1= <sqf>_headlightsOn = isLightOn vehicle player;</sqf>


<h3 style='display:none'>Notes</h3>
|x2= <sqf>_pilotLightOn = isLightOn heli;</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= <sqf>_searchLightOn = isLightOn [heli, [0]];</sqf>
</dl>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[setPilotLight]] [[isCollisionLightOn]] [[setCollisionLight]] [[isIRLaserOn]]
[[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 14:31, 1 March 2023

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