lightIsOn: Difference between revisions
Jump to navigation
Jump to search
m (VBS2 scripting category removal) |
Lou Montana (talk | contribs) m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>") |
||
(65 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| ofp |= | |game1= ofp | ||
|version1= 1.04 | |||
|1. | |game2= ofpe | ||
|version2= 1.00 | |||
| | |game3= arma1 | ||
|version3= 1.00 | |||
|= | |||
| | |game4= arma2 | ||
|version4= 1.00 | |||
| | |game5= arma2oa | ||
|version5= 1.50 | |||
| | |game6= tkoh | ||
|version6= 1.00 | |||
|game7= arma3 | |||
|version7= 0.50 | |||
| | |gr1= Lights | ||
| | |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.}} | |||
|s1= [[lightIsOn]] lamppost | |||
|p1= lamppost: [[Object]] | |||
|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 | |||
|x1= <sqf>if (lightIsOn nearestObject [player, "StreetLamp"] == "ON") then { hint "nightime"; };</sqf> | |||
</ | |||
< | |x2= <sqf>_it = lightIsOn object 159582;</sqf> | ||
</ | |||
< | |x3= <sqf> | ||
if (count allMissionObjects "StreetLamp" == 0) then { | |||
hint "Objects compatible with 'lightIsOn' are not found."; | |||
} else { | |||
hint "'lightIsOn' compatible objects are found!"; | |||
}; | |||
</sqf> | |||
|seealso= [[switchLight]] | |||
}} | |||
[[ | |||
Latest revision as of 11:34, 3 September 2024
Description
- Description:
- Check if lampost is on (shining).
- 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:
- Example 2:
- Example 3:
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.04
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Lights