BIS fnc switchLamp: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (missing bracket in example)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-\r\n]+) *- *S([a-z])" to "$1 - s$2")
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|=
{{RV|type=function
____________________________________________________________________________________________


|Arma3|= Game
|game1= arma3
|version1= 1.64


|1.64|= Game Version (number surrounded by NO SPACES)
|eff= local


|arg= global |= Multiplayer Arguments
|gr1= Object Manipulation


|eff= global |= Multiplayer Effects
|descr= Switch streetlamp on/off.
____________________________________________________________________________________________


| Switch streetlamp on/off |= Description
|s1= [object, state] call [[BIS_fnc_switchLamp]]
____________________________________________________________________________________________


| [_object, _state] [[call]] '''BIS_fnc_switchLamp'''; |= Syntax
|r1= [[Nothing]]


| [[Nothing]] |= RETURNVALUE
|p1= object: [[Object]] - street Lamp


|p1= [[Object]] - Street Lamp |= Parameter 1
|p2= state: [[Boolean]] - true to turn lamp on, false to turn it off


|p2= [[Bool]] - State: True to turn lamp on, false to turn it off|= Parameter 2
|x1= <sqf>
// switches all lamps off in a radius of 200m
private _lampsIn200m = nearestObjects [player, ["Lamps_base_F", "PowerLines_base_F", "PowerLines_Small_base_F"], 200];
{ [_x, false] call BIS_fnc_switchLamp; } forEach _lampsIn200m;
</sqf>


____________________________________________________________________________________________
|x2= <sqf>
 
// simulates a damaged street light
|x1= <code>
aLamp spawn {
{
params [
      [_x,[[true]]] call '''BIS_fnc_switchLamp''';
["_lamp", objNull, [objNull]]
      [[false]];
];
} [[count]] [[nearestObjects]] [ [[player]],["Lamps_base_F","PowerLines_base_F","PowerLines_Small_base_F"],200]
while { player distance _lamp < 200 } do
</code> |= Example 1
 
 
|x1= <code>
{
      [_x,[[false]]] call '''BIS_fnc_switchLamp''';
      [[false]];
} [[count]] [[nearestObjects]] [ [[player]],["Lamps_base_F","PowerLines_base_F","PowerLines_Small_base_F"],200];//Switches all lamps in a radius of 200 off
</code> |= Example 1
 
|x2= <code>
[[spawn]] {
private _lamp = [[param]] [0, [[objNull]],[ [[objNull]] ]];
[[while]] {[[player]] [[distance]] _lamp < 200} [[do]]
{
{
[_lamp, [[selectRandom]] [ [[true]], [[false]] ]] [[call]] '''BIS_fnc_switchLamp''';
[_lamp, selectRandom [true, false]] call BIS_fnc_switchLamp;
[[sleep]] 0.1 + [[random]] 0.5;
sleep 0.1 + random 0.5;
};//Simulates a damaged street light
};
};
};
</code> |= Example 2
</sqf>
____________________________________________________________________________________________
 
| SEEALSO |= See Also


|seealso= [[switchLight]]
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]

Latest revision as of 14:44, 8 November 2023

Arma 3 logo black.png1.64
LELocal
Hover & click on the images for description

Description

Description:
Switch streetlamp on/off.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object, state] call BIS_fnc_switchLamp
Parameters:
object: Object - street Lamp
state: Boolean - true to turn lamp on, false to turn it off
Return Value:
Nothing

Examples

Example 1:
// switches all lamps off in a radius of 200m private _lampsIn200m = nearestObjects [player, ["Lamps_base_F", "PowerLines_base_F", "PowerLines_Small_base_F"], 200]; { [_x, false] call BIS_fnc_switchLamp; } forEach _lampsIn200m;
Example 2:
// simulates a damaged street light aLamp spawn { params [ ["_lamp", objNull, [objNull]] ]; while { player distance _lamp < 200 } do { [_lamp, selectRandom [true, false]] call BIS_fnc_switchLamp; sleep 0.1 + random 0.5; }; };

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_switchLamp&oldid=348593"