lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(84 intermediate revisions by 14 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#L|COMREF]]
{{RV|type=command


<h2 style="color:#000066"> '''lightIsOn ''lamppost'''''</h2>
|game1= ofp
|version1= 1.04


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''lamppost:''' [[Object]]
|game4= arma2
|version4= 1.00


'''Type of returned value:'''
|game5= arma2oa
|version5= 1.50


[[String]]
|game6= tkoh
|version6= 1.00


'''Compatibility:'''
|game7= arma3
|version7= 0.50


Added in version '''1.04'''
|gr1= Lights


'''Description:'''
|descr= Check if lampost is on (shining).
{{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.}}


Check if lampost is on (shining).
|s1= [[lightIsOn]] lamppost


Possible values are:
|p1= lamppost: [[Object]]


* '''"ON"'''
|r1= [[String]] - can be one of:
* '''"OFF"'''
* '''"ON"''' - light is on
* '''"AUTO"''' (auto is only on during the night).
* '''"OFF"''' - light is off
* '''"AUTO"''' - applicable only to the light of type "StreetLamp" and is only on during the night.
* '''"ERROR"''' - if command fails


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


'''Examples:'''
|x2= <sqf>_it = lightIsOn object 159582;</sqf>


'''lightIsOn''' [[nearestObject]] [[[player]], "StreetLamp"] != '''"OFF"'''
|x3= <sqf>
if (count allMissionObjects "StreetLamp" == 0) then {
hint "Objects compatible with 'lightIsOn' are not found.";
} else {
hint "'lightIsOn' compatible objects are found!";
};
</sqf>


_it = '''lightIsOn''' [[object]] 159582
|seealso= [[switchLight]]
 
}}
 
'''Comments:'''
 
Use [[switchLight]] to turn lamposts on and off.

Latest revision as of 11:34, 3 September 2024

Logo A0.png1.04ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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).
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
Retrieved from "https://community.bistudio.com/wiki?title=lightIsOn&oldid=369182"