lightIsOn: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
| Line 7: | Line 6: | ||
|gr1 = Lights |GROUP1= | |gr1 = Lights |GROUP1= | ||
| Check if lampost is on (shining). | | Check if lampost is on (shining). | ||
| Line 13: | Line 11: | ||
{{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.}} |DESCRIPTION= | ||
| [[lightIsOn]] lamppost |SYNTAX= | | [[lightIsOn]] lamppost |SYNTAX= | ||
| Line 25: | Line 22: | ||
* '''"ERROR"''' - if command fails|RETURNVALUE= | * '''"ERROR"''' - if command fails|RETURNVALUE= | ||
|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> |EXAMPLE1= | ||
| Line 36: | Line 32: | ||
[[hint]] "'lightIsOn' compatible objects are found!"; | [[hint]] "'lightIsOn' compatible objects are found!"; | ||
};</code>|EXAMPLE3= | };</code>|EXAMPLE3= | ||
| [[switchLight]] |SEEALSO= | | [[switchLight]] |SEEALSO= | ||
Revision as of 02:55, 17 January 2021
Description
- Description:
- Check if lampost is on (shining).
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
Notes
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.04
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Lights
- Scripting Commands OFP 1.46
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.99
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands