BIS fnc moduleFuel: Difference between revisions

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description:: Set fuel of linked units' vehicles.
ⓘ
Regarding locality: unit's vehicle must be local to the machine, the unit itself can be remote.
Execution:: call
Groups:: Modules

Syntax:

[logic, units, isActivated] call BIS_fnc_moduleFuel

Parameters:

logic: Object - the logic. Possible setVariable parameter:

units: Array of Objects - list of units

isActivated: Boolean - (Optional, default true) if true, the fuel is set

Return Value:

Boolean - true when done, even if isActivated equals false

Example 1:: [myLogic, [unit1, unit2, vehicle1], true] call BIS_fnc_moduleFuel;

: 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

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
+|gr1= Modules
-|gr1= Modules
+|arg= local|eff= global
-|arg= local|eff= global| Set fuel of linked units' '''vehicles'''.
+|descr= Set fuel of linked units' '''vehicles'''.
-{{Feature|Informative|Regarding locality: unit's '''vehicle''' must be local to the machine, the unit itself can be remote.}}
+{{Feature|informative|Regarding locality: unit's '''vehicle''' must be local to the machine, the unit itself can be remote.}}
-| [logic, units, isActivated] call [[BIS_fnc_moduleFuel]]
+|s1= [logic, units, isActivated] call [[BIS_fnc_moduleFuel]]
 |p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
 * "value": [[Number]] - (Optional, default 0) wanted fuel level, in range 0..1
-|p2= units: [[Array]] of [[Object|Objects]] - list of units
+|p2= units: [[Array]] of [[Object]]s - list of units
 |p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set
-| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]
+|r1= [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]
-|x1= <code>[myLogic, [unit1, unit2, vehicle1], [[true]]] [[call]] [[BIS_fnc_moduleFuel]];</code>
+|x1= <sqf>[myLogic, [unit1, unit2, vehicle1], true] call BIS_fnc_moduleFuel;</sqf>
-| [[fuel]], [[setFuel]]
+|seealso= [[fuel]] [[setFuel]]
 }}