BIN fnc empVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " --> |= Syntax" to " --> |Syntax=")
(Page filling)
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.94


|1.94|Game version=
|gr1= Contact
____________________________________________________________________________________________


| <pre>/*
|descr= Sets EMP parameters to a vehicle. Destroys lights and optionally prevents vehicle from starting


Description: Sets EMP parameters to a vehicle. Destroys lights and optionally prevents vehicle from starting
{{Feature|informative|The player has to be defined as <sqf inline>BIN_player</sqf> for the voice lines to be spoken.}}
{{Feature|arma3contact}}


Parameter(s):
|s1= [obj, destroyEngine, aiExit] call [[BIN_fnc_empVehicle]]
0: OBJECT - Vehicle that will get destroyed electronics
1: (Optional): BOOL - Sets engine destroyed - true = engine destroyed, false = engine operating (default: true)
2: (Optional): BOOL - Handle AI in EMP vehicle - true = AI will exit vehicle and not enter new vehicles, false = AI will remain in vehicle (default: true)


Note that the player has to be defined as bin_player for the voice lines to be spoken
|p1= obj: [[Object]] - the vehicle


Examples:
|p2= destroyEngine: [[Boolean]] - (Optional, default [[true]]) [[true]] to destroys the engine, [[false]] to have it working


[bin_vehicle,true,true] call bin_fnc_empVehicle; //Destroys lights and prevents vehicle from starting, AI will exit vehicle after it has stopped
|p3= aiExit: [[Boolean]] - (Optional, default [[true]]) AI behaviour in vehicle; [[true]] to make them exit the vehicle, [[false]] to remain in it


[bin_vehicle,false,false] call bin_fnc_empVehicle; //Destroys lights, but engine can still start and vehicle can be driven, AI will remain in vehicle
|r1=
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |Description=
|x1= <sqf>[_enemyVehicle, true, true] call BIN_fnc_empVehicle;</sqf>
____________________________________________________________________________________________


| <!-- [] call [[BIN_fnc_empVehicle]]; --> |Syntax=
|seealso= [[setDamage]] [[setHitPointDamage]]
 
|p1= |Parameter 1=
 
| |Return value=
____________________________________________________________________________________________
 
|x1= <code></code> |Example 1=
____________________________________________________________________________________________
 
| |See also=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Campaign|{{uc:empVehicle}}]]
[[Category:Functions|{{uc:empVehicle}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:empVehicle}}]]

Latest revision as of 23:17, 20 November 2023

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

Description

Description:
Sets EMP parameters to a vehicle. Destroys lights and optionally prevents vehicle from starting
ⓘ
The player has to be defined as BIN_player for the voice lines to be spoken.
enoch icon ca.png
This content is exclusive to the Arma 3 Contact Expansion.
Execution:
call
Groups:
Contact

Syntax

Syntax:
[obj, destroyEngine, aiExit] call BIN_fnc_empVehicle
Parameters:
obj: Object - the vehicle
destroyEngine: Boolean - (Optional, default true) true to destroys the engine, false to have it working
aiExit: Boolean - (Optional, default true) AI behaviour in vehicle; true to make them exit the vehicle, false to remain in it
Return Value:
Return value needed

Examples

Example 1:
[_enemyVehicle, true, true] call BIN_fnc_empVehicle;

Additional Information

See also:
setDamage setHitPointDamage

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=BIN_fnc_empVehicle&oldid=350046"