lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
Line 55: Line 55:
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]

Revision as of 13:08, 6 April 2020

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

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

Notes

Bottom Section