BIS fnc moduleFuel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(4 intermediate revisions by the same user not shown)
Line 9: Line 9:


|descr= 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.}}


|s1=[logic, units, isActivated] call [[BIS_fnc_moduleFuel]]
|s1= [logic, units, isActivated] call [[BIS_fnc_moduleFuel]]


|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
* "value": [[Number]] - (Optional, default 0) wanted fuel level, in range 0..1
* "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
|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set
Line 22: Line 22:
|r1= [[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>


|seealso= [[fuel]] [[setFuel]]
|seealso= [[fuel]] [[setFuel]]
}}
}}

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

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

Syntax:
[logic, units, isActivated] call BIS_fnc_moduleFuel
Parameters:
logic: Object - the logic. Possible setVariable parameter:
  • "value": Number - (Optional, default 0) wanted fuel level, in range 0..1
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

Examples

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

Additional Information

See also:
fuel setFuel

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