lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Fix description and MP effects)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Check if lampost is on (shining). Originally was intended for working with CfgNonAIVehicles class "StreetLamp" only. Since Arma 3 v1.92 it could return the state of Arma 3 street lights. Possible values are:
| Check if lampost is on (shining).
* '''"ON"''' - light is on
{{Informative | A lamp state is '''local''' to each client (see [[switchLight]]).}}
* '''"OFF"''' - light is off
{{Feature arma3 | This command was originally designed to only work with CfgNonAIVehicles class "StreetLamp" only;
* '''"AUTO"''' - applicable only to the light of type "StreetLamp" and is only on during the night.
since {{arma3}} v1.92 this command was extended to work with street lights.}} |DESCRIPTION=
* '''"ERROR"''' - when command fails
 
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''lightIsOn''' lamppost |SYNTAX=
| [[lightIsOn]] lamppost |SYNTAX=


|p1= lamppost: [[Object]] |PARAMETER1=
|p1= lamppost: [[Object]] |PARAMETER1=


| [[String]] |RETURNVALUE=
| [[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|RETURNVALUE=


____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>?'''lightIsOn''' [[nearestObject]] <nowiki>[</nowiki>[[player]], "StreetLamp"] <nowiki>==</nowiki> "ON" :hint "nightime"</code> |EXAMPLE1=
|x1= <code>[[if]] ([[lightIsOn]] [[nearestObject]] [<nowiki/>[[player]], "StreetLamp"] == "ON") [[then]] { [[hint]] "nightime"; };</code> |EXAMPLE1=
 
|x2= <code>_it <nowiki>=</nowiki> lightIsOn [[object]] 159582</code> |EXAMPLE2=
|x2= <code>_it <nowiki>=</nowiki> lightIsOn [[object]] 159582</code> |EXAMPLE2=
|x3 = <code>[[if]] ([[count]] [[allMissionObjects]] "StreetLamp" == 0) [[then]] {
 
|x3= <code>[[if]] ([[count]] [[allMissionObjects]] "StreetLamp" == 0) [[then]] {
[[hint]] "Objects compatible with 'lightIsOn' are not found.";
[[hint]] "Objects compatible with 'lightIsOn' are not found.";
} [[else]] {
} [[else]] {
[[hint]] "'lightIsOn' compatible objects are found!";
[[hint]] "'lightIsOn' compatible objects are found!";
};</code>|=
};</code>|EXAMPLE3=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[switchLight]] |SEEALSO=
| [[switchLight]] |SEEALSO=
}}
}}


Line 40: Line 42:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on August 4, 2006 - 10:56
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''Notes from before the conversion:''
Use [[switchLight]] to turn lamposts on and off.


<!-- Note Section END -->
<!-- Note Section END -->
Line 52: Line 48:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|LIGHTISON]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|LIGHTISON]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|LIGHTISON]]
[[Category:Scripting Commands ArmA|LIGHTISON]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{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}}}}]]

Revision as of 21:24, 9 October 2019

Logo A0.png1.04
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

Retrieved from "https://community.bistudio.com/wiki?title=lightIsOn&oldid=138112"