isLightOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|1.32|Game version=
|1.32


|gr1 = Lights |GROUP1=
|gr1 = Lights


|arg= global|arguments=
|arg= global|arguments=


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


| [[isLightOn]] vehicle |SYNTAX1=
| [[isLightOn]] vehicle


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


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


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


|p21= vehicle: [[Object]] - vehicle with search light on a turret |PARAMETER21=
|p21= vehicle: [[Object]] - vehicle with search light on a turret |PARAMETER21=
Line 24: Line 24:
|p22= turret: [[Array]] - turret path |PARAMETER22=
|p22= turret: [[Array]] - turret path |PARAMETER22=


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


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


|x2= <code>_pilotLightOn = [[isLightOn]] heli;</code>|EXAMPLE2=
|x2= <code>_pilotLightOn = [[isLightOn]] heli;</code>


|x3= <code>_searchLightOn = [[isLightOn]] [heli, [0]];</code>|EXAMPLE3=
|x3= <code>_searchLightOn = [[isLightOn]] [heli, [0]];</code>




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


|  |MPBEHAVIOUR=
|  |MPBEHAVIOUR=

Revision as of 00:42, 18 January 2021

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