BIS fnc moduleFuel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 11: Line 10:


|eff= global |Effects in MP=
|eff= global |Effects in MP=
____________________________________________________________________________________________


| Set fuel of linked units' '''vehicles'''.
| Set fuel of linked units' '''vehicles'''.
{{Informative|Regarding locality: unit's '''vehicle''' must be local to the machine, the unit itself can be remote.}} |Description=
{{Informative|Regarding locality: unit's '''vehicle''' must be local to the machine, the unit itself can be remote.}} |Description=
____________________________________________________________________________________________


| [logic, units, isActivated] call [[BIS_fnc_moduleFuel]] |Syntax=
| [logic, units, isActivated] call [[BIS_fnc_moduleFuel]] |Syntax=
Line 27: Line 24:


| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
____________________________________________________________________________________________


|x1= <code>[myLogic, [unit1, unit2, vehicle1], [[true]]] [[call]] [[BIS_fnc_moduleFuel]];</code> |Example 1=
|x1= <code>[myLogic, [unit1, unit2, vehicle1], [[true]]] [[call]] [[BIS_fnc_moduleFuel]];</code> |Example 1=
____________________________________________________________________________________________


| [[fuel]], [[setFuel]] |See also=
| [[fuel]], [[setFuel]] |See also=

Revision as of 00:29, 17 January 2021

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:
fuelsetFuel

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

Notes

Bottom Section