lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.04|Game version=
|1.04


|gr1 = Lights |GROUP1=
|gr1 = Lights


| Check if lampost is on (shining).
| Check if lampost is on (shining).
{{Informative | A lamp state is '''local''' to each client (see [[switchLight]]).}}
{{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;
{{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=
since {{arma3}} v1.92 this command was extended to work with street lights.}}


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


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


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




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


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


|x3= <code>[[if]] ([[count]] [[allMissionObjects]] "StreetLamp" == 0) [[then]] {
|x3= <code>[[if]] ([[count]] [[allMissionObjects]] "StreetLamp" == 0) [[then]] {
Line 31: Line 31:
} [[else]] {
} [[else]] {
[[hint]] "'lightIsOn' compatible objects are found!";
[[hint]] "'lightIsOn' compatible objects are found!";
};</code>|EXAMPLE3=
};</code>


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


Revision as of 01:02, 18 January 2021

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

Bottom Section

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