switchLight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<tt>([a-zA-Z0-9\. _"']+)<\/tt>" to "{{hl|$1}}")
m (Some wiki formatting)
(25 intermediate revisions by 4 users not shown)
Line 27: Line 27:


|descr= Controls whether a lamp is lit or not.
|descr= Controls whether a lamp is lit or not.
{{Feature|arma3|This command was originally designed to only work with {{hl|CfgNonAIVehicles}} class {{hl|"StreetLamp"}} only.
{{Feature|arma3|
Since {{arma3}} v1.92 this command was extended to work with street lights.}}
This command was originally designed to only work with {{hl|CfgNonAIVehicles}} class {{hl|"StreetLamp"}} only.
Since {{arma3}} v1.92 this command was extended to work with street lights and some prop lights, like portable construction light.
}}


|s1= lamp [[switchLight]] mode
|s1= lamp [[switchLight]] mode
Line 34: Line 36:
|p1= lamp: [[Object]]
|p1= lamp: [[Object]]


|p2= mode: [[String]] - Mode can be: "ON", "OFF" or "AUTO" (''lamp'' is on only during nighttime, default)
|p2= mode: [[String]] - mode can be: "ON", "OFF" or "AUTO" (''lamp'' is on only during nighttime, default)


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>([[object]] 12345) [[switchLight]] "OFF";</code>
|x1= <sqf>(object 12345) switchLight "OFF";</sqf>


|x2= <code>[[nearestObject]] [<nowiki/>[[player]], "Streetlamp"] [[switchLight]] "OFF";</code>
|x2= <sqf>nearestObject [player, "Streetlamp"] switchLight "OFF";</sqf>


|x3= <code>[[cursorObject]] [[switchLight]] "ON";</code>
|x3= <sqf>cursorObject switchLight "ON";</sqf>
|seealso= [[lightIsOn]] [[BIS_fnc_switchLamp]]
|seealso= [[lightIsOn]] [[BIS_fnc_switchLamp]]
}}
}}


<dl class="command_description">
{{Note
 
|user= Killzone_Kid
<dt><dt>
|timestamp= 20130916111400
<dd class="notedate">Posted on September 16, 2013</dd>
|text= ''Before {{arma3}} v1.92'' use [[setHit]] instead:
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<sqf>
<dd class="note">
_lamp = nearestObject [player, "Lamps_base_F"];
''Before {{arma3}} v1.92'' use [[setHit]] instead:
_lamp setHit ["light_1_hitpoint", 0.97]; // off
<code>_lamp = [[nearestObject]] [<nowiki/>[[player]], "Lamps_base_F"];
_lamp setHit ["light_1_hitpoint", 0]; // on
_lamp [[setHit]] ["light_1_hitpoint", 0.97]; {{cc|off}}
</sqf>
_lamp [[setHit]] ["light_1_hitpoint", 0]; {{cc|on}}</code>


Switch all lights off in the 500 radius of player:
Switch all lights off in the 500 radius of player:
<code>[[private]] _lamps = [[nearestObjects]] [<nowiki/>[[player]], ["Lamps_base_F", "PowerLines_base_F", "PowerLines_Small_base_F"], 500];
<sqf>
private _lamps = nearestObjects [player, ["Lamps_base_F", "PowerLines_base_F", "PowerLines_Small_base_F"], 500];


{
{
[[for]] "_i" [[from]] 0 [[to]] [[count]] [[getAllHitPointsDamage]] _x -1 [[do]]
for "_i" from 0 to (count getAllHitPointsDamage _x -1) do
{
{
_x [[setHitIndex]] [_i, 0.97];
_x setHitIndex [_i, 0.97];
};
};
} [[forEach]] _lamps;</code>
} forEach _lamps;</sqf>
</dl>
}}
 
{{Note
|user= Samatra
|timestamp= 20230301141231
|text= How to disable all lamps using the latest {{arma3}} commands, a modern method. Disable all lights that are pre-placed on the map, on the entire map:
<sqf>
{
_x switchLight "OFF";
} forEach (1 allObjects 0);
</sqf>
 
Disable all script-spawned and editor-placed lamps:
<sqf>
{
_x switchLight "OFF";
} forEach (8 allObjects 0);
</sqf>
These snippets iterate through all buildings and run [[switchLight]] on them. If they're lamps, they'll be turned off.
}}

Revision as of 12:56, 12 March 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Controls whether a lamp is lit or not.
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 and some prop lights, like portable construction light.
Groups:
Lights

Syntax

Syntax:
lamp switchLight mode
Parameters:
lamp: Object
mode: String - mode can be: "ON", "OFF" or "AUTO" (lamp is on only during nighttime, default)
Return Value:
Nothing

Examples

Example 1:
(object 12345) switchLight "OFF";
Example 2:
nearestObject [player, "Streetlamp"] switchLight "OFF";
Example 3:
cursorObject switchLight "ON";

Additional Information

See also:
lightIsOn BIS_fnc_switchLamp

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
Killzone_Kid - c
Posted on Sep 16, 2013 - 11:14 (UTC)
Before Arma 3 v1.92 use setHit instead:
_lamp = nearestObject [player, "Lamps_base_F"]; _lamp setHit ["light_1_hitpoint", 0.97]; // off _lamp setHit ["light_1_hitpoint", 0]; // on
Switch all lights off in the 500 radius of player:
private _lamps = nearestObjects [player, ["Lamps_base_F", "PowerLines_base_F", "PowerLines_Small_base_F"], 500]; { for "_i" from 0 to (count getAllHitPointsDamage _x -1) do { _x setHitIndex [_i, 0.97]; }; } forEach _lamps;
Samatra - c
Posted on Mar 01, 2023 - 14:12 (UTC)
How to disable all lamps using the latest Arma 3 commands, a modern method. Disable all lights that are pre-placed on the map, on the entire map:
{ _x switchLight "OFF"; } forEach (1 allObjects 0);
Disable all script-spawned and editor-placed lamps:
{ _x switchLight "OFF"; } forEach (8 allObjects 0);
These snippets iterate through all buildings and run switchLight on them. If they're lamps, they'll be turned off.
Retrieved from "https://community.bistudio.com/wiki?title=switchLight&oldid=353038"