lightIsOn: Difference between revisions

Latest revision as of 11:34, 3 September 2024

1.04

1.00

1.50

1.00

0.50

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).

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| ofp
+|game1= ofp
-|1.04
+|version1= 1.04
 |game2= ofpe
@@ Line 24: / Line 24: @@
 |gr1= Lights
-| Check if lampost is on (shining).
+|descr= Check if lampost is on (shining).
-{{Feature | Informative | A lamp state is '''local''' to each client (see [[switchLight]]).}}
+{{Feature|informative|A lamp state is '''local''' to each client (see [[switchLight]]).}}
 {{Feature | arma3 | This command was originally designed to only work with CfgNonAIVehicles class "StreetLamp" only;
 since {{arma3}} v1.92 this command was extended to work with street lights.}}
-|s1=  [[lightIsOn]] lamppost
+|s1= [[lightIsOn]] lamppost
 |p1= lamppost: [[Object]]
-| [[String]] - Can be one of:
+|r1= [[String]] - can be one of:
 * '''"ON"''' - light is on
 * '''"OFF"''' - light is off
@@ Line 39: / Line 39: @@
 * '''"ERROR"''' - if command fails
-|x1= <code>[[if]] ([[lightIsOn]] [[nearestObject]] [<nowiki/>[[player]], "StreetLamp"] == "ON") [[then]] { [[hint]] "nightime"; };</code>
+|x1= <sqf>if (lightIsOn nearestObject [player, "StreetLamp"] == "ON") then { hint "nightime"; };</sqf>
-|x2= <code>_it = lightIsOn [[object]] 159582</code>
+|x2= <sqf>_it = lightIsOn object 159582;</sqf>
-|x3= <code>[[if]] ([[count]] [[allMissionObjects]] "StreetLamp" == 0) [[then]] {
+|x3= <sqf>
-	[[hint]] "Objects compatible with 'lightIsOn' are not found.";
+if (count allMissionObjects "StreetLamp" == 0) then {
-} [[else]] {
+	hint "Objects compatible with 'lightIsOn' are not found.";
-	[[hint]] "'lightIsOn' compatible objects are found!";
+} else {
-};</code>
+	hint "'lightIsOn' compatible objects are found!";
+};
+</sqf>
 |seealso= [[switchLight]]
 }}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}