lightIsOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(works with arma 3 lights now)
m (template:command argument fix)
Line 13: Line 13:
* '''"ERROR"''' - when command fails
* '''"ERROR"''' - when command fails


|= Description
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''lightIsOn''' lamppost |= Syntax
| '''lightIsOn''' lamppost |SYNTAX=


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


| [[String]] |= Return value
| [[String]] |RETURNVALUE=


____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>?'''lightIsOn''' [[nearestObject]] <nowiki>[</nowiki>[[player]], "StreetLamp"] <nowiki>==</nowiki> "ON" :hint "nightime"</code> |= Example 1
|x1= <code>?'''lightIsOn''' [[nearestObject]] <nowiki>[</nowiki>[[player]], "StreetLamp"] <nowiki>==</nowiki> "ON" :hint "nightime"</code> |EXAMPLE1=
|x2= <code>_it <nowiki>=</nowiki> lightIsOn [[object]] 159582</code> |= Example 2
|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.";
Line 33: Line 33:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[switchLight]] |= See also
| [[switchLight]] |SEEALSO=


}}
}}

Revision as of 14:42, 7 April 2019

Logo A0.png1.04
Hover & click on the images for description

Description

Description:
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:
  • "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" - when command fails
Groups:
Uncategorised

Syntax

Syntax:
lightIsOn lamppost
Parameters:
lamppost: Object
Return Value:
String

Examples

Example 1:
?lightIsOn nearestObject [player, "StreetLamp"] == "ON" :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

Posted on August 4, 2006 - 10:56
hardrock
Notes from before the conversion: Use switchLight to turn lamposts on and off.

Bottom Section

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