lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.04


|1.04|Game version=
|game2= ofpe
|version2= 1.00


|gr1 = Lights |GROUP1=
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Check if lampost is on (shining).
|game4= arma2
{{Informative | A lamp state is '''local''' to each client (see [[switchLight]]).}}
|version4= 1.00
{{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.}} |DESCRIPTION=
____________________________________________________________________________________________


| [[lightIsOn]] lamppost |SYNTAX=
|game5= arma2oa
|version5= 1.50


|p1= lamppost: [[Object]] |PARAMETER1=
|game6= tkoh
|version6= 1.00


| [[String]] - Can be one of:
|game7= arma3
* '''"ON"''' - light is on
|version7= 0.50
* '''"OFF"''' - light is off
* '''"AUTO"''' - applicable only to the light of type "StreetLamp" and is only on during the night.
* '''"ERROR"''' - if command fails|RETURNVALUE=


____________________________________________________________________________________________
|gr1= Lights


|x1= <code>[[if]] ([[lightIsOn]] [[nearestObject]] [<nowiki/>[[player]], "StreetLamp"] == "ON") [[then]] { [[hint]] "nightime"; };</code> |EXAMPLE1=
|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.}}


|x2= <code>_it = lightIsOn [[object]] 159582</code> |EXAMPLE2=
|s1= [[lightIsOn]] lamppost


|x3= <code>[[if]] ([[count]] [[allMissionObjects]] "StreetLamp" == 0) [[then]] {
|p1= lamppost: [[Object]]
[[hint]] "Objects compatible with 'lightIsOn' are not found.";
} [[else]] {
[[hint]] "'lightIsOn' compatible objects are found!";
};</code>|EXAMPLE3=
____________________________________________________________________________________________


| [[switchLight]] |SEEALSO=
|r1= [[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


<h3 style="display:none">Notes</h3>
|x1= <sqf>if (lightIsOn nearestObject [player, "StreetLamp"] == "ON") then { hint "nightime"; };</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>_it = lightIsOn object 159582;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x3= <sqf>
if (count allMissionObjects "StreetLamp" == 0) then {
hint "Objects compatible with 'lightIsOn' are not found.";
} else {
hint "'lightIsOn' compatible objects are found!";
};
</sqf>


[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
|seealso= [[switchLight]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

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"