lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)<nowiki\/?>([^<]*)<\/code>" to "<code>$1$2</code>")
m (Text replacement - "\|x([0-9]) *= * <code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
Line 39: Line 39:
* '''"ERROR"''' - if command fails
* '''"ERROR"''' - if command fails


|x1= <code>if (lightIsOn nearestObject [player, "StreetLamp"] == "ON") then { hint "nightime"; };</code>
|x1= <sqf>if (lightIsOn nearestObject [player, "StreetLamp"] == "ON") then { hint "nightime"; };</sqf>


|x2= <sqf>_it = lightIsOn object 159582</sqf>
|x2= <sqf>_it = lightIsOn object 159582</sqf>

Revision as of 10:38, 13 May 2022

Hover & click on the images for description

Description

Description:
Check if lampost is on (shining).
A lamp state is local to each client (see switchLight).
Arma 3
This command was originally designed to only work with CfgNonAIVehicles class "StreetLamp" only; since Arma 3 v1.92 this command was extended to work with street lights.
Groups:
Lights

Syntax

Syntax:
lightIsOn lamppost
Parameters:
lamppost: Object
Return Value:
String - Can be one of:
  • "ON" - light is on
  • "OFF" - light is off
  • "AUTO" - applicable only to the light of type "StreetLamp" and is only on during the night.
  • "ERROR" - if command fails

Examples

Example 1:
if (lightIsOn nearestObject [player, "StreetLamp"] == "ON") then { hint "nightime"; };
Example 2:
_it = lightIsOn object 159582
Example 3:
if (count allMissionObjects "StreetLamp" == 0) then { hint "Objects compatible with 'lightIsOn' are not found."; } else { hint "'lightIsOn' compatible objects are found!"; };

Additional Information

See also:
switchLight

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